代码洁癖症的我，学习Lint学到心态爆炸

前言

以前对下面的问题，我的态度是，不报错就是没问题，报错就用快捷键，根据Android Studio提示修复问题，从来不去问个为什么？现在代码洁癖症越来越严重的我，忍不住想看搞清什么东西在·搞·鬼·。

认真看完本文，一定可以学到最新的知识。就算看不下去，也要点个赞收藏，绝对不亏。

不知道大家有没有注意项目中·黄·色·代码块的提示，如下图所示：


image

或者红色标记的代码(并没有任何错误)，如下图所示：

image

上文黄色的提醒和红色警告，都是来自Android Studio内置的Lint工具检查我们的代码后而作出的动作。
通过配置Lint,也可以消除上面的提醒。例如，我开发系统APK,根本不需要考虑用户是否授权。
那么Lint是什么呢？

Lint

Android Studio 提供一个名为Lint的静态代码扫描工具，可以发现并纠正代码结构中的质量问题，而无需实际执行该应用，也不必编写测试用例。
Lint 工具可检查您的 Android 项目源文件是否包含潜在错误，以及在正确性、安全性、性能、易用性、便利性和国际化方面是否需要优化改进。

也就是说，通过Lint工具，我们可以写出更高质量的代码和代码潜在的问题，妈妈再也不用担心我的同事用中文命名了。也可以通过定制Lint相关配置，提高开发效率。

Lint禁止检查

由于Android Studio内置了Lint工具，好像不需要我们干嘛。可是呀，我有强迫症，看着上面的黄色块，超级不爽的。所以我们得了解如何配置Lint，让它为我们服务，而不是为Google服务。

本文开始的红色错误可以通过注解来消除（一般建议是根据提示进行修正，除非明白自己在做什么），可以在类或该代码所在的方法添加@SuppressLint。

image

上图中是禁止Lint检查特定的问题检查，如果要禁止该Java文件所有的Lint问题，可以在类前添加如下注解:@SuppressLint(all)。
对XMl文件的禁止，则可以采用如下形式：

  1. 在lint.xml声明命名空间
namespace xmlns:tools="http://schemas.android.com/tools"
  1. 在布局中使用：
<LinearLayout
    xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    tools:ignore="UnusedResources" >

    <TextView
        android:text="@string/auto_update_prompt" />
</LinearLayout>

父容器声明了ignore属性，那么子视图会继承该属性。例如上文LinearLayout中声明了禁止Lint检查LinearLayout的UnusedResources问题，TextView自然也禁止检查该问题。禁止检查多个问题，问题之间用逗号隔开；禁止检查所有问题则使用all关键字。

tools:ignore="all"

我们也可以通过配置项目的Gradle文件来禁止检查。

例如禁止Lint检查项目AndroidManifest.xml文件的GoogleAppIndexingWarning问题。在项目对应组件工程的Gradle文件添加如下配置,这样就不会有黄色提醒了。

defaultConfig{
    lintOptions {
        disable 'GoogleAppIndexingWarning'
    }
}

那么，可以禁止lint工具检查什么问题？

配置Lint

在上文中通过注解和在xml使用属性来禁止Lint工具检查相关问题,其实已经是对Lint的配置了。Lint将多个问题归为一个issue(规则)，例如下图右边的的六大规则。

image

上图是Lint工具的工作流程，下面了解相关概念。
App Source Files
源文件包含组成 Android 项目的文件，包括 Java 和 XML 文件、图标和 ProGuard 配置文件等。
lint.xml 文件
此配置文件可用于指定您希望排除的任何 Lint 检查以及自定义问题严重级别。
lint Tool
我们可以通过Android Studio 对 Android 项目运行此静态代码扫描工具。也可以手动运行。Lint 工具检查可能影响 Android 应用质量和性能的代码结构问题。
Lint 检查结果
我们可以在控制台（命令行运行）或 Android Studio 的 Inspection Results 窗口中查看 Lint 检查结果。

