概述

lint是代碼風(fēng)格和語(yǔ)法規(guī)則的檢查工具,不限于android平臺(tái),其他例如jslint,eslint..
在最新的穩(wěn)定版本中,官方提供了342個(gè)定義好的lint規(guī)則,基本滿足開(kāi)發(fā)中的需要,基本介紹和使用方法參照官方教程

此外我們還需要某些特殊的場(chǎng)景下的檢查,例如 序列化的內(nèi)部類(lèi)也需要序列化,如果沒(méi)有序列化,我們要給出相應(yīng)的提示

image

Demo地址

https://github.com/ukyo6/cuslint

下面介紹自定義lint的基本配置

Lint parser

Lint從第一個(gè)版本就選擇了lombok-ast作為自己的AST Parser，并且用了很久。但是Java語(yǔ)言本身在不斷更新，Android也在不斷迭代出新涵紊，lombok-ast慢慢跟不上發(fā)展，所以Lint在25.2.0版增加了IntelliJ的PSI（Program Structure Interface）作為新的AST Parser。但是PSI于IntelliJ峰鄙、于Lint也只是個(gè)過(guò)渡性方案，事實(shí)上IntelliJ早已開(kāi)始了新一代AST Parser太雨，UAST（Unified AST）的開(kāi)發(fā)吟榴，而Lint也將于即將發(fā)布的25.4.0版中將PSI更新為UAST。

更多的介紹請(qǐng)參考這篇博客LintParser具體介紹, 簡(jiǎn)單的說(shuō)從lambok->PSI->UAST,官方一直在優(yōu)化lint的執(zhí)行效率和擴(kuò)展性,本文使用的是Lint26.2.0版本

配置

1. 創(chuàng)建java-library

在項(xiàng)目中新建java library, 添加最新穩(wěn)定版lint依賴26.2.0

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

2. 實(shí)現(xiàn)自定義的detector

detector是lint的核心, 每個(gè)規(guī)則都先繼承抽象類(lèi) Detector囊扳，然后實(shí)現(xiàn)Detector.Scanner接口,詳細(xì)的步驟會(huì)在接下來(lái)說(shuō)明

3. 創(chuàng)建自定義的IssueRegistry, 在app中使用該Registry

繼承IssueRegistry,添加自定義的detector

public class IssuesRegister extends IssueRegistry {
    @NotNull
    @Override
    public List<Issue> getIssues() {
        return new ArrayList<Issue>() {{
            //添加自定義的Detector
            add(SelfLogDetector.ISSUE);  
            add(NewThreadDetector.ISSUE);
            add(MessageObtainDetector.ISSUE);
            add(ViewIdCorrectnessDetector.ISSUE);
            add(LayoutNameDetector.ACTIVITY_LAYOUT_NAME_ISSUE);
            add(LayoutNameDetector.FRAGMENT_LAYOUT_NAME_ISSUE);
        }};
    }
}

在java moudle的build.gradle中聲明自定義的IssueRegistry
``
jar {
manifest {
attributes("Lint-Registry-v2": "com.lintrules.IssuesRegister")
}
}

app中引入自定義的lint

• Gradle Plugin3.0之前,用的是包裝aar的方式引入自定義的lint, 參照 linkedIn方案

• 3.0后增加 lintChecks, 無(wú)需再使用包裝aar的方式

  New lintChecks dependency configuration allows you to build a JAR that defines custom lint rules, and package it into your AAR and APK projects. Your custom lint rules must belong to a separate project that outputs a single JAR and includes only compileOnly dependencies. Other app and library modules can then depend on your lint project using the lintChecks configuration:

  我們可以直接在項(xiàng)目的build.gradle里添加

  dependencies {
      lintChecks project(':lintrules') //這里添加java library
  }
  

實(shí)現(xiàn)Detector

detector是lint的核心,主要分為下面幾步

1. 每個(gè)規(guī)則都先繼承抽象類(lèi)Detector吩翻，然后實(shí)現(xiàn)Detector.Scanner接口
2. 定義ISSUE的內(nèi)容,嚴(yán)重級(jí)別,提示信息,提示位置
3. 實(shí)現(xiàn)getApplicableXX和visitXX方法; 在getApplicableXX中定義檢查的域,visitXX中定義檢查的規(guī)則
4. 調(diào)用JavaContext.reportIssue()提示異常

1.實(shí)現(xiàn)Scanner接口

Scanner包括以下幾種

• SourceCodeScanner 掃描 Java 或符合JVM規(guī)范的源碼文件（如 kotlin）
• ClassScanner 掃描編譯后的 class 文件
• BinaryResourceScanner 掃描二進(jìn)制資源文件（如.png）
• ResourceFloderScanner 掃描資源目錄
• XmlScanner 掃描 xml 文件
• GradleScanner 掃描 Gradle 文件
• OtherFileScanner 掃描其他文件

每個(gè)Scanner都實(shí)現(xiàn)了很多getApplicableXX和visitXX方法,這些方法都是成對(duì)使用的

2.定義ISSUE

ISSUE在每個(gè)Detector中定義兜看，lint檢查到相關(guān)項(xiàng)將ISSUE報(bào)告出來(lái)，示例：

