背景

2017年8月份的時候，我在公司開始推廣Lint、FindBugs等靜態代碼檢測工具。然后發現系統自帶的Lint檢測的Issue不滿足我們團隊內部的特定需求，因此去自定義了部分Lint規則。這個檢測運行了大半年，運行良好，團隊的代碼規范也有了大幅度提升。這個是基于當時Gradle2.x系列寫出來的自定義Lint實踐總結，過去大半年了，現在將它搬到CSDN博客分享給大家一起學習學習。如果要在Gradle3.x系列使用該自定義規定的話，部分代碼都得修改成最新的語法，因此此篇博客的內容請使用Gralde2.x系列編譯項目中可以加入，去定義你自己的Lint規則吧。

當時已經實現的自定義規則大概有：

這里寫圖片描述

我這里只介紹如何去實現你自己的Lint規則，具體源代碼的話不方便貼出了，所以不會去公布源代碼。

一、Lint介紹

android lint是一個靜態代碼分析工具，通過lint工具，你可以不用邊運行邊調試，或者通過單元測試進行代碼檢查，可以檢測代碼中不規范、不和要求的問題，解決一些潛在的bug。lint工具可以在命令行上使用，也可以在adt中使用。

比如當想檢查在manifest.xml中是否有activity，activity中是否包含了launcher activity。如果沒有進行錯誤的警告。

通過lint的這種手段，可以對代碼進行規范的控制，畢竟一個團隊每個人的風格不同，但是要注意的當然是代碼的質量，所以lint可以進行代碼的規范和質量控制。

在Android studio還沒出來時，lint和Eclipse并不能很好的結合在一起，只能作為一個獨立的工具，通過命令行去執行lint檢查。

在android studio出現之后，不再建議單獨使用lint命令，而是結合gradle進行操作，命令為* ./gradlew lint *進行執行

lint工具通過一下六個方面去檢查代碼中的問題correctness, security, performance, usability, accessibility, and internationalization。檢查的范圍包括java文件，xml文件，class文件。

lint工具在sdk16版本之后就帶有了，所以在sdk目錄/tools/可以找到lint工具。現在建議與gradle一起使用，使用./gradlew lint進行

參考官方文檔介紹

二、使用Lint的方法

關于lint的一些命令，可以參考官網，這里簡單介紹一些。

lint path(項目目錄) ——進行項目的lint檢查
lint –disable id(MissingTranslation,UnusedIds,Usability:Icons)path ——id是lint issue(問題)的標志，檢查項目，不包括指定的issue
lint –check id path ——利用指定的issue進行項目檢查
lint –list ——列出所有的issue
lint –show id ——介紹指定的issue
lint –help ——查看幫助

2.1 使用android studio自帶的lint工具

點擊Analyze的Inspect Code選項，即可開啟lint檢查，在Inspection窗口中可以看到lint檢查的結果，lint查詢的錯誤類型包括：

Missing Translation and Unused Translation【缺少翻譯或者沒有】
Layout Peformance problems (all the issues the old layoutopt tool used to find, and more)【布局展示問題】
Unused resources【沒有使用的資源】
Inconsistent array sizes (when arrays are defined in multiple configurations)【不一致的數組大小】
Accessibility and internationalization problems (hardcoded strings, missing contentDescription, etc)【可訪問性和國際化問題，包括硬鏈接的字符串，缺少contentDescription，等等】
Icon problems (like missing densities, duplicate icons, wrong sizes, etc)【圖片問題，丟失密度，重復圖片，錯誤尺寸等】
Usability problems (like not specifying an input type on a text field)【使用規范，比如沒有在一個文本上指定輸入的類型】
Manifest errors【Manifest.xml中的錯誤】
and so on

android自帶的lint規則的更改可以在Setting的Edit選項下選擇Inspections（File > Settings > Project Settings），對已有的lint規則進行自定義選擇。
參考官方文檔

2.2 使用lint.xml定義檢查規則

可以通過lint.xml來自定義檢查規則，這里的自定義是指定義系統原有的操作，所以和第一個步驟的結果是一樣的，只是可以更方便的配置。

lint.xml生效的位置是要放在項目的根目錄下面，lint.xml的示例如下：

<?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檢查規則結構介紹

3.1 概述

Android Lint是Google提供給Android開發者的靜態代碼檢查工具。使用Lint對Android工程代碼進行掃描和檢查，可以發現代碼潛在的問題，提醒程序員及早修正。

為保證代碼質量，在開發流程中加入了代碼檢查，如果代碼檢測到問題，則無法合并到正式分支中，這些檢查中就包括Lint。

3.2 為什么需要自定義

我們在實際使用Lint中遇到了以下問題：

原生Lint無法滿足我們團隊特有的需求，例如：編碼規范。
原生Lint存在一些檢測缺陷或者缺少一些我們認為有必要的檢測。
基于上面的考慮，我們開始調研并開發自定義Lint。

3.3 如何加入已有的lint規則

Lint規則是基于Java寫的，是在AST抽象語法樹上去進行一個解析。所以在寫Lint規則的時候，要學習一下AST抽象語法樹。才知道如何去尋找一個類方法和其參數等。以下有兩種方法：

所以自定義Lint規則應該是一個寫好的jar包，jar包生效的位置是在~/.android/lint目錄，這個是對于Mac和Linux來說的，對于Windows來說就是在C:/Users/Administrator/.android/lint下，放到這個目錄下，Lint工具會自動加載這個jar包作為lint的自定義檢查規則。
放到lint目錄下著實是一件比較麻煩的事情，即使可以用腳本來代替，但是仍然不是一個特別方便的方法。也是由于當android項目直接依賴于lint.jar包時不能起作用，而無法進行直接依賴。
而aar很好的解決了這個問題，aar能夠將項目中的資源、class文件、jar文件等都包含，所以通過將lint.jar放入lintaar中，再由項目依賴于lintaar，這時候就可以達到自定義lint檢查的目的。

