使用工具提升代码质量

曾经终败给现在 2022-03-25 13:46 375阅读 0赞

![1240][]

在这片文章中，我将从工具使用的角度上讲述如何提高 Android 代码质量，这些自动化工具包括 Checksytle、Findbugs、PMD 和 Android Lint. 团队中代码意识不一致，水平参差不齐，代码风格迥异，定下的规范也是熟视无睹。这时候就需要借助工具的力量，利用工具自动地帮助我们检测代码，避免代码恶习，预防蚁穴坏堤。

# 0.1 Fork 这个例子工程 #

我强烈建议你[fork这个例子工程][fork]，所有的使用事列都会在这个demo中呈现，同时你可以测试你自己写的规则。

# 0.2 关于 Gradle 的 Task #

理解 Gradle 的 Task 是理解这篇文章的基础，我强烈建议你多看看关于Gradle Task的文章（例如[这篇][Link 1]还有[这篇][Link 2]），当然，本文也是满满的例子，所以你很容易理解，这也是我建议你 fork 我的代码仓库的原因，把工程导入你的 Android studio，然后你将看到熟悉的 Gradle Task 脚本。如果你还是不太理解，也不用担心，我将最大努力的写好注释。

# 0.3 关于 这个 demo 的层级结构 #

Gradle 脚本可以分散在不同的文件中，我在工程中写了三个 gradle 文件：

*  [根目录下的 gradle 文件][gradle]，用来配置工程相关的信息，例如仓库依赖，编译工具版本之类的。
 *  [app 目录下的 gradle 文件][app _ gradle]，用来校验 Java 类。
 *  [config 目录下的 gradle 文件][config _ gradle]，用来配置了以上提到的几个工具。

# 1 Checkstyle #

![1240 1][]

Check style 是一个帮助开发者维持编码规范标准的一个工具，它能自动地检测 Java 代码，以减少人工检测代码的成本。当你启用 Checkstyle，它能解析你的代码并能告诉你代码中的错误或者不符合定义的规范的地方。

# 1.1 Android Studio 插件 #

Checkstyle 提供了多种IDE的插件支持，Android Studio 也不例外。  
进入Android Studio设置页面，在插件栏输入Checkstyle：

![1240 2][]

Checkstyle插件

如果你还没安装 Checkstyle 的插件，进入下载页下载，然后重启 Android Studio。启动 Android studio 后进入 Checkstyle 的设置页面：

![1240 3][]

Checkstyle设置

在这里我们可以设置 Checkstyle 插件扫描范围，配置文件等信息，默认使用的配置文件是官方提供的文件：sun\_checks.xml，我们也可以根据自己项目的需要定义自己的配置文件，配置规则可以参考[官方文档][Link 3]。  
设置完成之后点击 “Apply” 或者 “ok” 按钮，回到代码中，我们便可以看到 Checkstyle 给我们的提示：

![1240 4][]

Checksylte高亮提示

# 1.2 Gradle 方式使用Checkstyle #

如果我们需要把 Checkstyle 继承到自动编译服务器中，例如：jenkins，我们需要利用 Gradle Task来执行 Checkstyle,下面这段脚本展示了在 Gradle task 的 Checkstyle 的基本配置：

1.  `task checkstyle(type: Checkstyle) {`
2.  `configFile file("${project.rootDir}/config/quality/checkstyle/checkstyle.xml") // Where my checkstyle config is...`
3.  `configProperties.checkstyleSuppressionsPath = file("${project.rootDir}/config/quality/checkstyle/suppressions.xml").absolutePath // Where is my suppressions file for checkstyle is...`
4.  `source 'src'`
5.  `include '**/*.java'`
6.  `exclude '**/gen/**'`
7.  `classpath = files()`
8.  `}`

这个 task 将会根据你指定的 checkstyle.xml 和 suppressions.xml 文件来分析你的代码。你可以在 Android Studio 中执行这个任务：

![1240 5][]

执行完成之后，checkstyle 工具将会把每一个不合法的问题显示在控制台中。

# 2 FindBugs #

![1240 6][]

FindBugs 这个名字本身已经揭示了它的作用，“FindBugs uses static analysis to inspect Java bytecode for occurrences of bug patterns.” FindBugs 是一个工具，它能通过静态分析方式扫描 Java 字节码，发现其中的可能出现 bug 的代码，它能发现一些常规的低级的错误，例如一些错误的逻辑操作，也能发现一些比较隐晦的错误。  
例如：

1.  `Person person = (Person) map.get("bob");`
2.  `if (person != null) {`
3.  `person.updateAccessTime();`
4.  `}`
5.  `String name = person.getName();`

最后一行代码，可能会出现空指针错误。  
又如：

