谷歌java安卓代码检查工具,Android Studio 代码检查工具介绍

前言

利用好相关代码检查工具，是一种自我的CodeReview，可以有效降低Bug率，提升自我的代码优化意识。常用的代码检查工具有AndroidStudio 自带的Lint工具、 Alibaba Java Coding Guidelines

什么是 Lint

Android Lint 是 SDK Tools 16(ADT 16)开始引入的一个代码扫描工具，通过对代码进行静态分析，可以帮助开发者发现代码质量问题和提出一些改进建议。除了检查 Android 项目源码中潜在的错误，对于代码的正确性、安全性、性能、易用性、便利性和国际化方面也会作出检查。Android Lint 作为项目的代码检测工具，是因为它具有以下几个特性:

已经被集成到 Android Studio，使用方便;

能在编写代码时实时反馈出潜在的问题;

可以自定义规则。Android Lint 本身包含大量已经封装好的接口，能提供丰富的代码信息，开发者可以基于这些信息进行自定义规则的编写。

1、开始使用

Android Lint 的工作过程比较简单，一个基础的Lint过程由Lint Tool(检测工具)，Source Files(项目源文件) 和 lint.xml(配置文件) 三个部分组成，Lint Tool读取 Source Files，根据lint.xml配置的规则(issue)输出结果(如下图)。

2、操作步骤

Android Studio 中，Android Lint 已经被集成，只需要点击 Analyze-----Inspect Code 即可运行 Android Lint：

操作步骤

在弹出的对话框中可以设置执行 Lint的范围，可以选择整个项目，也可以只选择当前的子模块或者其他自定义的范围：

选择操作范围

检查完毕后会弹出 Inspection 的控制台，并在其中列出详细的检查结果：

image.png

如上图所展示的，Android Lint 对检查的结果进行了分类，同一个规则(issue)下的问题会聚合，其中针对 Android 的规则类别会在分类前说明是Android 相关的，主要是六类：

Accessibility 无障碍，例如 ImageView 缺少contentDescription 描述，String 编码字符串等问题。

Correctness 正确性

Internationalization 国际化，如字符缺少翻译等问题。

Performance 性能，例如在 onMeasure、onDraw 中执行 new，内存泄露，产生了冗余的资源，xml 结构冗余等。

Security 安全性，例如没有使用 HTTPS 连接 Gradle，AndroidManifest 中的权限问题等。

Usability 易用性，例如缺少某些倍数的切图，重复图标等。

其他的结果条目则是针对 Java 语法的问题，另外每一个问题都有区分严重程度(severity)，从高到底依次是：Fatal、Error、Warning、Information、Ignore

其中 Fatal 和 Error 都是指错误，但是 Fatal 类型的错误会直接中断 ADT 导出 APK，更为严重。

在结果列表中点击一个条目，可以看到详细的源文件名和位置，以及命中的错误规则(issue)、解决方案或者屏蔽提示

除了直接在菜单中运行 Lint 外，大部分问题代码在编写时 Android Studio 就会给出提醒。

3、自定义配置

对于执行 Lint 操作的相关配置，是定义在 gradle 文件的 lintOptions 中，可定义的选项及其默认值