下面就是如何使自定義lint生效的代碼示例，使用第二個方法（第二個方法就包括了第一個方法）：

這里寫圖片描述

主要包括了三個Module一個是XTCLintrRules，一個是XTCLintAAR，一個是XTCLintPlugin，還有一個是測試的app項目。

XTCLintrRules ，主要是用來編寫自定義Lint規則，編譯后生成 lint.jar
XTCLintAAR，主要是將XTCLintrRules生成的lint.jar包大包成aar，方便引用
XTCLintPlugin，主要是后面統一管理lint.xml和lintOptions，自動添加aar，后面再講解。

3.3.1 XTCLintrRules的 gradle配置

在XTCLintrRules中，主要是編寫lint規則,他是一個Java工程。

它的gradle如下：

//java項目，該項目編譯之后生成  XTCLintRules.jarapply plugin: 'java'dependencies {compile fileTree(dir: 'libs', include: ['*.jar'])// 依賴于lint的規則的apicompile 'com.android.tools.lint:lint-api:25.0.0'compile 'com.android.tools.lint:lint-checks:25.0.0'testCompile 'com.android.tools.lint:lint-tests:24.5.0'
}/*** Lint-Registry是透露給lint工具的注冊類的方法，* 也就是PermissionIssueRegistry是lint工具的入口,同時也通過這個方法進行打jar包*/
jar{manifest{attributes('Lint-Registry': 'com.xtc.lint.rules.XTCIssueRegister')}
}// 創建了一個叫“lintJarOutput”的Gradle configuration，
// 用于輸出我們生成的jar包。在生成aar的模塊 "XTCLintAAR" 的build.gradle中會引用此configuration。
configurations {lintJarOutput
}// 指定定義方法lintJarOutput的作用，此處是獲得調用jar方法后的生成的jar包
dependencies {lintJarOutput files(jar)
}defaultTasks 'assemble'//指定編譯使用JDK1.8
//sourceCompatibility = JavaVersion.VERSION_1_8
//targetCompatibility = JavaVersion.VERSION_1_8//指定編譯的編碼
tasks.withType(JavaCompile){options.encoding = "UTF-8"
}

lint-api: 官方給出的API，API并不是最終版，官方提醒隨時有可能會更改API接口。
lint-checks：已有的檢查。

3.3.2 XTCLintAAR的 gradle配置

apply plugin: 'com.android.library'apply from: 'maven_upload.gradle'
apply from: '../jenkins.gradle'android {compileSdkVersion 25buildToolsVersion "25.0.3"defaultConfig {minSdkVersion 9targetSdkVersion 25versionCode 1versionName "1.0"}buildTypes {debug {buildConfigField 'String', 'JenkinsName', "\"" + jenkinsName + "\""buildConfigField 'String', 'JenkinsRevision', "\"" + jenkinsRevision + "\""buildConfigField 'String', 'GitSHA', "\"" + gitSHA  + "\""buildConfigField 'String', 'GitBranch', "\"" + gitBranch + "\""buildConfigField 'String', 'GitTag', "\"" + gitTag + "\""minifyEnabled falseproguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'}release {buildConfigField 'String', 'JenkinsName', "\"" + jenkinsName + "\""buildConfigField 'String', 'JenkinsRevision', "\"" + jenkinsRevision + "\""buildConfigField 'String', 'GitSHA', "\"" + gitSHA  + "\""buildConfigField 'String', 'GitBranch', "\"" + gitBranch + "\""buildConfigField 'String', 'GitTag', "\"" + gitTag + "\""minifyEnabled falseproguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'}}
}dependencies {compile fileTree(dir: 'libs', include: ['*.jar'])
}/*** 定義方法lintJarImport,引入 XTCLintRules.jar** rules for including "lint.jar" in aar*/
configurations {lintJarImport
}// 鏈接到lintJar中的lintJarOutput方法,調用jar方法，并獲得jar包
dependencies {//其引用了模塊 “:XTCLintRules”的 Gradle configuration “lintJarOutput”。lintJarImport project(path: ':XTCLintrRules', configuration: "lintJarOutput")
}// 將得到的JAR包復制到目錄build/intermediates/lint/下，并且重命名為 lint.jar
task copyLintJar(type: Copy) {from(configurations.lintJarImport) {rename {String fileName ->'lint.jar'}}into 'build/intermediates/lint/'
}// 當項目build到compileLint這一步時執行copyLintJar方法
project.afterEvaluate {def compileLintTask = project.tasks.find { it.name == 'compileLint' }//對內置的Gradle task “compileLint”做了修改，讓其依賴于我們定義的一個task “copyLintJar”。compileLintTask.dependsOn(copyLintJar)
}

該Module的作用就是：

鏈接到lintJar中的lintJarOutput方法,調用jar方法，并獲得jar包
將得到的JAR包復制到目錄build/intermediates/lint/下，并且重命名為 lint.jar
當項目build到compileLint這一步時執行copyLintJar方法，這樣的話就可以調用到我們自定義的Lint規則
生成AAR方便項目調用

3.3.3 XTCLintPlugin介紹

關于 XTCLintPlugin 的介紹，等我們先將自定義規則講解完后再介紹，這里先不介紹。

四、自定義lint檢查規則的編寫

上面大致講解了下 XTCLintrRules和XTCLintAAR兩個Module的gradle配置和作用，下面我們來針對XTCLintrRules這個Module來編寫我們自定義的Lint檢查規則