1.  `b.replace('b', 'p');`
2.  `if(b.equals("pop")) {`
3.  `Log.d("","");`
4.  `}`

b.replace('b', ‘p’);这段代码对b不会产生影响，所以是无效的。

# 2.1 Android Studio 插件 #

同样，FIndbugs 也提供了 Android Studio 的插件支持，插件的获取过程和 Checkstyle 一样，在安装后之后重启 Android studio。值得注意的是 Findbugs 分析的是 Java 字节码，所以在启用 Findbugs 之前要保证你的工程是编译过的，在 FIndbugs 扫描之后，如果发现问题，会在对应的代码出给出提示：

![1240 7][]

findbugs提示

# 2.2 Gradle 脚本使用 #

在Gradle使用非常简单，下面的脚本展示了如何 FindBugs:

1.  `task findbugs(type: FindBugs) {`
2.  `ignoreFailures = false`
3.  `effort = "max"`
4.  `reportLevel = "high"`
5.  `excludeFilter = new File("${project.rootDir}/config/quality/findbugs/findbugs-filter.xml")`
6.  `classes = files("${project.rootDir}/app/build/classes")`
7.  `source 'src'`
8.  `include '**/*.java'`
9.  `exclude '**/gen/**'`
10.  
11. `reports {`
12. `xml.enabled = false`
13. `html.enabled = true`
14. `xml {`
15. `destination "$project.buildDir/reports/findbugs/findbugs.xml"`
16. `}`
17. `html {`
18. `destination "$project.buildDir/reports/findbugs/findbugs.html"`
19. `}`
20. `}`
21.  
22. `classpath = files()`
23. `}`

脚本任务和 Checkstyle 类似，FindBugs 可以根据我们指定的范围进行扫描，这个范围我们可以通过一个过滤规则文件来制定扫描结果报告支持 HTML 和 XML 两种格式。excludeFilter 指定了过滤器配置文件，reports 指定了检测报告的文件格式和文件地址。执行 Findbugs 的 task 非常简单，和 Checkstyle 一样。

# 2.3 Findbugs 使用技巧 #

我强烈建议为 Findbugs 配置一个过滤文件，因为 Android 工程和 Java 工程稍微有些不一样，Android 工程自动生成的 R 文件并不符合 Findbugs 的规范，需要过滤掉。另外要注意的是：Findbugs 分析的是字节码，你需要先编译，再进行 Findbugs 的分析。

# 3 PMD #

![1240 8][]

这个工具比较有趣：其实 PMD 真正的名字并不是 PMD 。 在其官方网站上你会发现两个非常有趣的名字：

*  Pretty Much Done
 *  Project Meets Deadline

事实上 PMD 是一个非常强大的工具，它的作用类似 Findbugs，但是它的检测扫描是基于源码的，而且 PMD 不仅仅能检测 Java 语言，还能检测其他语言。PMD 的目标和 Findbugsd 非常的相似，都是通过定义的规则静态分析代码中可能出现的错误，为什么要同时使用 PMD 和 Findbugs呢？由于 Findbugs 和 PMD 的扫描方式不一样，PMD 能发现的一些 Findbugs 发现不了的问题，反之亦然。

# 3.1 Android 插件中使用 #

插件的下载过程不再赘述，安装完成重启之后，到顶部菜单 Tools 栏目可以找到 QAplug 选项，可以执行代码分析：

![1240 9][]

PMD代码分析

执行完成，会在控制台输出结果：

![1240 10][]

PMD执行结果

# 3.2 在 Gradle 脚本中使用 #

下面的脚本代码展示了如何使用PMD：

1.  `task pmd(type: Pmd) {`
2.  `ruleSetFiles = files("${project.rootDir}/config/quality/pmd/pmd-ruleset.xml")`
3.  `ignoreFailures = false`
4.  `ruleSets = []`
5.   
6.  `source 'src'`
7.  `include '**/*.java'`
8.  `exclude '**/gen/**'`
9.   
10. `reports {`
11. `xml.enabled = false`
12. `html.enabled = true`
13. `xml {`
14. `destination "$project.buildDir/reports/pmd/pmd.xml"`
15. `}`
16. `html {`
17. `destination "$project.buildDir/reports/pmd/pmd.html"`
18. `}`
19. `}`
20. `}`

配置都和 Findbus 如出一辙，PMD 同样也可以输出 HTML 和 XML 报告，例子中选中的是 HTML 格式。我强烈建议你定义自己的 rulesets 文件（规则集合），关于 rulesets的配置，可以参考[官方文档][Link 4]，PMD存在争议的规则比 Findbugs 要多，例如对于嵌套的 “if statement” 它总是提醒你 “These nested if statements could be combined”，或者对空的 “if statement ” 总是提醒你 “Avoid empty if statements”，不过，我觉得是否需要把嵌套 “if statement” 合并到一个 “if statement” 取决于你或者你的团队自己来定义，我不太建议合并 “if statement ” 这样会降低代码可读性。执行 PMD 的 task 非常简单，和 Checkstyle 一样。

