Android Lint

这是一个通用Android Lint库，你可以用它来检查代码规范、bug、资源命名等✌️。

本库最大特点是通用，相较于其他Lint库（规则直接在代码写死），最大的不同是，规则全靠配置生成，更加灵活，在多团队协作下，只需拷贝配置文件，修改提示信息即可完成迁移。

支持增量扫描功能，速度更快。

支持lint发现错误后自动执行脚本功能，更加友好。

对于增量扫描原理可以看Lint增量扫描实践，具体在项目中使用可以参考Android Lint代码检查实践。

如果有感兴趣的大佬，欢迎一起开发、交流。

地址

https://github.com/RocketZLY/AndroidLint

项目结构

. ├── app // demo工程用来展示lint检查效果 ├── checks // lint规则代码 ├── custom_lint_config.json // 规则配置文件 ├── lintlibrary // 空项目，依赖了checks用来生成aar包 ├── lintpatch // 实现lint增量扫描、修复lint26.5.3bug的补丁代码 ├── lintplugin // lint插件，用来增量扫描、执行脚本、简化配置、日志输出等

依赖

需要Android Gradle Plugin在3.5.0以上，目前我项目使用的是3.5.3实测ok。

根目录gradle

buildscript { repositories { jcenter() } dependencies { classpath "com.rocketzly:lintPlugin:$lastVersion" } }

module gradle

apply plugin: "com.rocketzly.lintPlugin"

使用

添加依赖后，并在项目根目录下添加custom_lint_config.json规则配置文件（关于配置可以看后面的规则配置）

编码实时提示

添加依赖和配置文件后Rebuild一下（如果还不行则执行次./gradlew :${moduleName}:lintFull）即可编码实时提示。

有一点需要注意，AS对于Lint实时提示支持的不算特别好，少数情况下会出现编码时提示不了的情况，但是命令行执行生成报告结果都是正常的，所以以报告结果为准。

命令行执行

目前支持两个命令：

./gradlew lintFull 全量扫描（只扫自定义issue）./gradlew lintIncrement -Pbaseline="xxx" -Prevision="xxx" 增量扫描（只扫自定义issue）

参数描述：

baseline：执行lintIncrement必须参数，用来设置基线代码分支或者commit节点revision：执行lintIncrement必须参数，用来设置最新分支或者commit节点scriptPath：可选参数，在lint发现错误的时候自动执行脚本路径，目前只支持执行python3和shell脚本

脚本入参：

reportPath：html报告地址userName：操作人名字moduleName：模块名字errorCount：错误数

具体参数获取方法可以参照项目根目录中lintScriptDemo脚本

顺带提一句增量扫描是通过git diff $baseline $revision --name-only --diff-filter=ACMRTUXB去找到变更文件的，所以只要是git命令支持的都可以作为baseline和revision的入参。

那么添加依赖和配置文件后，Terminal执行./gradlew :app:lintFull或者./gradlew :app:lintIncrement -Pbaseline="xxx" -Prevision="xxx就可以看到检查结果。

以本库为例，执行./gradlew :app:lintIncrement -Pbaseline="dev" -Prevision="HEAD" -PscriptPath="lintNotification.py"结果如下：

查看生成的Html文件可以查看详细lint报告

最新版本代码日志和报告可能稍有不同但不影响结果

Lint配置

module gradle