這里寫圖片描述

4.1 創建 Detector

Detector負責掃描代碼，發現問題并報告。我們通過一個 XTCCustomLogDetector 這個類來學習下 Detector怎么實現，

XTCCustomLogDetector 類主要功能是：針對代碼中直接使用android.util.Log的方法 { v,d,i,w,e,wtf }或者直接使用了 System.out.print/System.err.print進行日志打印的一個判斷，然后提示各位開發人員使用我們自定義好的com.xtc.log.LogUtil類進行日志打印。


package com.xtc.lint.rules.detectors.java;import com.android.tools.lint.client.api.JavaParser;
import com.android.tools.lint.detector.api.Category;
import com.android.tools.lint.detector.api.Detector;
import com.android.tools.lint.detector.api.Implementation;
import com.android.tools.lint.detector.api.Issue;
import com.android.tools.lint.detector.api.JavaContext;
import com.android.tools.lint.detector.api.Scope;
import com.android.tools.lint.detector.api.Severity;
import com.xtc.lint.rules.JavaPackageRelativePersonUtil;import java.util.Arrays;
import java.util.Collections;
import java.util.EnumSet;
import java.util.List;import lombok.ast.AstVisitor;
import lombok.ast.ForwardingAstVisitor;
import lombok.ast.MethodInvocation;
import lombok.ast.Node;
/*** 定義代碼檢查規則* 這個是針對代碼中直接使用android.util.Log的方法 { v,d,i,w,e,wtf } 進行日志打印的一個判斷* </p>* created by OuyangPeng at 2017/8/31 9:55*/
public class XTCCustomLogDetector extends Detector implements Detector.JavaScanner {private static final Class<? extends Detector> DETECTOR_CLASS = XTCCustomLogDetector.class;private static final EnumSet<Scope> DETECTOR_SCOPE = Scope.JAVA_FILE_SCOPE;private static final Implementation IMPLEMENTATION = new Implementation(DETECTOR_CLASS,DETECTOR_SCOPE);private static final String ISSUE_ID = "XTC_LogUseError";private static final String ISSUE_DESCRIPTION = "警告:你應該使用我們團隊自定義的Log打印工具類工具類{com.xtc.log.LogUtil}";private static final String ISSUE_EXPLANATION = "為了能夠更好的控制Log打印的開關，你不能直接使用{android.util.Log}或者{System.out.println}直接打印日志，你應該使用我們團隊自定義的Log打印工具類工具類{com.xtc.log.LogUtil}";private static final Category ISSUE_CATEGORY = Category.CORRECTNESS;private static final int ISSUE_PRIORITY = 9;private static final Severity ISSUE_SEVERITY = Severity.WARNING;private static final String SYSTEM_OUT_PRINT = "System.out.print";private static final String SYSTEM_OUT_PRINTLN = " System.out.println";private static final String SYSTEM_ERR_PRINT = "System.err.print";private static final String SYSTEM_ERR_PRINTLN = " System.err.println";private static final String CHECK_PACKAGE = "android.util.Log";public static final Issue ISSUE = Issue.create(ISSUE_ID,ISSUE_DESCRIPTION,ISSUE_EXPLANATION,ISSUE_CATEGORY,ISSUE_PRIORITY,ISSUE_SEVERITY,IMPLEMENTATION);@Overridepublic List<String> getApplicableMethodNames() {return Arrays.asList("v", "d", "i", "w", "e", "wtf");}@Overridepublic List<Class<? extends Node>> getApplicableNodeTypes() {return Collections.singletonList(MethodInvocation.class);}@Overridepublic AstVisitor createJavaVisitor(final JavaContext context) {return new LogVisit(context);}private class LogVisit extends ForwardingAstVisitor {private final JavaContext javaContext;private LogVisit(JavaContext context) {javaContext = context;}@Overridepublic boolean visitMethodInvocation(MethodInvocation node) {String nodeString = node.toString();if (nodeString.startsWith(SYSTEM_OUT_PRINT)|| nodeString.startsWith(SYSTEM_OUT_PRINTLN)|| nodeString.startsWith(SYSTEM_ERR_PRINT)|| nodeString.startsWith(SYSTEM_ERR_PRINTLN)) {String relativePersonName = JavaPackageRelativePersonUtil.getPackageRelativePerson(javaContext,node);
//                System.out.println("LogVisit visitMethodInvocation() 出現lint檢測項，對應的責任人為： " + relativePersonName);String message = ISSUE_DESCRIPTION + " ,請 【" + relativePersonName + "】速度修改";javaContext.report(ISSUE, node, javaContext.getLocation(node), message);return true;}JavaParser.ResolvedNode resolve = javaContext.resolve(node);if (resolve instanceof JavaParser.ResolvedMethod) {JavaParser.ResolvedMethod method = (JavaParser.ResolvedMethod) resolve;JavaParser.ResolvedClass containingClass = method.getContainingClass();if (resolve.getName().equals("v")||resolve.getName().equals("d")||resolve.getName().equals("i")||resolve.getName().equals("w")||resolve.getName().equals("e")||resolve.getName().equals("wtf")){
//                    System.out.println("XTCCustomLogDetector  called method  one of { v,d,i,w,e,wtf }");if (containingClass.matches(CHECK_PACKAGE)) {
//                      System.out.println("XTCCustomLogDetector  called method  one of { v,d,i,w,e,wtf } , and the className is : android.util.Log");String relativePersonName = JavaPackageRelativePersonUtil.getPackageRelativePerson(javaContext,node);
//                        System.out.println("LogVisit visitMethodInvocation() 出現lint檢測項，對應的責任人為： " + relativePersonName);String message = ISSUE_DESCRIPTION + " ,請 【" + relativePersonName + "】速度修改";javaContext.report(ISSUE, node, javaContext.getLocation(node),message);return true;}}}return super.visitMethodInvocation(node);}}
}

4.2 Detector介紹

可以看到這個Detector繼承Detector類，然后實現Scanner接口。

自定義Detector可以實現一個或多個Scanner接口,選擇實現哪種接口取決于你想要的掃描范圍

Detector.XmlScanner
Detector.JavaScanner
Detector.ClassScanner
Detector.BinaryResourceScanner
Detector.ResourceFolderScanner
Detector.GradleScanner
Detector.OtherFileScanner

這里寫圖片描述

這里因為我們是要針對Java代碼掃描，所以選擇使用JavaScanner。

這里寫圖片描述

代碼中getApplicableNodeTypes()方法決定了什么樣的類型能夠被檢測到。這里我們想看Log以及println的方法調用，選取MethodInvocation。

對應的，我們在createJavaVisitor()創建一個ForwardingAstVisitor通過visitMethodInvocation方法來接收被檢測到的Node。

可以看到getApplicableNodeTypes()返回值是一個List，也就是說可以同時檢測多種類型的節點來幫助精確定位到代碼，對應的ForwardingAstVisitor接受返回值進行邏輯判斷就可以了。

可以看到JavaScanner中還有其他很多方法，getApplicableMethodNames（指定方法名）、visitMethod（接收檢測到的方法），這種對于直接找尋方法名的場景會更方便。

當然這種場景我們用最基礎的方式也可以完成，只是比較繁瑣。

那么其他Scanner如何去寫呢？
可以去查看各接口中的方法去實現，一般都是有這兩種對應：什么樣的類型需要返回、接收發現的類型。

這里插一句，Lint是如何實現Java掃描分析的呢？Lint使用了Lombok做抽象語法樹的分析。所以在我們告訴它需要什么類型后，它就會把相應的Node返回給我們。

回到示例，當接收到返回的Node之后需要進行判斷，如果調用方法是android.util.Log的方法 { v,d,i,w,e,wtf }或者直接使用了 System.out.print/System.err.print，則調用context.report上報。

