Android Quality Essentials
1.0.0
Mejorar la calidad del código de Android con el análisis de código estático y la verificación de tiempo de ejecución:
Se recomienda que agregue estas verificaciones cuando cree un nuevo proyecto y solucione los problemas con cada check-in (como parte de su proceso de integración continua). De lo contrario, necesitaría un enorme coraje y paciencia cuando enfrenta y arregle la gran cantidad de errores.
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 (y no olviden agregar al manifiesto): 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 en la consola para comenzar el análisis estático.build/reports/ del proyecto en el que aplica static_analysis.gradle . La convención de nombres definida en las reglas de estilo no permite el prefijo de una sola letra para los nombres de campo de los miembros como "mmember". Pero si le gusta este estilo, puede cambiar la propiedad format del módulo MemberName a "^[AZ] [A-ZA-Z0-9] $". O cambiar a "^M [AZ] [A-ZA-Z0-9] $" para forzar el prefijo "M".
Para la regla PMD UseutilityClass, solicitará crear una clase de utilidad si su clase solo tiene campos y métodos estáticos. Solo necesitas:
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 ;
}
}Todas las reglas de análisis estático son las mejores prácticas de la experiencia pasada de las personas, pero no siempre son la verdad que no se puede romper. Algunas de las reglas de PMD deben basarse en sus propias preferencias:
ItemTypeT , para una mejor legibilidad. Puede eliminarlo de la lista "Excluir" si desea el nombre de la letra única. Las convenciones de nombres se definen en el archivo de calidad/checkstyle/naming_convention.xml. Se definen las siguientes reglas:
Puede modificar las expresiones regulares como necesita para su propio proyecto. Ejecute gradlew checkFileNames si desea verificar solo la convención de nomenclatura.
CheckStyle se usa para verificar el estilo del código Java. Las reglas de estilo se basan en la guía de estilo Google Java con los siguientes cambios:
Ejecute gradlew checkCodeStyle si desea verificar solo el estilo del código. Si desea excluir algunos archivos como el código de terceros, puede agregar un elemento exclude en la tarea de checkCodeStyle en el archivo static_analysis.gradle.
FindBugs Escanee su código en busca de patrones que puedan dar lugar a errores. Los archivos que se excluirán del análisis se definen aquí. Ejecute gradlew findBugs si desea ejecutar FindBugs solamente.
PMD es un analizador de código estático que puede detectar fallas de programación comunes. Las reglas se definen en calidad/PMD/PMD-Regleset.xml. La lista completa de las reglas se puede encontrar aquí. Ejecute gradlew pmdCheck si desea ejecutar solo PMD.
Android Lint es una herramienta de análisis de código estático específico de Android. La lista completa de cheques está aquí. Ejecute gradlew lint si desea ejecutar reglas de pelusa solamente.
StrictMode es muy útil para detectar operaciones lentas en la interfaz de usuario y fugas de recursos. Específicamente, ThreadPolicy detectará E/S de disco/red y operaciones lentas en UI thead, mientras que VMPolicy detectará fugas de recursos. Para más detalles, consulte los documentos para ThreadPolicy.Builder y VMPolicy.Builder
LeakCanary puede ayudar a detectar fugas de memoria. Tiene una interfaz de usuario muy agradable para informar las fugas y mostrar toda la cadena de referencia para que pueda localizar fácilmente dónde arreglar las fugas.
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.