# 4 Android Lint #

“The Android lint tool is a static code analysis tool that checks your Android project source files for potential bugs and optimization improvements for correctness, security, performance, usability, accessibility, and internationalization.” 正如官网所说，Android Lint 是另一个静态代码分析工具,专门针对 Android 工程。Android Lint 除了对代码扫描，分析潜在问题之外，还能对Android的资源进行检测，无用的资源，错位的dip资源等。

# 4.1 Gradle 脚本使用 #

1.  `android {`
2.  `lintOptions {`
3.  `abortOnError true`
4.  `lintConfig file("${project.rootDir}/config/quality/lint/lint.xml")`
5.  `// if true, generate an HTML report (with issue explanations, sourcecode, etc)`
6.  `htmlReport true`
7.  `// optional path to report (default will be lint-results.html in the builddir)`
8.  `htmlOutput file("$project.buildDir/reports/lint/lint.html")`
9.  `}`

我建议你单独指定一个配置文件来决定是否过滤一些规则，规则的定义可以参考最新ADT给出的规则，参考[这里][Link 5]。使用 “severity” 配置为 “ignore” 来过滤指定的规则。 执行 Lint 和执行 Checkstyle 的 task 一样。执行完成之后到结果输出目录中查看报告，例如下面是我（译者）执行自己的工程输出的部分截图：

![1240 11][]

# 5 在一个任务统一使用以上工具 #

以上介绍完了四个工具，现在我们来看看如何一次同时运行四个工具？我们可以管理 gradle task 之间的依赖关系，使得我们在执行一个 task 任务的同时其他 task 也能被执行。使用 Gradle 提供的方法，我们可以把四个工具的执行任务添加为 “check” task 的依赖：

check.dependsOn 'checkstyle', 'findbugs', 'pmd', 'lint'

现在，只要我们只想 “check” 这个 task ，Checkstyle、Windbags、PMD 和 Android Lint 都会自动执行。在 commit／push／merge request 之前 执行一下 check 任务，对我们代码质量的提高将是一种非常棒的方式。执行这个任务比较简单，你可以在命令行中执行：

gradlew check

# 6 总结 #

正如上文所说，在 Gradle 中使用这些工具是非常简单的。这些工具不仅能在本地使用，还能部署到我们的自动化编译服务器上，比如 Jenkins／Hudson，自动处理扫描我们的代码并输出报告。

[1240]: /images/20220325/5718a2a9bb3b412294e3998a8988ee17.png
[fork]: https://github.com/vincentbrison/vb-android-app-quality
[Link 1]: http://www.gradle.org/docs/current/userguide/tutorial_using_tasks.html
[Link 2]: http://www.gradle.org/docs/current/userguide/more_about_tasks.html
[gradle]: https://github.com/vincentbrison/vb-android-app-quality/blob/master/build.gradle
[app _ gradle]: https://github.com/vincentbrison/vb-android-app-quality/blob/master/app/build.gradle
[config _ gradle]: https://github.com/vincentbrison/vb-android-app-quality/blob/master/config/quality.gradle
[1240 1]: /images/20220325/43124c4f7a804954b6e794707a40716a.png
[1240 2]: /images/20220325/24b70a466e1341c4ab94b38003f077d4.png
[1240 3]: /images/20220325/8a24bbc3cc084368b072b025f57f94d7.png
[Link 3]: https://docs.gradle.org/current/dsl/org.gradle.api.plugins.quality.Checkstyle.html
[1240 4]: /images/20220325/dfdc996db964445b8843a5b6fd06456a.png
[1240 5]: /images/20220325/1e078d2094864f0ea69b4ceca8465f8f.png
[1240 6]: /images/20220325/4f208f0641cf4194b88522c794168d1d.png
[1240 7]: /images/20220325/98d277a22edf4d50b3e3b277efc3070d.png
[1240 8]: /images/20220325/6dcf7f1ca0ae447aa8b8b00fd9a5b6fc.png
[1240 9]: /images/20220325/df422fdb7b6e41f7ab830c967d526e8b.png
[1240 10]: /images/20220325/5d8c9b516ee647f19691a62b3a4e24e7.png
[Link 4]: http://pmd.sourceforge.net/pmd-%205.1.1/howtomakearuleset.html
[Link 5]: http://tools.android.com/tips/lint-checks
[1240 11]: /images/20220325/e3e3165a14364e1ea21fe9bda00dc496.png