  javaContext.report(ISSUE, node, javaContext.getLocation(node), message);

第一個參數是Issue，這個之后會講到；
第二個參數是當前節點；
第三個參數location會返回當前的位置信息，便于在報告中顯示定位；
最后的字符串用來為警告添加解釋。

對應報告中的位置如下圖：

這里寫圖片描述

4.2.1 Issue介紹

Issue由Detector發現并報告，是Android程序代碼可能存在的bug。

private static final Implementation IMPLEMENTATION = new Implementation(DETECTOR_CLASS,DETECTOR_SCOPE);private static final String ISSUE_ID = "XTC_LogUseError";private static final String ISSUE_DESCRIPTION = "警告:你應該使用我們團隊自定義的Log打印工具類工具類{com.xtc.log.LogUtil}";private static final String ISSUE_EXPLANATION = "為了能夠更好的控制Log打印的開關，你不能直接使用{android.util.Log}或者{System.out.println}直接打印日志，你應該使用我們團隊自定義的Log打印工具類工具類{com.xtc.log.LogUtil}";private static final Category ISSUE_CATEGORY = Category.CORRECTNESS;private static final int ISSUE_PRIORITY = 9;private static final Severity ISSUE_SEVERITY = Severity.WARNING;public static final Issue ISSUE = Issue.create(ISSUE_ID,ISSUE_DESCRIPTION,ISSUE_EXPLANATION,ISSUE_CATEGORY,ISSUE_PRIORITY,ISSUE_SEVERITY,IMPLEMENTATION);

聲明為final class，由靜態工廠方法創建。對應參數解釋如下：

這里寫圖片描述

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.2.2 Issue與Lint HTML報告對應關系

對應著 id 和 summary
這里寫圖片描述

對應著 explanation 、category 、severity 、priority

這里寫圖片描述

4.2.2 Category詳述

系統現在已有的類別如下：

Lint
Correctness (incl. Messages)
Security
Performance
Usability (incl. Icons, Typography)
Accessibility
Internationalization
Icons
Typography
Messages

這里寫圖片描述

Category類的部分代碼

