提高Android代码质量的四个工具.docx

如何提高自己的工作经验，不过是一点点的积累，将这些分享给大家，如何将通过不同的自动化工具如 CheckStyle，FindBugs，PMD 以及 Android Lint 来介绍(如何)提高你的安卓代码质量。通过自动化的方式检查你的代码非常有用，尤其当你在一个团队中工作，为了在你的代码中保持严格的语法格式以 及避免很多坏习惯和错误。 Fork 该示例 我强烈建议你拷贝下这个项目工程，尽管我将介绍的案例都是来自它。与此同时，你将能够测试下自己对这些工具的了解情况。 关于 Gradle 任务 Gradle 任务的概念(在 Gradle 中的含义)是理解该篇文章(以及如何以一种通用的方式写Gradle 脚本)的基础。我强烈建议你去看下这两篇关于Gradle 任务的文档。这个文档包含了大量的例子，因此它非常容易开始学习。现在，我假定你拷贝了我的 Repo，你导入这个工程到你的 Android Studio，并且你熟悉 Gradle 任务。如果不是，别担心，我将尽我最大的努力让我的讲解更有意义。 关于示例项目的层次结构 你可以将 gradle 脚本文件分割成很多文件，我现在已经有3 个 gradle 文件： 根文件夹中的文件，这些文件或多或少都是关于这个项目的配置的 (用的哪个 Maven Repos，用的哪个版本的 Gradle)。 App 子文件夹中的文件,这些文件是典型的用于创建安卓应用的gradle 文件。 config 子文件夹中的文件，这里的文件才是我们关系的重点，因为我用这里的文件保存和配置项目中的所有工具。 Checkstyle “Checkstyle 是一个开发工具用来帮助程序员编写符合代码规范的Java 代码。它能自动检查 Java 代码为空闲的人进行这项无聊(但重要)的任务。” 正如 Checkstyle 的开发者所言，这个工具能够帮助你在项目中定义和维持一个非常精确和灵活的代码规范形式。当你启动 CheckStyle，它会根据所提供的配置文件分析你的 Java 代码并告诉你发现的所有错误。 Gradle 的形式 下面的代码向你展示了在你的项目中使用Checkstyle 的最基本的配置(如 Gradle 任务): task checkstyle(type: Checkstyle) { configFile file(${project.rootDir}/config/quality/checkstyle/checkstyle.xml) // Where my checkstyle config is... configProperties.checkstyleSuppressionsPath = file(${project.rootDir}/config/quality/checkstyle/suppressions.xml).absolutePath // Where is my suppressions file for checkstyle is... source src include **/*.java exclude **/gen/** classpath = files() } 所以，基本上这个任务会根据 checkstyle.xml 和 suppressions.xml 分析你的代码。通过 Android Studio 执行它仅仅需要从工具面的 CheckStyle 来启动它。 启动 CheckStyle 之后，你讲收到一个报告用于展示在你项目中发现的每个错误。这是非常直接的方式。 如果你想在 checkstyle 上做更多的配置，可以参考这篇文档。Checkstyle 的使用技巧 Checkstyle 会发现大量的问题，特别是在你运用了大量的规则配置，如同你设置了一个非常精确的语法。尽管我通过 Gradle 使用 checkstyle，例如在我进行推送之前，我仍然推荐你为 IntellJ/Android Studio 使用 checkstyle 插件(你可以通过 Android Studio 的工作面板文件/ 设置/插件直接安装插件)。这种方式下，你可以根据那些为 Gradle 配置的相同文件在你的工程中使用 checkstyle，但是远不止这些，你可以直接在 Android Studio 中获取带有超链接结果，这些结果通过超链接在你的代码中对应，这是非常有用的(Gradle 的这种方式仍然很重要的，因为你可以使用它自动构 建系统，如 Jenkins)。 Findbugs Findbugs 是否需要一个呢?我想它的名称已经让人顾名思义了。“FindBugs 使用静态分析方法为出现 bug 模式检查 Java 字节 码”。FindBugs 基本上只需要一个程序来做分析的字节码，所以这是非常容