通过Lint工具的工作流程了解到，可以在lint.xml文件配置一些信息。一般新建项目都是没有lint.xml文件的，在项目的根目录创建lint.xml文件。格式如下：

<?xml version="1.0" encoding="UTF-8"?>
<lint>
        <!-- list of issues to configure -->
</lint>

那么有哪些Issues（规则）呢？

在Android主要有如下六大类：

  • Security 安全性。在AndroidManifest.xml中没有配置相关权限等。
  • Usability 易用性。重复图标；上文开始黄色警告也属于该规则等。
  • Performance 性能。内存泄漏，xml结构冗余等。
  • Correctness 正确性。超版本调用API，设置不正确的属性值等。
  • Accessibility 无障碍。单词拼写错误等。
  • Internationalization国际化。字符串缺少翻译等。

其他更多Issues,可以通将命令行切换到../Android/sdk/tools/bin目录下，然后输入lint --list。例如在Mac下：
cd /Users/gitcode8/Library/Android/sdk/tools/bin输入./lint --list
结果如下：

image

例如官网提供的参考例子:

<?xml version="1.0" encoding="UTF-8"?>
<lint>
    <!-- 忽略整个工程目录下指定问题的检查 -->
    <issue id="IconMissingDensityFolder" severity="ignore" />

    <!-- 忽略对指定文件指定问题的检查 -->
    <issue id="ObsoleteLayoutParam">
        <ignore path="res/layout/activation.xml" />
        <ignore path="res/layout-xlarge/activation.xml" />
    </issue>

    <!-- 更改检查问题归属的严重性  -->
    <issue id="HardcodedText" severity="error" />
</lint>

学习Lint工具仅仅是为了安抚我的强迫症？不，还不知道Lint真正用来干嘛呢？

检查项目质量

不好容易开发了个APP,准备开始上班摸鱼了。还让代码自查？那就通过Lint来看看代码质量如何吧。

1、Android Studio 检查

  1. 通过Android Studio 的菜单栏Analyze选项下拉选择第一个选项Inspect Code.
image

2、在弹出框根据自己需要选择lint工具的检查范围，这里选择整个项目。检查时间也是根据项目大小来定的。

image

3、等待一段时间后，会列出检查结果。从下图看到，不仅会检查Android存在的问题，也会检查Java等其他问题。通过单击问题，可以从右边提示框看到问题发生的地方和相关建议。

image

到这里，就开始对项目修修补补吧。

自定义规则

为什么要自定义呢？已有规则不符合自己或团队开发需求，或者觉得Lint存在一些缺陷。在网上大多数文章千篇一律，都是通过将Log打印来举例，看着都好累哦。由于没有相关官方文档和第三方教程（可能由于lint的api更新太快，没人愿意做这种吃力不讨好的工作），也这就只有这样了。本文通过自定义命名规范规则来讲解整个过程。

Lint中重点的API

先学习相关api，可以快速理解一些概念，可以粗略看过，下结实践再回来看。

1、Issue