 /** Issues related to running lint itself */public static final Category LINT = create("Lint", 110);/** Issues related to correctness */public static final Category CORRECTNESS = create("Correctness", 100);/** Issues related to security */public static final Category SECURITY = create("Security", 90);/** Issues related to performance */public static final Category PERFORMANCE = create("Performance", 80);/** Issues related to usability */public static final Category USABILITY = create("Usability", 70);/** Issues related to accessibility */public static final Category A11Y = create("Accessibility", 60);/** Issues related to internationalization */public static final Category I18N = create("Internationalization", 50);// Sub categories/** Issues related to icons */public static final Category ICONS = create(USABILITY, "Icons", 73);/** Issues related to typography */public static final Category TYPOGRAPHY = create(USABILITY, "Typography", 76);/** Issues related to messages/strings */public static final Category MESSAGES = create(CORRECTNESS, "Messages", 95);/** Issues related to right to left and bidirectional text support */public static final Category RTL = create(I18N, "Bidirectional Text", 40);

4.2.3 自定義Category

public class XTCCategory {public static final Category NAMING_CONVENTION = Category.create("小天才命名規范", 101);
}

使用

public static final Issue ISSUE = Issue.create("IntentExtraKey","intent extra key 命名不規范","請在接受此參數中的Activity中定義一個按照EXTRA_<name>格式命名的常量",XTCCategory.NAMING_CONVENTION , 5, Severity.ERROR,new Implementation(IntentExtraKeyDetector.class, Scope.JAVA_FILE_SCOPE));

4.3 IssueRegistry

IssueRegistry就是注冊類，繼承他，并重寫getIssues的方法即可,提供需要被檢測的Issue列表

例如我們的項目工程中的XTCIssueRegister.java代碼如下


package com.xtc.lint.rules;import com.android.tools.lint.client.api.IssueRegistry;
import com.android.tools.lint.detector.api.Issue;
import com.xtc.lint.rules.detectors.binaryResource.XTCImageFileSizeDetector;
import com.xtc.lint.rules.detectors.java.XTCActivityFragmentLayoutNameDetector;
import com.xtc.lint.rules.detectors.java.XTCChineseStringDetector;
import com.xtc.lint.rules.detectors.java.XTCCustomLogDetector;
import com.xtc.lint.rules.detectors.java.XTCCloseDetector;
import com.xtc.lint.rules.detectors.java.XTCCustomToastDetector;
import com.xtc.lint.rules.detectors.java.XTCEnumDetector;
import com.xtc.lint.rules.detectors.java.XTCHardcodedValuesDetector;
import com.xtc.lint.rules.detectors.java.XTCHashMapForJDK7Detector;
import com.xtc.lint.rules.detectors.java.XTCMessageObtainDetector;
import com.xtc.lint.rules.detectors.java.XTCViewHolderItemNameDetector;
import com.xtc.lint.rules.detectors.xml.XTCViewIdNameDetector;import java.util.Arrays;
import java.util.List;public class XTCIssueRegister extends IssueRegistry {static {System.out.println("***************************************************");System.out.println("**************** lint 讀取配置文件 *****************");System.out.println("***************************************************");LoadPropertiesFile.loadPropertiesFile();}@Overridepublic List<Issue> getIssues() {System.out.println("***************************************************");System.out.println("**************** lint 開始靜態分析代碼 *****************");System.out.println("***************************************************");return Arrays.asList(XTCChineseStringDetector.ISSUE,XTCActivityFragmentLayoutNameDetector.ACTIVITY_LAYOUT_NAME_ISSUE,XTCActivityFragmentLayoutNameDetector.FRAGMENT_LAYOUT_NAME_ISSUE,XTCMessageObtainDetector.ISSUE,XTCCustomToastDetector.ISSUE,XTCCustomLogDetector.ISSUE,XTCViewIdNameDetector.ISSUE,XTCViewHolderItemNameDetector.ISSUE,XTCCloseDetector.ISSUE,XTCImageFileSizeDetector.ISSUE,XTCHashMapForJDK7Detector.ISSUE,XTCHardcodedValuesDetector.ISSUE,XTCEnumDetector.ISSUE);}
}

在getIssues()方法中返回需要被檢測的Issue List，我們剛才編寫的 XTCCustomLogDetector.ISSUE 也被注冊進去了。

在build.grade中聲明Lint-Registry屬性


/*** Lint-Registry是透露給lint工具的注冊類的方法，* 也就是PermissionIssueRegistry是lint工具的入口,同時也通過這個方法進行打jar包*/
jar{manifest{attributes('Lint-Registry': 'com.xtc.lint.rules.XTCIssueRegister')}
}

這里寫圖片描述

至此，自定義Lint的編碼部分就完成了。

五、為自定義Lint開發plugin

5.1 為自定義Lint開發plugin的目的

aar雖然很方便，但是在團隊內部推廣中我們遇到了以下問題：

配置繁瑣，不易推廣。每個庫都需要自行配置lint.xml、lintOptions，并且compile aar。
不易統一。各庫之間需要使用相同的配置，保證代碼質量。但現在手動來回拷貝規則，且配置文件可以自己修改。

于是我想到開發一個plugin，統一管理lint.xml和lintOptions，自動添加aar。下圖就是我們的工程XTCLintPlugin

這里寫圖片描述

編寫自定義插件需要實現 Plugin 接口，然后將插件的作用在apply(Project project)方法中實現即可。

這里寫圖片描述

class XTCLintPlugin implements Plugin<Project> {@Overridevoid apply(Project project) {applyTask(project, getAndroidVariants(project))}...
}

5.2 自定義Lint開發plugin需要實現的功能

5.2.1 統一lint.xml

我們在plugin中內置lint.xml，執行前拷貝過去，執行完成后刪除。

//==========================  統一  lint.xml  開始=============================================////lint任務執行前，先復制lint.xmllintTask.doFirst {//如果 lint.xml 存在，則改名為 lintOld.xmlif (lintFile.exists()) {lintOldFile = project.file("lintOld.xml")lintFile.renameTo(lintOldFile)}//進行 將plugin內置的lint.xml文件和項目下面的lint.xml進行復制合并操作def isLintXmlReady = copyLintXml(project, lintFile)//合并完畢后，將lintOld.xml 文件改名為 lint.xmlif (!isLintXmlReady) {if (lintOldFile != null) {lintOldFile.renameTo(lintFile)}throw new GradleException("lint.xml不存在")}}//lint任務執行后，刪除lint.xmlproject.gradle.taskGraph.afterTask { task, TaskState state ->if (task == lintTask) {lintFile.delete()if (lintOldFile != null) {lintOldFile.renameTo(lintFile)}}}//==========================  統一  lint.xml  結束=============================================//

這里寫圖片描述

5.2.2 統一lintOptions

Android plugin在1.3以后允許我們替換Lint Task的lintOptions


//==========================  統一  lintOptions  開始=============================================///*lintOptions {lintConfig file("lint.xml")warningsAsErrors trueabortOnError truehtmlReport truehtmlOutput file("lint-report/lint-report.html")xmlReport false}*/def newLintOptions = new LintOptions()//配置lintConfig的配置文件路徑newLintOptions.lintConfig = lintFile//是否將所有的warnings視為errors
//            newLintOptions.warningsAsErrors = true//是否lint檢測出錯則停止編譯newLintOptions.abortOnError = true//htmlReport打開newLintOptions.htmlReport = truenewLintOptions.htmlOutput = project.file("${project.buildDir}/reports/lint/lint-result.html")//xmlReport打開 因為Jenkins上的插件需要xml文件newLintOptions.xmlReport = truenewLintOptions.xmlOutput = project.file("${project.buildDir}/reports/lint/lint-result.xml")//配置 lint任務的配置為  newLintOptionslintTask.lintOptions = newLintOptions//==========================  統一  lintOptions  結束=============================================//

這里寫圖片描述

5.2.3 自動添加最新aar

