// 设置为 true 则会生成一个 HTML 格式的报告
htmlReport true
// 设置为 true 则只报告错误
ignoreWarnings true
// 重新指定 Lint 规则配置文件
lintConfig file(“default-lint.xml”)
// 设置为 true 则错误报告中不包括源代码的行号
noLines true
// 设置为 true 时 Lint 将不报告分析的进度
quiet true
// 覆盖 Lint 规则的严重程度,例如:
severityOverrides [“MissingTranslation”: LintOptions.SEVERITY_WARNING]
// 设置为 true 则显示一个问题所在的所有地方,而不会截短列表
showAll true
// 配置写入输出结果的位置,格式可以是文件或 stdout
textOutput ‘stdout’
// 设置为 true,则生成纯文本报告(默认为 false)
textReport false
// 设置为 true,则会把所有警告视为错误处理
warningsAsErrors true
// 写入检查报告的文件(不指定默认为 lint-results.xml)
xmlOutput file(“lint-report.xml”)
// 设置为 true 则会生成一个 XML 报告
xmlReport false
// 将指定问题(根据 id 指定)的严重级别(severity)设置为 Fatal
fatal ‘NewApi’, ‘InlineApi’
// 将指定问题(根据 id 指定)的严重级别(severity)设置为 Error
error ‘Wakelock’, ‘TextViewEdits’
// 将指定问题(根据 id 指定)的严重级别(severity)设置为 Warning
warning ‘ResourceAsColor’
// 将指定问题(根据 id 指定)的严重级别(severity)设置为 ignore
ignore ‘TypographyQuotes’
}
}
lint.xml 这个文件则是配置 Lint 需要禁用哪些规则(issue),以及自定义规则的严重程度(severity),lint.xml 文件是通过 issue 标签指定对一个规则的控制,在项目根目录中建立一个 lint.xml 文件后 Android Lint 会自动识别该文件,在执行检查时按照 lint.xml 的内容进行检查。如上面提到的那样,开发者也可以通过 lintOptions 中的 lintConfig 选项来指定配置文件。一个 lint.xml 示例如下:
<?xml version="1.0" encoding="UTF-8"?>issue 标签中使用 id 指定一个规则,severity="ignore"
则表明禁用这个规则。需要注意的是,某些规则可以通过 ignore 标签指定仅对某些属性禁用,例如上面的 Deprecated
,表示检查是否有使用不推荐的属性和方法,而在 issue 标签中包裹一个 ignore 标签,在 ignore 标签的 regexp
属性中使用正则表达式指定了 singleLine
,则表明对 singleLine
这个属性屏蔽检查。
另外开发者也可以使用 @SuppressLint(issue id)
标注针对某些代码忽略某些 Lint 检查,这个标注既可以加到成员变量之前,也可以加到方法声明和类声明之前,分别针对不同范围进行屏蔽。
常见问题
我们在使用 Android Lint 对项目进行检查后,整理了一些问题及解决方法,下面列举较为常见的场景:
ScrollView size validation
这也是上文提到过的一个情况,在 ScrollView 的第一层子元素中设置了高度为 match_parent
,这是错误的写法,实际上在 measure 时这里必定会被当作 wrap_content
去处理,因此按照 Lint 的建议,直接改为 wrap_content
即可。
Handler reference leaks
Handler 引用的内存泄露问题,例如下面的例子:
protected static final int STOP = 0x10000;
protected static final int NEXT = 0x10001;
@BindView(R.id.rectProgressBar) QMUIProgressBar mRectProgressBar;
@BindView(R.id.circleProgressBar) QMUIProgressBar mCircleProgressBar;
int count;
private Handler myHandler = new Handler() {
@Override
public void handleMessage(Message msg) {
super.handleMessage(msg);
switch (msg.what) {
case STOP:
break;
case NEXT:
if (!Thread.currentThread().isInterrupted()) {
mRectProgressBar.setProgress(count);
mCircleProgressBar.setProgress(count);
}
}
}
};
首先非静态的内部类或者匿名类会隐式的持有其外部类的引用,内部类使用了外部类的方法/成员变量也会导致其持有外部类引用,因此上面这种情况会导致 handler 持有了外部类,外部类同时持有 handler,handler 是异步的,当 handler 的消息发送出去后,外部类因 hanlder 的持有而无法销毁,最终导致内存泄露。
解决办法则是把该内部类改为 static,内部类中使用的外部类方法/成员变量改为弱引用,具体如下:
@BindView(R.id.rectProgressBar) QMUIProgressBar mRectProgressBar;
@BindView(R.id.circleProgressBar) QMUIProgressBar mCircleProgressBar;
int count;
private ProgressHandler myHandler = new ProgressHandler();
@Override
protected View onCreateView() {
myHandler.setProgressBar(mRectProgressBar, mCircleProgressBar);
}
private static class ProgressHandler extends Handler {
private WeakReference weakRectProgressBar;
private WeakReference weakCircleProgressBar;
public void setProgressBar(QMUIProgressBar rectProgressBar, QMUIProgressBar circleProgressBar) {
weakRectProgressBar = new WeakReference<>(rectProgressBar);
weakCircleProgressBar = new WeakReference<>(circleProgressBar);
}
@Override
public void handleMessage(Message msg) {
super.handleMessage(msg);
switch (msg.what) {
case STOP:
break;
case NEXT:
if (!Thread.currentThread().isInterrupted()) {
if (weakRectProgressBar.get() != null && weakCircleProgressBar.get() != null) {
weakRectProgressBar.get().setProgress(msg.arg1);
weakCircleProgressBar.get().setProgress(msg.arg1);
}
}
}
}
}
Memory allocations within drawing code
.setProgress(msg.arg1);
weakCircleProgressBar.get().setProgress(msg.arg1);
}
}
}
}
}