lintConfig { baseline = true//生成baseline文件，默认为false不会生成 } baseline：是否生成baseline文件，默认为false不生成，如果需要生成则设置为true（可选项）

默认值（目前还不支持配置，如有需要可以提issue）

只扫描自定义Issue不会将warning视为error只有发现error的时候才会停止task执行html报告地址：${modulePath}/build/reports/lint-results.htmlxml报告地址：${modulePath}/build/reports/lint-results.xmlbaseline地址：${modulePath}/lint-baseline.xml

规则配置

自定义Issue规则是从根目录custom_lint_config.json文件读取。

目前支持五大类规则（后期会继续增加、完善规则，欢迎有兴趣大佬一起开发）

避免使用Api（又可细分为三类） 避免使用的方法避免创建的类避免继承或实现的类 需要处理异常的方法有依赖关系Api（即trigger_method方法调用后，必须调用dependency_method方法）资源命名规范Serializerable对象的引用类型成员变量也必须要实现Serializerable接口

具体配置规则和说明如下（注：由于markdown表格没法表示层级关系，故用+代表json层级关系）

字段类型默认值是否必须备注avoid_usage_apiObject无非必须避免使用api+methodObject[]无非必须避免使用的方法++nameString无name和name_regex有一个即可方法名，匹配方法全路径，以Toast#show()为例，则应填入android.widget.Toast.show++name_regexString无name和name_regex有一个即可方法名正则匹配，以Log#i()为例，则应填入android.util.Log.(v|d|i|w|e)++messageString无必须提示信息++excludeString[]无非必须需要排除检查的类，匹配全路径类名，例如com.rocketzly.androidlint.Test++exclude_regexString无非必须需要排除检查的类正则匹配++severityString“error”非必须lint错误严重程度默认error，可输入fatal、error、warning、informational、ignore+constructionObject[]无非必须避免创建类++nameString无name和name_regex有一个即可构造函数名，匹配方法全路径，以Thread构造函数为例java.lang.Thread++name_regexString无name和name_regex有一个即可方法名正则匹配++messageString无必须提示信息++excludeString[]无非必须需要排除检查的类，匹配全路径类名，例如com.rocketzly.androidlint.Test++exclude_regexString无非必须需要排除检查的类正则匹配++severityString“error”非必须lint错误严重程度默认error，可输入fatal、error、warning、informational、ignore+inheritObject[]无非必须避免继承或实现的类++nameString无name和name_regex有一个即可类名，匹配全路径类名，例如com.rocketzly.androidlint.Test++name_regexString无name和name_regex有一个即可类名正则匹配，例如\.(AppCompat|Main)?Activity$++messageString无必须提示信息++excludeString[]无非必须需要排除检查的类，匹配全路径类名，例如com.rocketzly.androidlint.Test++exclude_regexString无非必须需要排除检查的类正则匹配++severityString“error”非必须lint错误严重程度默认error，可输入fatal、error、warning、informational、ignorehandle_exception_methodObject[]无非必须需要处理异常的方法+nameString无name和name_regex有一个即可方法名，匹配方法全路径，以Toast#show()为例，则应填入android.widget.Toast.show+name_regexString无name和name_regex有一个即可方法名正则匹配，以Log#i()为例，则应填入android.util.Log.(v|d|i|w|e)+exceptionString无必须需要处理的异常全路径类名，如java.lang.IllegalArgumentException+messageString无必须提示信息+excludeString[]无非必须需要排除检查的类，匹配全路径类名，例如com.rocketzly.androidlint.Test+exclude_regexString无非必须需要排除检查的类正则匹配+severityString“error”非必须lint错误严重程度默认error，可输入fatal、error、warning、informational、ignoredependency_apiObject[]无非必须有依赖关系api+trigger_methodString无必须触发方法，匹配方法全路径，以Toast#show()为例，则应填入android.widget.Toast.show+dependency_methodString无必须依赖方法，匹配方法全路径，即当调用trigger_method后需要调用dependency_method方法+messageString无必须提示信息+severityString“error”非必须lint错误严重程度默认error，可输入fatal、error、warning、informational、ignoreresource_nameObject无非必须资源命名规范+drawableObject无非必须drawable命名规范++name_regexString无必须资源名正则规范++messageString无必须提示信息++severityString“error”非必须lint错误严重程度默认error，可输入fatal、error、warning、informational、ignore+layoutObject无非必须layout命名规范++name_regexString无必须资源名正则规范++messageString无必须提示信息++severityString“error”非必须lint错误严重程度默认error，可输入fatal、error、warning、informational、ignoreserializable_configObject无非必须Serializable配置+name_regexString无必须检查哪些包下的类，例如只检查自己包下的类^com\.rocketzly\.androidlint+messageString无必须提示信息+severityString“error”非必须lint错误严重程度默认error，可输入fatal、error、warning、informational、ignore

匹配规则是先排除后匹配，优先级上exclude > exclude_regex > name > name_regex。

message会影响到AS实时提示展示的信息和report中展示信息。

severity则是对应AS实时提示的错误等级和report中错误等级。

具体demo可以看项目根目录下custom_lint_config.json。

关于

对Lint感兴趣的小伙伴可以加我微信交流，微信号：RocketZly。

另外我也创建了一个Lint交流群，欢迎加我进群。