Issue如上文所说，表示lint 工具检查的一个规则，一个规则包含若干问题。常在Detector中创建。下文是创建一个Issue的例子。

   private  static final Issue ISSUE = Issue.create("NamingConventionWarning",
            "命名规范错误",
            "使用驼峰命名法，方法命名开头小写，类大写字母开头",
            Category.USABILITY,
            5,
            Severity.WARNING,
            new Implementation(NamingConventionDetecor.class,
                    EnumSet.of(Scope.JAVA_FILE)));
  • 第一个参数id 唯一的id,简要表面当前提示的问题。
  • 第二个参数briefDescription 简单描述当前问题
  • 第三个参数explanation 详细解释当前问题和修复建议
  • 第四个参数category 问题类别，例如上文讲到的Security、Usability等等。
  • 第五个参数priority 优先级，从1到10，10最重要
  • 第六个参数Severity 严重程度：FATAL（奔溃）, ERROR（错误）, WARNING（警告）,INFORMATIONAL（信息性）,IGNORE（可忽略）
  • 第七个参数Implementation Issue和哪个Detector绑定，以及声明检查的范围。Scope有如下选择范围：
    RESOURCE_FILE（资源文件),BINARY_RESOURCE_FILE（二进制资源文件）,RESOURCE_FOLDER（资源文件夹）,ALL_RESOURCE_FILES（所有资源文件）,JAVA_FILE（Java文件）, ALL_JAVA_FILES（所有Java文件）,CLASS_FILE（class文件）, ALL_CLASS_FILES（所有class文件）,MANIFEST（配置清单文件）, PROGUARD_FILE（混淆文件）,JAVA_LIBRARIES（Java库）, GRADLE_FILE（Gradle文件）,PROPERTY_FILE(属性文件),TEST_SOURCES（测试资源）,OTHER(其他);

这样就能很清楚的定义一个规则，上文只定义了检查命名规范的规则。

2、IssueRegistry

用于注册要检查的Issue(规则)，只有注册了Issue,该Issue才能被使用。例如注册上文的命名规范规则。

public class Register extends IssueRegistry {
    @NotNull
    @Override
    public List<Issue> getIssues() {
        return Arrays.asList(NamingConventionDetector.ISSUE);
    }
}

4、Detector

查找指定的Issue，一个Issue对应一个Detector。自定义Lint 规则的过程也就是重写Detector类相关方法的过程。具体看下小结实践。

5、Scanner

扫描并发现代码中的Issue,Detector需要实现Scaner,可以继承一个到多个。

  • UastScanner 扫描Java文件和Kotlin文件
  • ClassScanner 扫描Class文件
  • XmlScanner 扫描Xml文件
  • ResourceFolderScanner 扫描资源文件夹
  • BinaryResourceScanner 扫描二进制资源文件
  • OtherFileScanner 扫描其他文件
  • GradleScanner 扫描Gradle脚本

旧版本的JavaScanner、JavaPsiScanner随着版本的更新已经被UastScanner替代了。

自定义Lint规则实践

通过实现命名规范Issue来熟悉和运用上小节相关的api。自定义规则需要在Java工程中创建，这里通过Android Studio来创建一个Java Library。

步骤：File->New->New Mudle->Java Library

这里Library Name为lib。

定义类NamingConventionDetector,并继承自Detector。因为这里是检测Java文件类名和方法是否符合规则，所以实现Detector.UastScanner接口。

public class NamingConventionDetector 
    extends Detector 
    implements Detector.UastScanner {
}

在NamingConventionDetector类内定义上文的Issue：

public class NamingConventionDetector 
    extends Detector 
    implements Detector.UastScanner {
    
    public static final Issue ISSUE = Issue.create("NamingConventionWarning",
        "命名规范错误",
        "使用驼峰命名法，方法命名开头小写",
        Category.USABILITY,
        5,
        Severity.WARNING,
        new Implementation(NamingConventionDetector.class,
            EnumSet.of(Scope.JAVA_FILE)));
}

重写Detector的createUastHandler方法，实现我们自己的处理类。

public class NamingConventionDetector extends Detector implements Detector.UastScanner {
    //定义命名规范规则
    public static final Issue ISSUE = Issue.create("NamingConventionWarning",
            "命名规范错误",
            "使用驼峰命名法，方法命名开头小写",
            Category.USABILITY,
            5,
            Severity.WARNING,
            new Implementation(NamingConventionDetector.class,
                    EnumSet.of(Scope.JAVA_FILE)));

    //返回我们所有感兴趣的类，即返回的类都被会检查
    @Nullable
    @Override
    public List<Class<? extends UElement>> getApplicableUastTypes() {
        return Collections.<Class<? extends UElement>>singletonList(UClass.class);
    }

