Android Studio 3.0+ 版本的自定义lint检查

定义LintModule
开发lint规则
- lint库依赖
- 新建log检查规则
- - LogDetactor
- IssueRegistry
注册Registry
Android Module中做lint check的依赖
lint report

Android Studio上自定义lint在Android Studio3.0上有了非常简单的实现机制，在此记录一下

定义LintModule

首先需要新建一个module，选择Module类型为java lib。下一步lib的名称，包名，class名称按自己的要求来

开发lint规则

lint库依赖

在lintModule的build.gradle中引入lint的依赖

dependencies {compileOnly 'com.android.tools.lint:lint-api:26.2.0'compileOnly 'com.android.tools.lint:lint-checks:26.2.0'
}

新建log检查规则

Android项目中因为安全问题，一般都不推荐直接使用系统的log打日志。可以针对代码中的log使用给出error的红线警告。

LogDetactor

继承Detector实现的接口是Detector.UastScanner
第一步是定义这个issue，前面3个参数用来定义这个issue的id和文本信息。Category.SECURITY用来定义issue的分组，prority是错误等级，Severrity.ERROR是错误的严重程度（代码底下显示红色警告还是黄色警告），这3个参数都会影响lint的Report报告信息和分组信息。最后一个参数影响的是issue的检查范围，Log只会存在java文件中所以检查范围是java文件。

  @Overridepublic List<String> getApplicableMethodNames() {return Arrays.asList("v", "d", "i", "w", "e");}@Overridepublic void visitMethod(JavaContext context, UCallExpression node, PsiMethod method) {if (context.getEvaluator().isMemberInClass(method, "android.util.Log")) {context.report(ISSUE, node, context.getLocation(node), "请勿直接调用android.util.Log，应该使用统一Log工具类");}}

第二步就是检测出使用了log的代码，getApplicableMethodNames，可以定义这个issue检查的方法，返回的是方法名的集合。visitMethod可以用来访问类中的方法，并针对方法的信息定义报错的信息，例子就是找出"android.util.Log"的类，如果有使用 context.report打印警告信息。到这里LogDetector的检查就完成了。

IssueRegistry

写好LogDetector之后，还需要将LogDetector注册到IssueRegistry。新建一个类并继承IssueRegistry

public class IssueRegister extends IssueRegistry {@NotNull@Overridepublic List<Issue> getIssues() {return new ArrayList<Issue>() {{add(LogDetector.ISSUE);}};}@Overridepublic int getApi() {return ApiKt.CURRENT_API;}@Overridepublic int getMinApi() {return 1;}
}

getIssues方法用来将自定义的Issue add并return，getApi方法是自定义lint的IssueRegistry默认的返回，getMinApi是兼容老版本情况下需要返回1，默认可以不用复写

注册Registry

这一步很简单，还是lintModule的build.gradle中写上这么一段代码

jar {manifest {attributes("Lint-Registry-v2": "com.lintrules.IssuesRegister")}
}

IssuesRegister就是刚才注册LogDetactor的类，把这个类的全名写到配置中即可

Android Module中做lint check的依赖

lintModule已经完成，需要将lintModule引入到项目中，不同于库的依赖，lintModule的依赖使用的是lintchecks，在需要做lint检测的module的build.gradle的依赖中加入即可

dependencies {lintChecks project(':lintrules')
}

依赖添加完成后，重新build一次项目，在Android Module中build目录下可以找到lint.jar，代表自定义lint已经添加成功了
现在如果代码中直接使用log就会出现红色的警告提示

lint report

自定义的lint还可以在lint report中生效，使用命令 ./gradlew 工程名:lint，比如这里就是./gradlew app:lint，就可以执行lint task，执行完成后就会在build文件下生成report文件夹
打开h5文件就可以看到检测的结果