   //========================== 統一  自動添加AAR  開始=============================================////配置project的dependencies配置，默認都自動加上 自定義lint檢測的AAR包project.dependencies {//如果是android application項目if (project.getPlugins().hasPlugin('com.android.application')) {compile('com.xtc.lint:lint-check:1.1.1') {force = true}} else {provided('com.xtc.lint:lint-check:1.1.1') {force = true}}}//去除gradle緩存的配置project.configurations.all {resolutionStrategy.cacheChangingModulesFor 0, 'seconds'resolutionStrategy.cacheDynamicVersionsFor 0, 'seconds'}//========================== 統一  自動添加AAR  結束=============================================//

這里寫圖片描述

本來這段代碼

//配置project的dependencies配置，默認都自動加上 自定義lint檢測的AAR包project.dependencies {//如果是android application項目if (project.getPlugins().hasPlugin('com.android.application')) {compile('com.xtc.lint:lint-check:1.1.1') {force = true}} else {provided('com.xtc.lint:lint-check:1.1.1') {force = true}}}

中的 lint-check 版本號我們寫的是 compile(‘com.xtc.lint:lint-check:+’) ，但是張亞州的依賴管理庫不準我們使用+號，因此我們這里寫的是指定好的版本。至此我們的插件功能介紹完畢了，下面是我們的Lint插件XTCLintPlugin的具體實現邏輯代碼

package com.xtc.lint.pluginimport com.android.build.gradle.AppPlugin
import com.android.build.gradle.LibraryPlugin
import com.android.build.gradle.api.BaseVariant
import com.android.build.gradle.internal.dsl.LintOptions
import com.android.build.gradle.tasks.Lint
import org.gradle.api.*
import org.gradle.api.internal.artifacts.dependencies.DefaultExternalModuleDependency
import org.gradle.api.tasks.TaskState/*** aar雖然很方便，但是在團隊內部推廣中我們遇到了以下問題：配置繁瑣，不易推廣。每個庫都需要自行配置lint.xml、lintOptions，并且compile aar。不易統一。各庫之間需要使用相同的配置，保證代碼質量。但現在手動來回拷貝規則，且配置文件可以自己修改。于是我們想到開發一個plugin，統一管理lint.xml和lintOptions，自動添加aar。*/
class XTCLintPlugin implements Plugin<Project> {@Overridevoid apply(Project project) {applyTask(project, getAndroidVariants(project))}private static final String sPluginMissConfiguredErrorMessage = "Plugin requires the 'android' or 'android-library' plugin to be configured."/*** 獲取project 項目 中 android項目 或者library項目 的 variant 列表* @param project 要編譯的項目* @return variants列表*/private static DomainObjectCollection<BaseVariant> getAndroidVariants(Project project) {if (project.getPlugins().hasPlugin(AppPlugin)) {return project.getPlugins().getPlugin(AppPlugin).extension.applicationVariants}if (project.getPlugins().hasPlugin(LibraryPlugin)) {return project.getPlugins().getPlugin(LibraryPlugin).extension.libraryVariants}throw new ProjectConfigurationException(sPluginMissConfiguredErrorMessage, null)}/***  插件的實際應用：統一管理lint.xml和lintOptions，自動添加aar。* @param project 項目* @param variants 項目的variants*/private void applyTask(Project project, DomainObjectCollection<BaseVariant> variants) {//========================== 統一  自動添加AAR  開始=============================================////配置project的dependencies配置，默認都自動加上 自定義lint檢測的AAR包project.dependencies {//如果是android application項目if (project.getPlugins().hasPlugin('com.android.application')) {compile('com.xtc.lint:lint-check:1.1.1') {force = true}} else {provided('com.xtc.lint:lint-check:1.1.1') {force = true}}}//去除gradle緩存的配置project.configurations.all {resolutionStrategy.cacheChangingModulesFor 0, 'seconds'resolutionStrategy.cacheDynamicVersionsFor 0, 'seconds'}//========================== 統一  自動添加AAR  結束=============================================//def xtcLintTaskExists = falsevariants.all { variant ->//獲取Lint Taskdef variantName = variant.name.capitalize()Lint lintTask = project.tasks.getByName("lint" + variantName) as Lint//Lint 會把project下的lint.xml和lintConfig指定的lint.xml進行合并，為了確保只執行插件中的規則，采取此策略File lintFile = project.file("lint.xml")File lintOldFile = null//==========================  統一  lintOptions  開始=============================================///*lintOptions {lintConfig file("lint.xml")warningsAsErrors trueabortOnError truehtmlReport truehtmlOutput file("lint-report/lint-report.html")xmlReport false}*/def newLintOptions = new LintOptions()//配置lintConfig的配置文件路徑newLintOptions.lintConfig = lintFile//是否將所有的warnings視為errors
//            newLintOptions.warningsAsErrors = true//是否lint檢測出錯則停止編譯newLintOptions.abortOnError = true//htmlReport打開newLintOptions.htmlReport = truenewLintOptions.htmlOutput = project.file("${project.buildDir}/reports/lint/lint-result.html")//xmlReport打開 因為Jenkins上的插件需要xml文件newLintOptions.xmlReport = truenewLintOptions.xmlOutput = project.file("${project.buildDir}/reports/lint/lint-result.xml")//配置 lint任務的配置為  newLintOptionslintTask.lintOptions = newLintOptions//==========================  統一  lintOptions  結束=============================================////==========================  統一  lint.xml  開始=============================================////lint任務執行前，先復制lint.xmllintTask.doFirst {//如果 lint.xml 存在，則改名為 lintOld.xmlif (lintFile.exists()) {lintOldFile = project.file("lintOld.xml")lintFile.renameTo(lintOldFile)}//進行 將plugin內置的lint.xml文件和項目下面的lint.xml進行復制合并操作def isLintXmlReady = copyLintXml(project, lintFile)//合并完畢后，將lintOld.xml 文件改名為 lint.xmlif (!isLintXmlReady) {if (lintOldFile != null) {lintOldFile.renameTo(lintFile)}throw new GradleException("lint.xml不存在")}}//lint任務執行后，刪除lint.xmlproject.gradle.taskGraph.afterTask { task, TaskState state ->if (task == lintTask) {lintFile.delete()if (lintOldFile != null) {lintOldFile.renameTo(lintFile)}}}//==========================  統一  lint.xml  結束=============================================////==========================  在終端 執行命令 gradlew lintForXTC  的配置  開始=============================================//// 在終端 執行命令 gradlew lintForXTC 的時候，則會應用  lintTaskif (!xtcLintTaskExists) {xtcLintTaskExists = true//創建一個task 名為  lintForXTCproject.task("lintForXTC").dependsOn lintTask}//==========================  在終端 執行命令 gradlew lintForXTC  的配置  結束=============================================//}}/*** 復制 lint.xml 到 targetFile* @param project 項目* @param targetFile 復制到的目標文件* @return 是否復制成功*/boolean copyLintXml(Project project, File targetFile) {//創建目錄targetFile.parentFile.mkdirs()//目標文件為  resources/config/lint.xml文件InputStream lintIns = this.class.getResourceAsStream("/config/lint.xml")OutputStream outputStream = new FileOutputStream(targetFile)int retroLambdaPluginVersion = getRetroLambdaPluginVersion(project)if (retroLambdaPluginVersion >= 180) {// 加入屏蔽try with resource 檢測  1.8.0版本引入此功能InputStream retroLambdaLintIns = this.class.getResourceAsStream("/config/retrolambda_lint.xml")XMLMergeUtil.merge(outputStream, "/lint", lintIns, retroLambdaLintIns)} else {// 未使用 或 使用了不支持try with resource的版本IOUtils.copy(lintIns, outputStream)IOUtils.closeQuietly(outputStream)IOUtils.closeQuietly(lintIns)}//如果復制操作完成后，目標文件存在if (targetFile.exists()) {return true}return false}/*** 獲取 使用的 RetroLambda Plugin插件的版本* @param project 項目* @return 沒找到時返回-1 ，找到返回正常version*/def static int getRetroLambdaPluginVersion(Project project) {DefaultExternalModuleDependency retroLambdaPlugin = findClassPathDependencyVersion(project, 'me.tatarka', 'gradle-retrolambda') as DefaultExternalModuleDependencyif (retroLambdaPlugin == null) {retroLambdaPlugin = findClassPathDependencyVersion(project.getRootProject(), 'me.tatarka', 'gradle-retrolambda') as DefaultExternalModuleDependency}if (retroLambdaPlugin == null) {return -1}return retroLambdaPlugin.version.split("-")[0].replaceAll("\\.", "").toInteger()}/*** 查找Dependency的Version信息* @param project* @param group* @param attributeId* @return*/def static findClassPathDependencyVersion(Project project, group, attributeId) {return project.buildscript.configurations.classpath.dependencies.find {it.group != null && it.group.equals(group) && it.name.equals(attributeId)}}
}

關于Android團隊使用內部Lint檢測的指導文檔2 —> 集成 Lint插件自動添加Lint檢測的AAR.md

六、應用自定義Lint到項目中去

我們剛才說了，我們有自定義Lint的AAR，你可以直接加入到項目中，當然也可以通過自定義的插件來知己添加到項目中去。

6.1 添加自定義Lint檢測的AAR

6.1.1 添加自定義Lint檢測的AAR

在項目的build.gradle 里面添加如下代碼

compile 'com.xtc.lint:lint-check:1.0.1'

這里寫圖片描述

目前版本為1.0.1，之后隨著自定義規則越來越多，版本再逐步升高。

6.2 執行lint檢測命令

6.2.1 本地執行lint命令

執行如下lint檢測命令

gradlew clean lint

開始執行命令

這里寫圖片描述

開始Lint檢測

這里寫圖片描述

檢測完畢

這里寫圖片描述

6.2.2 Android Studio執行 Inspect Code

如果上面的命令你用的不習慣，你可以使用Android Studio 自帶的代碼檢測

打開【Analyze】—>【Inspect Code】
這里寫圖片描述

彈出如下所示的Scope對話框，你可以選擇檢測的范圍
這里寫圖片描述

選擇完后，點擊【OK】按鈕即開始進行檢測。

APP項目比較大，可能檢測得幾分鐘，請等待。

這里寫圖片描述

檢測完后，會出現上圖所示的選項框，在Android Lint 下面可以看到我們自定義的Lint檢測規則

這里寫圖片描述

這里寫代碼片

6.2.3 Jenkins執行lint命令

修改Jenkins的編譯命令為

clean lint build --stacktrace

這里寫圖片描述

編譯完后，將lint報告歸檔到FTP

這里寫圖片描述

Source files 填寫

watch/build/outputs/lint-results-debug.html,lint-results-debug.xml
改目錄要根據自己項目實際輸出的lint報告來填寫，可以自己查看Jenkins的工作區生成的目錄

這里寫圖片描述

Remote directory 填寫

'Android/Common/${JOB_NAME}/'yyyy-MM-dd-HH-mm-ss-'build-${BUILD_NUMBER}-git-${GIT_COMMIT}'

然后點擊【高級】選項，勾選上【Flatten files】和【Remote directory】

這里寫圖片描述

這樣編譯完后，在FTP服務器對應的目錄上就會有lint檢測報告了
這里寫圖片描述

6.3 查看Lint檢測報告

6.3.1 lint報告輸出目錄

lint命令執行完畢之后，會輸出相應的lint報告，不同的gradle版本輸出的文檔地址可能不同，APP的輸出目錄為：\watch\build\outputs

這里寫圖片描述

gradle版本高的，輸出目錄可能為 \app\build\reports,如下所示

這里寫圖片描述

6.3.2 報告詳情

打開 \watch\build\outputs\lint-results-debug.html 網頁即可看到輸出的lint檢測報告。
這里寫圖片描述

控件命名

這里寫圖片描述

圖片太大
Log打印
Toast

如上圖所示，我們就可以看到自定義規則出來的代碼問題。請大家逐步修改檢測出來的問題，后期的代碼編譯會將lint檢測出來的問題作為一個指標。

6.4 添加自定義的Lint檢測插件

上一個方法是要自己手動的添加Lint檢測的AAR包到項目中，但是aar雖然很方便，但是在團隊內部推廣中我們遇到了以下問題：

配置繁瑣，不易推廣。每個庫都需要自行配置lint.xml、lintOptions，并且compile aar。
不易統一。各庫之間需要使用相同的配置，保證代碼質量。但現在手動來回拷貝規則，且配置文件可以自己修改。

于是我開發一個plugin，統一管理lint.xml和lintOptions，自動添加aar,下面是介紹如何添加該Plugin

這里寫圖片描述

6.4.1 在根目錄下的在build.gradle 中，添加Lint檢測插件

這里寫圖片描述

如上圖所示，在 buildscript 中的 dependencies 塊中，添加Lint檢測的插件地址，

//lint 檢測插件
classpath 'com.xtc.lint:lint-check-plugin:1.0.7-Dev'

6.4.2 在module的build.gradle中，應用Lint檢測插件

這里寫圖片描述

如上圖所示，添加如下代碼即可

apply plugin: 'XTCLintPlugin'

并且把之前已經添加過的lint檢測aar包代碼去掉，

這里寫圖片描述

6.4.3 運行命令 gradlew lintForXTC 即可正常應用插件統一配置的lint

6.4.3.1 在Android Studio中

gradlew clean lintForXTC

這里寫圖片描述

這樣就可以使用插件統一配置的lint，進行靜態代碼分析了。

這里寫圖片描述

編譯完后的lint報告，位置位于：lint-report目錄下，如下所示：

這里寫圖片描述

6.4.3.1 在Jenkins中

構建
在Jenkins中，修改下構建的任務為

clean lintForXTC build --stacktrace

這里寫圖片描述

侯建后的操作

1、修改 Publish Android Lint results
這里寫圖片描述

修改為 watch/lint-report/lint-results*.xml

2、修改 FTP Publishers
增加一項，將lint檢測的html報告保存到ftp路徑
這里寫圖片描述

Source files 路徑填寫

