1.检查原理
定制自己的lint.jar,放置到 build/intermediates/lint文件夹下或者放置到.android/lint文件夹下,后续执行的lint检查都会自动包含自定义lint.jar中的检查。
2.脚本分工
略
3.编写细节
3.0lint.jar开发基础
在AS工具上新建一个java模块工程,build.gradle中配置好lint需要的依赖和注册检查的入口(lint启动检查时会自动调用入口函数),如下所示。
入口类是一个继承IssueRegistry的类,只需要实现getIssues函数即可,该函数返回一个Issue的集合。Issue就是我们写的lint检查的"规则",
是描述一个问题的数据结构(推荐每个规则都可以写一个Issue)。
生成一个Issue是调用它的静态方法create,传入一些参数即可,大部分参数可以轻松获得,最重要的一个参数就是Implementation,即实现类。
我们需要传入具体实现对这个规则进行检查的Implementation,这个东西是由一个继承Detector的class和一个枚举生成。
所以自定义lint规则简单地说,每中规则只需要完成一个Detector的编写,然后按照Implementation->Issue->IssueRegistry来完成设计。
下面以Log检查的代码为例,介绍如何编写Detector。
首先继承Detector,然后根据需求,选中需要实现的扫描器(java文件,xml文件等等)
选择需要关注的节点,这里是第38行,返回需要关注的节点list。
选择需要关注的节点名字,这里是33行,也是个list。
返回处理器。当lint遇到指定的节点时用来处理的类。这里我们返回LogVisit,一个直接继承了ForwardAstVisitor的类。
AstVisitor是节点处理类,相当于一个回调函数。根据上面筛选内容的不同,我们可以选择实现不同的方法来处理。
3.1准备jar文件
完成decetor的编写后,下一步需要将这些java文件输出成jar包,供外部使用,这里直接使用gradle的命令jar即可,完成后可以在build/libs目录下看到生成的jar文件。
3.2jar文件位置选取
开头说过,jar文件放到.android/lint目录和build/intermediates/lint目录下都可以实现自定义检查,但是为了配置方便,我们选取了放置到build/intermediates/lint目录下的方式。由于build文件每次clean都会删除,参考美团aar方式依赖,我们使用脚本来完成这个自动将jar文件拷贝到build/intermediates/lint目录下的过程。
新建一个task,功能是对jar文件的拷贝,且是lint的前置任务。然后我们将jar包放置到tools目录下,每次运行lint检查前,这个copyLintJar任务都会自动将jar文件从tools目录拷贝到build/intermediates/lint目录。
3.3git执行提交前检查
git提供了客户端和服务端两种脚本用来进行提交前检查。我们想要实现本地提交时进行代码检查,需要用到客户端脚本。
打开.git/hooks/目录,看到有各种各样的前置脚本,这里使用了pre-commit脚本。这个脚本文件在git的commit命令执行前进行触发,返回值为0表示通过。
脚本内容就是触发当前工程的lint检查,由于.git目录下无法获取到对应的模块名称和路径,这里需要通过外部将需要的变量设置进来,所以这里提供了一个模板,使用gradle脚本复制文件时,自动将当前的模块名和根模块名等变量设置进去,生成pre-commit的shell脚本,放置到.git/hooks/目录下即可。
pre-commit的模板文件。
3.4执行效果
3.5TODO
指定提交文件单独检查
参考文档:
https://www.imooc.com/article/30302?block_id=tuijian_wz
http://tools.android.com/tips/lint-custom-rules
https://github.com/xsfelvis/LintDemo
https://tech.meituan.com/android_custom_lint.html
//www.greatytc.com/p/7b3519dc1e5f
//www.greatytc.com/p/21d4cbe68a28