close
当前位置: 物联网在线 > 技术文库 > android >

如何提高 Android 代码质量 -工具篇

这是一篇翻译文章,原文: How to improve quality and syntax of your Android code ,为了理解连贯,翻译过程中我修改了一些陈述逻辑和顺序,同时也加了一些自己的补充。

如何提高 Android 代码质量 -工具篇

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

0.1 Fork 这个例子工程

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

0.2 关于 Gradle 的 Task

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

0.3 关于 这个 demo 的层级结构

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

* 根目录下的 gradle 文件 ,用来配置工程相关的信息,例如仓库依赖,编译工具版本之类的。

* app 目录下的 gradle 文件 ,用来校验 Java 类。

* config 目录下的 gradle 文件 ,用来配置了以上提到的几个工具。

1 Checkstyle

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

1.1 Android Studio 插件

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

如何提高 Android 代码质量 -工具篇

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

如何提高 Android 代码质量 -工具篇

在这里我们可以设置 Checkstyle 插件扫描范围,配置文件等信息,默认使用的配置文件是官方提供的文件:sun_checks.xml,我们也可以根据自己项目的需要定义自己的配置文件,配置规则可以参考 官方文档 。

设置完成之后点击 “Apply” 或者 “ok” 按钮,回到代码中,我们便可以看到 Checkstyle 给我们的提示:

如何提高 Android 代码质量 -工具篇

1.2 Gradle 方式使用Checkstyle

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

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() }

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

如何提高 Android 代码质量 -工具篇

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

2 FindBugs

如何提高 Android 代码质量 -工具篇

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

Person person = (Person) map.get("bob"); if (person != null) { person.updateAccessTime(); } String name = person.getName();

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

b.replace('b', 'p'); if(b.equals("pop")) { Log.d("",""); }

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

2.1 Android Studio 插件
(责任编辑:ioter)

用户喜欢...

Android Weekly #276 安卓开发周刊 中文版

您是否了解过Android的Lifecycle-Aware库?(android.jlelse.eu) 我们如何了解Lifecycle-Aware库代码? Nishant Srivastava展示了可以跟踪活动或Lifecycle-Aware的Lifecycle Arch组件的片段,并相应地调整其行为。 为Mos...


Android Weekly #275 安卓开发周刊 中文版

MapMe — Android地图适配器 (medium.com) Josh Burton介绍MapMe,是一个用Kotlin编写的Android库,可以将适配器模式带到地图上。 赞助 CloudRail - 连接到API 10x更快 (cloudrail.com) 当我们用单一的界面连接到所...


使用Android Studio开发可独立运行(runnable)混淆过的Jar程序

之前开发Java程序一直都是使用Eclipse 开发Jar程序,现在开发基本上都已经弃用Eclipse了,但是有时偶尔开发个小的Jar程序,还要切换回去好麻烦,刚好前几天有人问几个相关的问题,就顺便整...


Android Weekly #274 安卓开发周刊 中文版

探索Android Oreo上的别后执行限制(medium.com) 在这篇文章中,Joe Birch解释了关于Android Oreo在后台运行服务的变化。 non-Time领主的time – 第5部分 (blog.stylingandroid.com) Mark Allison继续分析JSR 310 date和...


Android Weekly #273 安卓开发周刊 中文版

开源你的Android代码(android.jlelse.eu) 通过您的开源Android代码,您将(希望地)为Android社区提供有价值的代码,收到建设性的反馈,并与您最初建立的内容进行协作从而使您的代码变得更好。这...


Android Weekly #272 安卓开发周刊 中文版

Android Dev 101:每个初学者都应该知道的一些做法() 看一些初学者或媒介等级开发人员(不要错过任何人)应该知道的一些做法,以便更好地摆脱Android框架。 99.9% crash free sessions (medium.com) Chr...


Android Weekly #271 安卓开发周刊 中文版

依赖注入检查(medium.com) 在本文中,MihályNagy引入了依赖注入检查,一种开源注释处理器,可帮助您解决一些出现在所有JSR 330 DI库中常见的问题。 使用Android Studio插件提高效率 (blog.mindorks.com...


Android Weekly #270 安卓开发周刊 中文版

带有RxJava2的SOLID Android分析 (medium.com) 在这篇文章中,Aris Papadopoulos将解释如何正确创建一个分析系统,同时遵循SOLID原则,并使用RxJava2来解决问题。 (blog.stylingandroid.com) Java中的编程时间很难...


Android内存泄漏思考

Android内存泄漏是一个经常要遇到的问题,程序在内存泄漏的时候很容易导致OOM的发生。那么如何查找内存泄漏和避免内存泄漏就是需要知晓的一个问题,首先我们需要知道一些基础知识。...


Android Weekly #269 安卓开发周刊 中文版

在Google上快速提出操作 () Wolfram Rittmeyer分享了开始在Google上快速创建操作所需的所有信息(为了家庭与助理)。 RxJava中的错误处理(rongi.github.io) 一旦开始编写RxJava代码,你就会意识到有些事...