    //重写该方法，创建自己的处理器
    @Nullable
    @Override
    public UElementHandler createUastHandler(@NotNull final JavaContext context) {
        return new UElementHandler() {
            @Override
            public void visitClass(@NotNull UClass node) {
                node.accept(new NamingConventionVisitor(context, node));
            }
        };
    }
    //定义一个继承自AbstractUastVisitor的访问器，用来处理感兴趣的问题
    public static class NamingConventionVisitor extends AbstractUastVisitor {

        JavaContext context;

        UClass uClass;

        public NamingConventionVisitor(JavaContext context, UClass uClass) {
            this.context = context;
            this.uClass = uClass;
        }

        @Override
        public boolean visitClass(@org.jetbrains.annotations.NotNull UClass node) {
            //获取当前类名
            char beginChar = node.getName().charAt(0);
            int code = beginChar;
            //如果类名不是大写字母，则触碰Issue，lint工具提示问题
            if (97 < code && code < 122) {
                context.report(ISSUE,context.getNameLocation(node),
                        "the  name of class must start with uppercase:" + node.getName());
                //返回true表示触碰规则，lint提示该问题；false则不触碰
                return true;
            }

            return super.visitClass(node);
        }

        @Override
        public boolean visitMethod(@NotNull UMethod node) {
            //当前方法不是构造方法
            if (!node.isConstructor()) {
            char beginChar = node.getName().charAt(0);
            int code = beginChar;
                //当前方法首字母是大写字母，则报Issue
                if (65 < code && code < 90) {
                    context.report(ISSUE, context.getLocation(node),
                            "the method must start with lowercase:" + node.getName());
                    //返回true表示触碰规则，lint提示该问题；false则不触碰
                    return true;
                }
            }
            return super.visitMethod(node);

        }

    }
}

上文NamingConventionDetector类，已经是全部代码，只检查类名和方法名是否符合驼峰命名法，可以根据具体需求,重写抽象类AbstractUastVisitor的visitXXX方法。

如果处理特定的方法或者其他，也可以使用默认的处理器。重写Scanner相关方法。例如：

 @Override
public List<String> getApplicableMethodNames() {
    return Arrays.asList("e","v");
}

表示e(),v()方法会被检测到，并调用visitMethod()方法，实现自己的逻辑。

    @Override
    public void visitMethod JavaContext context,  JavaElementVisitor visitor,  PsiMethodCallExpression call, PsiMethod method) {
        //todo something
        super.visitMethod(context, visitor, call, method);
    }

接下来就是注册自定义的Issue:

public class Register extends IssueRegistry {
    @NotNull
    @Override
    public List<Issue> getIssues() {
        return Arrays.asList(NamingConventionDetector.ISSUE);
    }
}

在lib项目的build.gradle文件添加相关代码：

apply plugin: 'java-library'

dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar'])
    implementation 'com.android.tools.lint:lint-api:26.4.2'
    implementation 'com.android.tools.lint:lint-checks:26.4.2'

}
//添加如下代码
jar {
    manifest {
        attributes 'Lint-Registry': 'com.gitcode.lib.Register'
    }
}

sourceCompatibility = "7"
targetCompatibility = "7"

到这里就自定义Lint自定义规则就搞定了，接着是使用和确定规则是否正确。

使用自定Lint规则

使用自定义Lint规则有两种形式：jar包和AAR文件。

jar形式使用

在Android Studio的Terminal输入下面命令：

./gradlew lib:assemble

看到BUILD SUCCESSFUL则表示生成jar包成功，可以在下面路径找到：

lib->build->libs

如图：

image

将lib.jar拷贝下面目录：

~/.android/lint/

如果lint文件夹不存在，则创建。通过命令行输入lint --list。滑到最后可以看到配置的规则，如图：

image

重启Android Studio,让规则生效。
检测到方法大写，不符合命名规范，报导该问题。