public static final Issue ISSUE = Issue.create(
    "InnerClassSerializable", //問(wèn)題 Id
    "內(nèi)部類(lèi)需要實(shí)現(xiàn)Serializable接口", //問(wèn)題的簡(jiǎn)單描述
    "內(nèi)部類(lèi)需要實(shí)現(xiàn)Serializable接口",//問(wèn)題的詳細(xì)描述
    Category.SECURITY, //問(wèn)題類(lèi)型  
    5, // 0-10嚴(yán)重級(jí)別
    Severity.ERROR, //問(wèn)題嚴(yán)重程度
    new Implementation(SerializableDetector.class,
    Scope.JAVA_FILE_SCOPE); //Detector 和 Scope 的對(duì)應(yīng)關(guān)系

3.實(shí)現(xiàn)getApplicableXX和visitXX方法方法

• 例如實(shí)現(xiàn)SourceCodeScanner接口,我們applicableSuperClasses()中指定需要檢查的父類(lèi)名列表,visitClass()當(dāng)檢測(cè)到你指定的父類(lèi)名列表時(shí),就會(huì)進(jìn)入該方法, 根據(jù)參數(shù)JavaContext, Uclass可以很方便的獲取Class的繼承關(guān)系,名字等信息

    @Nullable
    @Override
    public List<String> applicableSuperClasses() {
        //指定檢查"java.io.Serializable"
        return Collections.singletonList(CLASS_SERIALIZABLE);
    }

    /**
     * 掃描到applicableSuperClasses()指定的list時(shí),回調(diào)該方法
     */
    @Override
    public void visitClass(JavaContext context, UClass declaration) {
        //只從最外部開(kāi)始向內(nèi)部類(lèi)遞歸檢查
        if (declaration instanceof UAnonymousClass) {
            return;
        }
        sortClass(context, declaration);
    }

• 再比如XmlScanner, 可以利用getApplicableElements()和visitElement()方法來(lái)進(jìn)行xml中節(jié)點(diǎn)的掃描

@Override
    public Collection<String> getApplicableElements() {
        return Arrays.asList( //指定檢查這幾個(gè)控件的命名規(guī)范,可自行擴(kuò)展
                TEXT_VIEW,
                IMAGE_VIEW,
                BUTTON,
                EDIT_TEXT,
                CHECK_BOX
        );
    }
    
    /**
     * 掃描到getApplicableElements()指定的xml節(jié)點(diǎn)時(shí),回調(diào)該方法
     */
    @Override
    public void visitElement(XmlContext context, Element element) {
        //這個(gè)detector只掃描android:id屬性,其他屬性跳過(guò)
        if (!element.hasAttributeNS(ANDROID_URI, ATTR_ID)) return;

        Attr attr = element.getAttributeNodeNS(ANDROID_URI, ATTR_ID);
        String value = attr.getValue();
        if (value.startsWith(NEW_ID_PREFIX)) {
        ....
        }
    }

4.報(bào)告ISSUE

在需要報(bào)告ISSUE的地方調(diào)用context.report()

context.report(ISSUE, //定義好的ISSUE
            uClass.getNameIdentifier(), //ISSUE對(duì)應(yīng)的AST節(jié)點(diǎn)
            context.getLocation(uClass.getNameIdentifier()), //ISSUE提示的位置
            String.format("內(nèi)部類(lèi) `%1$s` 需要實(shí)現(xiàn)Serializable接口", uClass.getName())); //ISSUE的描述

使用

除了在代碼中的靜態(tài)waring,error提示,還可以輸出報(bào)告來(lái)查看
輸入 gradlew 工程名:lintDebug 可以在build/reports目錄下查看lint報(bào)告,demo中檢測(cè)到的問(wèn)題

image

也可以查看詳細(xì)的信息

image

lint調(diào)試

開(kāi)發(fā)完自定義lint規(guī)則后,可能需要對(duì)代碼進(jìn)行驗(yàn)證,調(diào)試方式如下

• 在自定義的lint代碼中打好斷點(diǎn)

• 選擇 Run -> Eidt Configurations, 在Android Studio的運(yùn)行參數(shù)(Run Configurations)中添加一個(gè)Remote類(lèi)型狭瞎，都取默認(rèn)值即可(端口號(hào)5005)

  
  
  image

• 在Teminal窗口中輸入gradlew lintDebug -Dorg.gradle.daemon=false -Dorg.gradle.debug=true

  
  
  image
• 選擇剛才配置的remote參數(shù),點(diǎn)擊debug的console看到以下輸出: Connected to the target VM, address: 'localhost:5005', transport: 'socket' 就可以進(jìn)行調(diào)試了

Lint構(gòu)建優(yōu)化

隨著官方lint-checks的更新,detector的數(shù)量越來(lái)越多,構(gòu)建一次linttask的速度肯定是很慢的(即使每個(gè)detector指定了scope,都需要掃描項(xiàng)目?jī)?nèi)所有該scope的文件...)
lint的開(kāi)發(fā)者也在google論壇上給出了lint構(gòu)建的建議 Lint Performance Tips,大概是以下幾點(diǎn):

• 使用graldew lintDebug, gradlew lintRelease代替gradlew lint, 因?yàn)楹笳邥?huì)執(zhí)行l(wèi)int lintDebug lintRelease,造成成倍的開(kāi)銷(xiāo)
• 使用gradlew 模塊名:lintDebug可以檢查指定的模塊
• lintOptions配置checkTestSources和ignoreTestSources
• 不要使用checkAllWarnings,因?yàn)橛幸恍﹍int檢查,特別是id為“WrongThreadInterprocedural”的,非常慢

參考資料

• 官方教程
• 從lombok到UAST – 淺談Android Lint的AST Parser
• Android ------ 美團(tuán)的Lint代碼檢查實(shí)踐
• GoogleSample
• Google論壇Lint-dev