Android Lint检查

1.检查原理

定制自己的lint.jar,放置到 build/intermediates/lint文件夹下或者放置到.android/lint文件夹下,后续执行的lint检查都会自动包含自定义lint.jar中的检查。

2.脚本分工

3.编写细节

3.0lint.jar开发基础

在AS工具上新建一个java模块工程,build.gradle中配置好lint需要的依赖和注册检查的入口(lint启动检查时会自动调用入口函数),如下所示。


image.png

入口类是一个继承IssueRegistry的类,只需要实现getIssues函数即可,该函数返回一个Issue的集合。Issue就是我们写的lint检查的"规则",

是描述一个问题的数据结构(推荐每个规则都可以写一个Issue)。


image.png

生成一个Issue是调用它的静态方法create,传入一些参数即可,大部分参数可以轻松获得,最重要的一个参数就是Implementation,即实现类。


image.png

我们需要传入具体实现对这个规则进行检查的Implementation,这个东西是由一个继承Detector的class和一个枚举生成。


image.png

所以自定义lint规则简单地说,每中规则只需要完成一个Detector的编写,然后按照Implementation->Issue->IssueRegistry来完成设计。

下面以Log检查的代码为例,介绍如何编写Detector。

首先继承Detector,然后根据需求,选中需要实现的扫描器(java文件,xml文件等等)

选择需要关注的节点,这里是第38行,返回需要关注的节点list。

选择需要关注的节点名字,这里是33行,也是个list。

返回处理器。当lint遇到指定的节点时用来处理的类。这里我们返回LogVisit,一个直接继承了ForwardAstVisitor的类。


image.png

AstVisitor是节点处理类,相当于一个回调函数。根据上面筛选内容的不同,我们可以选择实现不同的方法来处理。


image.png

3.1准备jar文件

完成decetor的编写后,下一步需要将这些java文件输出成jar包,供外部使用,这里直接使用gradle的命令jar即可,完成后可以在build/libs目录下看到生成的jar文件。


image.png

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目录。


image.png

3.3git执行提交前检查

git提供了客户端和服务端两种脚本用来进行提交前检查。我们想要实现本地提交时进行代码检查,需要用到客户端脚本。

打开.git/hooks/目录,看到有各种各样的前置脚本,这里使用了pre-commit脚本。这个脚本文件在git的commit命令执行前进行触发,返回值为0表示通过。

脚本内容就是触发当前工程的lint检查,由于.git目录下无法获取到对应的模块名称和路径,这里需要通过外部将需要的变量设置进来,所以这里提供了一个模板,使用gradle脚本复制文件时,自动将当前的模块名和根模块名等变量设置进去,生成pre-commit的shell脚本,放置到.git/hooks/目录下即可。

image.png

pre-commit的模板文件。


image.png

3.4执行效果

image.png

3.5TODO

指定提交文件单独检查

参考文档:

https://www.imooc.com/article/30302?block_id=tuijian_wz

https://github.com/GavinCT/MeituanLintDemo/blob/master/plugin/src/main/groovy/com/meituan/android/lint/MTLintPlugin.groovy

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

//www.greatytc.com/p/cd1a78dc8346

https://developer.android.com/studio/write/lint#commandline

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 219,427评论 6 508
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,551评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 165,747评论 0 356
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,939评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,955评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,737评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,448评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,352评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,834评论 1 317
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,992评论 3 338
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,133评论 1 351
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,815评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,477评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,022评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,147评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,398评论 3 373
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,077评论 2 355

推荐阅读更多精彩内容