Android Quality Essentials

AndroidQualitySentials [中文]

通过静态代码分析和运行时检查改善Android代码质量：

• 使用CheckStyle命名约定（尤其是用于资源文件）。
• 代码样式，带有CheckStyle。
• 潜在的错误，带有Findbugs，PMD和Android棉绒。
• 潜在的ANR（主线程中的缓慢操作），带有严格模式。
• 资源和内存泄漏，具有严格模式和泄漏。

建议您在创建一个新项目并在每个签到中解决问题（作为连续集成过程的一部分）时添加这些检查。否则，当您面对并解决大量错误时，它将需要巨大的勇气和耐心。

目录

• 开始
• 解决问题的提示
  • 允许成员字段以“ M”字母开头
  • 自动添加“最终”变量
  • 创建实用程序类
• PMD规则的权衡
• 将检查什么？
  • 命名约定
  • 使用CheckStyle的代码样式
  • 与Findbugs的静态分析
  • 使用PMD的静态分析
  • 使用Android棉力分析
  • 使用Strictmode检查运行时检查
  • 记忆泄漏检测与泄漏
• 谢谢
• 执照

开始

1. 将质量目录添加到您的项目中。
   • 您可以复制它：
     • 同步该项目的代码，并将质量目录复制到项目的根目录。
     • 在您的build.gradle中添加以下行：

      apply from: '../quality/static_analysis.gradle'
     

   • 或添加为远程模块。就像我的项目Android-App-Architecture-mvvm-databinding一样：
     • 添加为远程模块：

     git remote add analysis https://github.com/BrianSpace/Android-Quality-Essentials.git

     • 然后在您的build.gradle中：

      apply from: '../analysis/quality/static_analysis.gradle'
     

2. 添加棉布选项

 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
    }
    ...
}

4. 在您的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 '
   .. .
 }

5. 在您的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 );
            }
        }
        ...
    }
}

6. 在控制台中运行gradlew check以启动静态分析。

• 分析报告将位于您应用static_analysis.gradle的项目的build/reports/目录中。

7. 运行您的调试版本应用程序以进行运行时检查。
8. 将检查步骤添加到您的连续集成过程中。

解决问题的提示

允许成员字段以“ M”字母开头

样式规则中定义的命名约定不允许单个字母前缀“ mmember”之类的成员字段名称。但是，如果您喜欢这种样式，则可以将MemberName模块的format属性更改为“^[az] [A-ZA-Z0-9] $”。或更改为“^m [az] [a-za-Z0-9] $”，以强制“ M”前缀。

自动添加“最终”变量

1. 在Android Studio中，选择“分析” - >“按名称...”菜单，搜索“最终”，然后在“ Java” - >“代码样式问题”下运行以下两个规则：
   • 场可能是“最终”
   • 本地变量或参数可能是最终的
2. 每次运行后，在结果面板中，单击“最终”按钮以自动添加“最终”。

创建实用程序类

对于PMD规则使用式频道，如果您的类只有静态字段和方法，它将提示创建实用程序类。您只需要：

• 将您的公用事业类定义为最终。
• 创建一个私人构造函数并在其中抛出例外，以防止实例化。样本：

 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规则的权衡

所有的静态分析规则都是人们过去经验的最佳实践，但它们并不总是无法破坏的真理。一些PMD规则需要基于您自己的偏好：

1. 辅助类拟南芥此规则更喜欢性能和还原方法计数而不是封装，通常我会更关心封装，因此我排除了此规则。但是，如果您更多地关心性能和方法计数（以避免使用多戴克斯），则可以包含它。
2. 仿制药此规则更喜欢单一的上案字母，以获得通用值。但是，我更喜欢一些更有意义的名称，“ t”字母作为后缀，例如ItemTypeT ，以提高可读性。如果您喜欢单个字母命名，则可以从“排除”列表中删除它。

将检查什么？

命名约定

命名约定在质量/checkStyle/naming_convention.xml文件中定义。定义了以下规则：

1. Java文件：
   • 应该使用骆驼盒。
   • 测试文件应命名为“ test.java”或“ base .java”。
2. 资源文件：
   • 资源文件应使用Snake Case（较低的情况，由下划线串联）。
   • 可绘制的物品应以“ bg_”，“ ic_”或“ img_”开头。
   • 布局应以“ activy_”，“ fragment_”，“ view_”，“ dialog_”，“ item_”或“ btn_”开头。
   • 值应以“ attrs_”，“ colors_”，“ dimens_”，“ strings_”或“ styles_”开头。

您可以根据自己的项目需要修改正则表达式。如果您只想检查命名约定，请运行gradlew checkFileNames 。

使用CheckStyle的代码样式

CheckStyle用于检查Java代码样式。样式规则基于Google Java样式指南，并具有以下更改：

• 严重性：更改为“错误”。
• 线长度：更改为120。
• 凹痕：标签大小更改为4。
• 方法名：不允许下划线。
• ConstantName：所有上情况，允许下划线。

如果您只想检查代码样式，请运行gradlew checkCodeStyle 。如果您想排除第三方代码之类的某些文件，则可以在static_analysis.gradle文件中的checkCodeStyle任务中添加一个exclude项目。

与Findbugs的静态分析

FindBugs扫描您的代码是否可能导致错误。此处定义要排除分析的文件。如果您只想运行findbugs，请运行gradlew findBugs 。

使用PMD的静态分析

PMD是一个静态代码分析仪，可以检测常见的编程缺陷。规则以质量/PMD/PMD-Ruleset.xml定义。规则的完整列表可以在此处找到。如果您只想运行PMD，请运行gradlew pmdCheck 。

使用Android棉力分析

Android lint是一种特定于Android的静态代码分析工具。完整的检查列表在这里。如果您只想运行棉绒规则，请运行gradlew lint 。

使用Strictmode检查运行时检查

严格模式对于检测UI线程和资源泄漏中的缓慢操作非常有用。具体而言，ThreadPolicy将检测磁盘/网络I/O并在UI Thead中进行缓慢操作，而VMPolicy将检测资源泄漏。有关详细信息，请参阅文档以获取threadpolicy.builder and vmpolicy.builder。

记忆泄漏检测与泄漏

泄漏可以帮助检测内存泄漏。它具有非常好的UI来报告泄漏并显示整个参考链，以便您可以轻松地找到用于修复泄漏的位置。

谢谢

• FindBugs和PMD的静态分析配置基于https://github.com/ribot/android-boilerplate。

执照

 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.