Android Quality Essentials
1.0.0
Улучшение качества кода Android со статическим анализом кода и проверкой времени выполнения:
Рекомендуется добавлять эти проверки при создании нового проекта и исправляете проблемы с каждой регистрацией (как часть вашего процесса непрерывной интеграции). В противном случае, когда вы столкнетесь и исправляете огромное количество ошибок, потребуется огромная смелость и терпение.
build.gradle : apply from: '../quality/static_analysis.gradle'
git remote add analysis https://github.com/BrianSpace/Android-Quality-Essentials.gitbuild.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 : 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 (и не забудьте добавить к манифесту): 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 консоль, чтобы начать статический анализ.build/reports/ каталоге проекта, в котором вы применяете static_analysis.gradle . Конвенция о именовании, определенное в правилах стиля, не разрешает префикс для одного букв для имен поля участников, таких как «Mmember». Но если вам нравится этот стиль, вы можете изменить свойство format модуля MemberName на «^[az] [a-za-z0-9] $». Или изменить на «^m [az] [a-za-z0-9] $», чтобы заставить префикс «m».
Для правил PMD используется Class Class, он будет подсказывать созданию утилит, если в вашем классе есть только статические поля и методы. Вам просто нужно:
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 ;
}
}Все правила статического анализа являются лучшими практиками из прошлого опыта людей, но они не всегда являются истиной, которая не может быть нарушена. Некоторые из правил PMD должны основываться на ваших собственных предпочтениях:
ItemTypeT , для лучшей читаемости. Вы можете удалить его из списка "Exclide", если вам нравится одноразовое именование. Конвенции именования определены в файле качества/контроля/naming_convention.xml. Определены следующие правила:
Вы можете изменить регулярные выражения, как вам нужно для своего собственного проекта. Запустите gradlew checkFileNames если вы хотите проверить только соглашение о именованиях.
Checkstyle используется для проверки стиля кода Java. Правила стиля основаны на руководстве по стилю Google Java со следующими изменениями:
Запустите gradlew checkCodeStyle если вы хотите проверить только стиль кода. Если вы хотите исключить некоторые файлы, такие как 3 -й код, вы можете добавить элемент exclude в задачу checkCodeStyle в файле static_analysis.gradle.
FindBugs сканируйте свой код на предмет шаблонов, которые могут привести к ошибкам. Файлы, которые должны быть исключены из анализа, определены здесь. Запустите gradlew findBugs если вы хотите запустить только находки.
PMD является анализатором статического кода, который может обнаружить общие недостатки программирования. Правила определены в качестве качества/PMD/PMD-ruleset.xml. Полный список правил можно найти здесь. Запустите gradlew pmdCheck если вы хотите запустить только PMD.
Android Lint - это инструмент анализа статического кода, специфичный для Android. Полный список чеков здесь. Запустите gradlew lint если вы хотите запустить только правила Lint.
StrictMode очень полезен для обнаружения медленных операций в потоке пользовательского интерфейса и утечек ресурсов. В частности, Threadpolicy обнаружит диск/сеть ввода -вывода и медленные операции в UI Thead, тогда как VMPolicy обнаружит утечки ресурсов. Для получения подробной информации см. Документы для Threadpolicy.builder и Vmpolicy.Builder
Leakcanare может помочь обнаружить утечки памяти. У него есть очень хороший пользовательский интерфейс, чтобы сообщить о утечках и показать всю справочную цепочку, чтобы вы могли легко найти, где исправить утечки.
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.
