业精于勤而荒于嬉,行成于思而毁于随。
为什么要自定义 Lint ?
在某些特殊情况下,系统定义的 Lint 并不能满足我们的需求,这时需要我们自己定义规则,然后利用 Android 的 Lint 工具帮助我们自动发现某些问题。
自定义 Lint 的原理
主要使用LinkedIn发方案:将jar放到一个aar中。然后 Android 项目依赖这个 aar 完成自定义 lint 检查(只对当前项目有效)。
实操体验
(1)实操环境
- 可选项,用自己的环境和代码也一样。
- SamplePop环境如下: Android Studio 4.0 Gradle version 6.1.1 Android API version 30
(2)工程创建与配置
创建Java工程,配置Gradle。
apply plugin: 'java-library'
dependencies {
implementation fileTree(dir: 'libs', include: ['*.jar'])
implementation 'com.android.tools.lint:lint-api:26.0.0'
implementation 'com.android.tools.lint:lint-checks:26.0.0'
}
- lint-api: 官方给出的API(每个版本都会大变,对比了24,25,26,27这四个版本,变化太大了)
- lint-checks:已有的检查。
我在实操时遇到的问题:
- 我在配置Gradle文件时,想着用最新的版本吧,我就添加的是27的版本号。在编译出的jar包放到
~/.android/lint/
后,执行lint检查,自己写的Detector扫描器怎么都不生效,系统提示找不到对应的SourceCodeScanner
类(这个要看你的Detector是实现的哪个lint-api)。 - 我猜那可能是与系统自带的扫描器版本不对应啊,于是就查了下系统的自带lint版本(系统自带版本是26.0.0,我的gradle配置为27.0.0)。修改gradle版本,再次检查,成功!
(3)创建 Detector
Detector负责扫描代码,发现问题并报告。
下面扫描器的功能很简单,就是监听系统logandroid.util.Log的使用,lint检查结果提示推荐使用 LogUtil 封装类。
public class KJYRLogUtilDetector extends Detector implements Detector.UastScanner {
public static final Issue ISSUE = Issue.create(
"KJYRLogUtilCase",
"科技猿人-避免使用Log",
"使用LogUtil,LogUtil对系统的Log类进行了逻辑封装",
Category.SECURITY, 5, Severity.WARNING,
new Implementation(KJYRLogUtilDetector.class, Scope.JAVA_FILE_SCOPE));
public List<String> getApplicableMethodNames() {
return Arrays.asList("d", "e", "i", "v", "w");
}
@Override
public void visitMethod(JavaContext context, UCallExpression node, PsiMethod method) {
JavaEvaluator evaluator = context.getEvaluator();
if (evaluator.isMemberInClass(method, "android.util.Log")) {
String message = "kejiyuanren:请使用LogUtil封装类";
context.report(ISSUE, node, context.getLocation(node), message);
}
}
}
细则说明:
getApplicableMethodNames
:返回要监听的方法名称集合context.report(ISSUE, node, context.getLocation(node), message)
:检查结果上报(report会自动处理被suppress(suppressLint)/ignore(tools:ignore)的警告)Issue
:由静态工厂方法创建,由Detector 发现并报告。
Issue字段说明:
- id : 唯一值,应该能简短描述当前问题。利用Java注解或者XML属性进行屏蔽时,使用的就是这个id。
- summary : 简短的总结,通常5-6个字符,描述问题而不是修复措施。
- explanation : 完整的问题解释和修复建议。
- category : 问题类别。详见下文详述部分。
- priority : 优先级。1-10的数字,10为最重要/最严重。
- severity : 严重级别:Fatal, Error, Warning, Informational, Ignore。
- Implementation : 为Issue和Detector提供映射关系,Detector就是当前Detector。声明扫描检测的范围Scope,Scope用来描述Detector需要分析时需要考虑的文件集,包括:Resource文件或目录、Java文件、Class文件。
(4)创建 IssueRegistry
提供需要被检测的Issue列表
public class KJYRIssueRegistry extends IssueRegistry {
@Override
public List<Issue> getIssues() {
return Arrays.asList(
KJYRLogUtilDetector.ISSUE,
KJYRSetTextDetector.SET_TEXT_I18N
// HandlerDetector.ISSUE
);
}
}
(5)jar 包生成
我们将写好的扫描器打包成jar
jar {
manifest {
attributes("Lint-Registry": "com.kejiyuanren.lint_jar.KJYRIssueRegistry")
}
}
(6)jar 包使用
最终jar包是要提供给系统lint扫描的,下面的两个方案最明显的区别就是影响范围。
(6.1)Google 方案
//将jar拷贝到~/.android/lint中
$ mkdir ~/.android/lint/
$ cp lint_jar.jar ~/.android/lint/
缺点:针对所有工程,会影响同一台机器其他工程的Lint检查。即便触发工程时拷贝过去,执行完删除,但其他进程或线程使用./gradlew lint仍可能会受到影响。
(6.2)LinkedIn 方案
LinkedIn 提供了另一种思路 : 将jar放到一个aar中。这样我们就可以针对工程进行自定义Lint,lint.jar只对当前工程有效。
lint_jar 工程:build.gradle
//注册 KJYRIssueRegistry,生成jar包
jar {
manifest {
attributes("Lint-Registry": "com.kejiyuanren.lint_jar.KJYRIssueRegistry")
}
}
//声明依赖
configurations {
lintJarOutput
}
//依赖项实现
dependencies {
lintJarOutput files(jar)
}
lint_aar 工程:build.gradle
//配置lint的jar包
configurations {
lintJarImport
}
//依赖项实现
dependencies {
lintJarImport project(path: ":lint_jar", configuration: "lintJarOutput")
}
//将jar复制到lint目录下的lint.jar
task copyLintJar(type: Copy) {
from (configurations.lintJarImport) {
rename {
String fileName ->
'lint.jar'
}
}
into 'build/intermediates/lint/'
}
//将 copyLintJar 插入到 compileLint 之前执行
project.afterEvaluate {
def compileLintTask = project.tasks.find { it.name == 'compileLint' }
compileLintTask.dependsOn(copyLintJar)
}
lint 工程:build.gradle
dependencies {
//添加lint aar
implementation project(':lint_aar')
}
(7)lint 检查结果
(8)实践总结
- lint的版本匹配问题,如果遇到自定义lint不生效,请让自己的lint版本与系统版本保持一致
- 多看lint-checks中的现有Detector,从源码中学到更多,更系统
- 如果对自定义lint开发plugin感兴趣,请参考文章结尾的: 美团 -> Android自定义Lint实践
- 如果对debug lint代码感兴趣,请参考文章结尾的:优秀文章
小编的扩展链接
参考链接
新晴原野旷,极目无氛垢
❤ 比心 ❤
今天的文章(八)下篇 Android 性能优化 Lint 自定义Lint分享到此就结束了,感谢您的阅读。
版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 举报,一经查实,本站将立刻删除。
如需转载请保留出处:https://bianchenghao.cn/21992.html