android {

lintOptions {

// 设置为 true，则当 Lint 发现错误时停止 Gradle 构建

abortOnError false

// 设置为 true，则当有错误时会显示文件的全路径或绝对路径 (默认情况下为true)

absolutePaths true

// 仅检查指定的问题(根据 id 指定)

check 'NewApi', 'InlinedApi'

// 设置为 true 则检查所有的问题，包括默认不检查问题

checkAllWarnings true

// 设置为 true 后，release 构建都会以 Fatal 的设置来运行 Lint。

// 如果构建时发现了致命(Fatal)的问题，会中止构建(具体由 abortOnError 控制)

checkReleaseBuilds true

// 不检查指定的问题(根据问题 id 指定)

disable 'TypographyFractions','TypographyQuotes'

// 检查指定的问题(根据 id 指定)

enable 'RtlHardcoded','RtlCompat', 'RtlEnabled'

// 在报告中是否返回对应的 Lint 说明

explainIssues true

// 写入报告的路径，默认为构建目录下的 lint-results.html

htmlOutput file("lint-report.html")

// 设置为 true 则会生成一个 HTML 格式的报告

htmlReport true

// 设置为 true 则只报告错误

ignoreWarnings true

// 重新指定 Lint 规则配置文件

lintConfig file("default-lint.xml")

// 设置为 true 则错误报告中不包括源代码的行号

noLines true

// 设置为 true 时 Lint 将不报告分析的进度

quiet true

// 覆盖 Lint 规则的严重程度，例如：

severityOverrides ["MissingTranslation": LintOptions.SEVERITY_WARNING]

// 设置为 true 则显示一个问题所在的所有地方，而不会截短列表

showAll true

// 配置写入输出结果的位置，格式可以是文件或 stdout

textOutput 'stdout'

// 设置为 true，则生成纯文本报告(默认为 false)

textReport false

// 设置为 true，则会把所有警告视为错误处理

warningsAsErrors true

// 写入检查报告的文件(不指定默认为 lint-results.xml)

xmlOutput file("lint-report.xml")

// 设置为 true 则会生成一个 XML 报告

xmlReport false

// 将指定问题(根据 id 指定)的严重级别(severity)设置为 Fatal

fatal 'NewApi', 'InlineApi'

// 将指定问题(根据 id 指定)的严重级别(severity)设置为 Error

error 'Wakelock', 'TextViewEdits'

// 将指定问题(根据 id 指定)的严重级别(severity)设置为 Warning

warning 'ResourceAsColor'

// 将指定问题(根据 id 指定)的严重级别(severity)设置为 ignore

ignore 'TypographyQuotes'

}

}

lint.xml 这个文件则是配置 Lint 需要禁用哪些规则(issue)，以及自定义规则的严重程度(severity)，lint.xml文件是通过 issue 标签指定对一个规则的控制，在项目根目录中建立一个 lint.xml 文件后 Android Lint 会自动识别该文件，在执行检查时按照 lint.xml 的内容进行检查。如上面提到的那样，开发者也可以通过 lintOptions 中的 lintConfig 选项来指定配置文件。lint.xml 示例如下：

issue 标签中使用 id 指定一个规则，severity="ignore" 则表明禁用这个规则。需要注意的是，某些规则可以通过 ignore 标签指定仅对某些属性禁用，例如上面的 Deprecated，表示检查是否有使用不推荐的属性和方法，而在issue 标签中包裹一个 ignore 标签，在ignore 标签的 regexp 属性中使用正则表达式指定了 singleLine，则表明对 singleLine 这个属性屏蔽检查。

另外开发者也可以使用 @SuppressLint(issue id) 标注针对某些代码忽略某些 Lint 检查，这个标注既可以加到成员变量之前，也可以加到方法声明和类声明之前，分别针对不同范围进行屏蔽。

Alibaba Java Guidelines的使用

这是一款阿里巴巴基于Java规范开发的AndroidStudio插件，需要单独安装在AndroidStudio中，它可以规范我们的代码编写，进行实时代码规范提示。

1、如何安装插件

Android Studio --> File --> Settings... --> Plugins --> 搜索Alibaba Java Guidelines --> 安装并重启Android Studio

阿里巴巴Java规范插件

2、使用

在日常编写代码时，插件会实时对代码进行检测给出相应的提示信息，并给出对应的代码优化方案。示例如下：

下面switch语句块，按照Java规范，是缺少default语句的，插件会提示加上。

image.png

Apk 体积分析

当我们打包apk之后，有时候apk有点大，想要针对apk进行“瘦身”，此时我们需要知道哪些哪些东西占用较多，才有针对性的进行apk体积优化，可以使用AndroidStudio自带功能检测apk。

在AndroidStudio中双击打包的apk文件之后右侧会弹出对应的apk分析窗口，如下所示：

可以清楚看到哪些文件占用apk大小的比重信息，同时也可以将两个apk进行比对。

apk分析.png

依赖占用过大，可以选择将一些没有使用到的依赖进行剔除，资源图片没有使用到的也可以剔除掉，资源图片占用过大，可使用TinyPng将图片进行无损压缩处理。

TinyPng官网