image

类名不符合规范：

image

从上文可以看到，放在目录下的jar包对所有工程都是有效的。如果要针对单个工程，那么就需要需要AAR形式了。

AAR形式

在同个工程新建一个Android Library，名为lintLibrary，修改相关配置。

1、修改Java工程的依赖

修改自定义lint规则的Java库的build.gradle（这里是上文的Java lib库），注意到要将implementation改为compileOnly。

apply plugin: 'java-library'

dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar'])
    //将implementation改为compileOnly，不然报错
    compileOnly 'com.android.tools.lint:lint-api:26.4.2'
    compileOnly 'com.android.tools.lint:lint-checks:26.4.2'

}

jar {
    manifest {
        attributes 'Lint-Registry-v2': 'com.gitcode.lib.Register'
    }
}

sourceCompatibility = "7"
targetCompatibility = "7"
2、修改Android Library依赖

Android Library主要用来输出AAR文件，要注意到Android Studio新特性的变更（在这里踩了大坑）。

dependencies {
    ......
    
    lintPublish project(':lib')
}

在Android Studio 3.4+，lintChecks project(':lib')：lint检查只在当前工程生效，也就是Android Library,并不会打包到AAR文件中。lintPublish project(':lib')才会将lint检查包含AAR文件中。

3、输出AAR文件

此时跟输出普通的AAR文件没什么区别，但为了手把手教会第一个自定义Issue，我写！

步骤：

菜单栏：View->Tool Windows->Gradle

此时Android Studio在右边会打开如下窗口：

image

根据上图操作，双击assemble,稍等一会，在控制台看BUILD SUCCESSFUL,则可在下面目录找到AAR文件。

lintLibrary->build->outputs->aar

这一小节的步骤也可以通过命令行执行。

4、使用AAR文件

有本地依赖或者上传远程仓库，这里只介绍本地依赖。将上小结生成的AAR文件拷贝在app的libs文件夹。并配置app组件的build.gradle

repositories {
    flatDir {
        dirs 'libs'
    }
}
dependencies {
    implementation (name:'lintlibrary-release', ext:'aar')
}

到这里，就能使用自定义的lint规则了，效果和上面使用jar包是一致的。如果不生效，重启Android Studio看看。

采坑记

1、Found more than one jar in the 'lintChecks' configuration. Only one file is supported

这是因为在输出AAR文件中，参考其他人的文章。没有将Java Library的依赖改为compileOnly。而且Android Library中使用lintChecks。

2、输出AAR文件没有生效

不知道为什么，Linkedin的参考文章没有生效,可能是Android Studio版本的问题。

另外使用lintChecks输出AAR不生效，Android Studio 3.4+新特性变更，采用lintPublish。

总结

花了好长好长的时间写本文，差点就放弃了。因为自己Android Studio看不了lint的源码，只能从网上找，网上又找不到最新的doc。过滤太多雷同文章，差点想哭，一些最新的文章也跟不上相关技术的更新。。。

但是一切都值得，因为能帮助到想学习Android Studio lint工具的同学，一起向往美好的生活。

GitHub

点个赞行不

写此文找到的一些具有参考意义的文章：

Android 官方指导

Linkedin 指导

美团->Android自定义Lint实践

lint-custom-rules

另外：本文没有demo，demo的代码已经贴在文章里了。

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 212,542评论 6赞 493
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 90,596评论 3赞 385
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 158,021评论 0赞 348
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 56,682评论 1赞 284
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 65,792评论 6赞 386
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 49,985评论 1赞 291
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 39,107评论 3赞 410
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 37,845评论 0赞 268
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 44,299评论 1赞 303
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,612评论 2赞 327
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,747评论 1赞 341
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 34,441评论 4赞 333
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 40,072评论 3赞 317
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,828评论 0赞 21
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,069评论 1赞 267
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 46,545评论 2赞 362
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 43,658评论 2赞 350