Android Quality Essentials
1.0.0
Tingkatkan Kualitas Kode Android dengan Analisis Kode Statis dan Pemeriksaan Runtime:
Dianjurkan agar Anda menambahkan cek ini saat Anda membuat proyek baru dan memperbaiki masalah dengan setiap check-in (sebagai bagian dari proses integrasi berkelanjutan Anda). Kalau tidak, itu akan membutuhkan keberanian dan kesabaran yang sangat besar ketika Anda menghadapi dan memperbaiki sejumlah besar kesalahan.
build.gradle Anda: apply from: '../quality/static_analysis.gradle'
git remote add analysis https://github.com/BrianSpace/Android-Quality-Essentials.gitbuild.gradle Anda. GRADLE: apply from: '../analysis/quality/static_analysis.gradle'
android {
...
lintOptions {
// Turn off analysis progress reporting by lint
quiet true
// Stop the gradle build if errors are found
abortOnError true
// Do not ignore lint warnings
ignoreWarnings false
// Treat warnings as errors
warningsAsErrors true
// Ignore rules list
ignore 'GoogleAppIndexingWarning' // Remove this if the app support App Indexing
}
...
}
build.gradle Anda. dependencies {
.. .
debugCompile ' com.squareup.leakcanary:leakcanary-android:1.5.1 '
releaseCompile ' com.squareup.leakcanary:leakcanary-android-no-op:1.5.1 '
testCompile ' com.squareup.leakcanary:leakcanary-android-no-op:1.5.1 '
.. .
}Application Anda (dan tidak lupa untuk menambah manifes): public class AndroidQualityEssentialsApplication extends Application {
@ Override
public void onCreate () {
super . onCreate ();
if ( BuildConfig . DEBUG ) {
StrictMode . setThreadPolicy ( new StrictMode . ThreadPolicy . Builder ()
. detectAll ()
. penaltyDeath ()
. build ());
StrictMode . setVmPolicy ( new StrictMode . VmPolicy . Builder ()
. detectAll ()
. penaltyDeath () // If violations are in Android itself or 3rd-party libs, use penaltyLog.
. build ());
// Avoid the process dedicated to LeakCanary for heap analysis.
if (! LeakCanary . isInAnalyzerProcess ( this )) {
LeakCanary . install ( this );
}
}
...
}
}gradlew check in konsol untuk memulai analisis statis.build/reports/ Direktori proyek di mana Anda menerapkan static_analysis.gradle . Konvensi penamaan yang didefinisikan dalam aturan gaya tidak mengizinkan awalan huruf tunggal untuk nama bidang anggota seperti "mmember". Tetapi jika Anda menyukai gaya ini, Anda dapat mengubah properti format dari modul MemberName menjadi "^[az] [a-za-z0-9] $". Atau berubah menjadi "^m [az] [a-za-z0-9] $" untuk memaksa awalan "m".
Untuk aturan PMD UseutilityClass, ini akan meminta untuk membuat kelas utilitas jika kelas Anda hanya memiliki bidang dan metode statis. Anda hanya perlu:
public final class FileUtil {
private static Context appContext ;
private FileUtil () throws InstantiationException {
throw new InstantiationException ( "Utility class FileUtil should not be instantiated!" );
}
public static void init ( final Context context ) {
appContext = context . getApplicationContext ();
}
/**
* Get available cache directory. Prefer external over internal.
*/
@ NonNull
public static File getAvailableCacheDir () {
final File externalCacheDir = appContext . getExternalCacheDir ();
return externalCacheDir == null ? appContext . getCacheDir () : externalCacheDir ;
}
}Semua aturan analisis statis adalah praktik terbaik dari pengalaman masa lalu orang, tetapi mereka tidak selalu kebenaran yang tidak dapat dilanggar. Beberapa aturan PMD harus didasarkan pada preferensi Anda sendiri:
ItemTypeT , untuk keterbacaan yang lebih baik. Anda dapat menghapusnya dari daftar "Kecualikan" jika Anda suka penamaan huruf tunggal. Konvensi penamaan didefinisikan dalam file kualitas/checkstyle/naming_convention.xml. Aturan berikut didefinisikan:
Anda dapat memodifikasi ekspresi reguler yang Anda butuhkan untuk proyek Anda sendiri. Jalankan gradlew checkFileNames jika Anda ingin memeriksa hanya konvensi penamaan.
CheckStyle digunakan untuk memeriksa gaya kode Java. Aturan gaya didasarkan pada panduan gaya Google Java dengan perubahan berikut:
Jalankan gradlew checkCodeStyle jika Anda ingin memeriksa hanya gaya kode. Jika Anda ingin mengecualikan beberapa file seperti kode pihak ke -3, Anda dapat menambahkan item exclude dalam tugas checkCodeStyle di file static_analysis.gradle.
FindBugs memindai kode Anda untuk pola yang dapat menghasilkan bug. File yang akan dikecualikan dari analisis didefinisikan di sini. Jalankan gradlew findBugs jika Anda ingin menjalankan findbugs saja.
PMD adalah penganalisa kode statis yang dapat mendeteksi kelemahan pemrograman umum. Aturan didefinisikan dalam kualitas/PMD/PMD-ruleset.xml. Daftar lengkap aturan dapat ditemukan di sini. Jalankan gradlew pmdCheck jika Anda ingin menjalankan PMD saja.
Android Lint adalah alat analisis kode statis spesifik Android. Daftar lengkap cek ada di sini. Jalankan gradlew lint jika Anda ingin menjalankan aturan serat saja.
StrictMode sangat berguna untuk mendeteksi operasi yang lambat dalam utas UI dan kebocoran sumber daya. Secara khusus, ThreadPolicy akan mendeteksi Disk/Jaringan I/O dan operasi lambat di UI Thead, sedangkan VMPolicy akan mendeteksi kebocoran sumber daya. Untuk detailnya, lihat dokumen untuk threadpolicy.builder dan vmpolicy.builder
LeakCanary dapat membantu mendeteksi kebocoran memori. Ini memiliki UI yang sangat bagus untuk melaporkan kebocoran dan menunjukkan seluruh rantai referensi sehingga Anda dapat dengan mudah menemukan tempat untuk memperbaiki kebocoran.
The MIT License
Copyright (c) 2017-2017 AndroidQualityEssentials project contributors
https://github.com/BrianSpace/AndroidQualityEssentials/graphs/contributors
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