 watch/lint-report/lint-results.html

Remote directory 遠程保存路徑填寫

'Android/Common/${JOB_NAME}/'yyyy-MM-dd-HH-mm-ss-'build-${BUILD_NUMBER}-git-${GIT_COMMIT}'

構建過程，lint檢測過程中

這里寫圖片描述

構建后的結果
編譯完后，位置位于：lint-report目錄下，如下所示：

這里寫圖片描述

保存到FTP的報告如下

這里寫圖片描述

可以將html文件下載到本地然后使用瀏覽器打開，如下所示：

這里寫圖片描述

點擊【Lint Issues】可以查看Jenkins插件的Lint報告

這里寫圖片描述

查看具體細節的issue和上面介紹的一樣。

七、參考文獻

https://tech.meituan.com/android_custom_lint.html
https://tech.meituan.com/android_custom_lint2.html
https://github.com/GavinCT/MeituanLintDemo
http://blog.csdn.net/u010360371/article/details/50189171
https://yq.aliyun.com/articles/6918
http://www.androidchina.net/5106.html
https://engineering.linkedin.com/android/writing-custom-lint-checks-gradle
https://github.com/yongce/AndroidDevNotes/blob/master/notes/knowledge/0005-custom-lint.asc
https://google.github.io/android-gradle-dsl/current/com.android.build.gradle.internal.dsl.LintOptions.html#com.android.build.gradle.internal.dsl.LintOptions:quiet
http://blog.csdn.net/itfootball/article/details/49277207
https://testerhome.com/topics/3105
http://blog.csdn.net/hwhua1986/article/details/50067089
http://www.jianshu.com/p/761c88d095a2

這里寫圖片描述

作者：歐陽鵬歡迎轉載，與人分享是進步的源泉！
轉載請保留原文地址：https://blog.csdn.net/ouyang_peng/article/details/80374867

如果覺得本文對您有所幫助，歡迎您掃碼下圖所示的支付寶和微信支付二維碼對本文進行隨意打賞。您的支持將鼓勵我繼續創作！

這里寫圖片描述