摘要：檢查的執行邏輯自定義檢查規則創建創建執行檢查根據中的打印報告省略部分代碼上面代碼的邏輯就是執行檢查的主要過程。增量代碼檢查的實現輸出檢查報告根據上面代碼的邏輯，是檢查輸出結果的過程。

Lint是Google提供的一個靜態代碼檢查工具，可以掃描出代碼中潛在的問題，并且會對開發人員做出提示。而且除了Android原生提供的幾百種Lint規則以外，還可以使用Lint框架的API自定義Lint規則。

自定義Lint規則可以根據項目需求制定不同的掃描規則。比如：編碼規范、代碼風格、特定問題檢查等。

有了自定義檢查規則，提交代碼的時候可以規范代碼編寫。但是還有一個問題，新的代碼使用新的規范，但如何解決項目中老代碼風格？對于老代碼，不可能每行代碼都要修改。這個時候就要有針對性的檢查，那就是使用增量檢查。

增量代碼檢查有以下幾個好處

避免修改“祖傳”代碼的一些問題。如果全量掃描，之前老代碼的問題一大堆就會暴露出來， 這樣就大大增加了工作量，開發人員也沒有那么多的精力全部修改；

增加了一些代碼規范的強制性。增量掃描代碼，如果代碼有問題，就會滾，可以強制開發人 員規范代碼；

這里Lint增量代碼檢查工具是以Gradle插件的方式實現的。只需要在項目中引用插件便可使用Lint工具。主要實現的功能是在git提交場景下，每次提交代碼都會檢查新增的代碼（以行為單位）。如果代碼中存在不符合Lint自定義規則的代碼，就回滾本次提交。

Lint增量代碼檢查工具使用git hooks(post-commit) + Lint框架實現。

git hooks：是用來響應git的操作的腳本，相當于一個回調。執行特定的git操作會出發特定的git hooks腳本執行。

Lint框架：是實現Lint掃描的基礎。利用Lint框架提供的API執行Lint掃描。

提交（git commit）本次修改代碼（通過git diff命令找出提交的文件）；

觸發git hooks（post-commit）腳本執行。在腳本中執行Lint檢查任務（該任務是gradle任務）開始Lint檢查；

創建LintRequest（主要作用是指定Lint將要掃描的文件）；

獲取增量代碼（通過git diff找出修改的行號）；

開始Lint檢查；

檢查完畢輸出結果，如果有不符合規則的代碼，將回退本次提交。

看完上面的流程，可能會覺得不明所以。這里針對各個步驟做出詳細解析。在實現Lint增量代碼檢查的過程中，首要的步驟就是獲取將要提交的增量代碼。目前的解決方案是通過git命令獲取相關數據。

git hooks的執行

目前的方案是通過使用post-commit腳本觸發檢查流程。post-commit腳本是在git commit之后執行。

獲取LInt檢查的文件

獲取增量文件

git diff --name-only --diff-filter=ACMRTUXB HEAD~1 HEAD~0

通過git diff命令獲取本次提交的文件。

/**
 * 通過Git命令獲取需要檢查的文件
 *
 * @param project gradle.Project
 * @return 文件列表
 */
List getCommitChange(Project project) {
    ArrayList filterList = new ArrayList<>()
    try {
        //此命令獲取本次提交的文件 在git commit之后執行
        String command = "git diff --name-only --diff-filter=ACMRTUXB HEAD~1 HEAD~0"
        String changeInfo = command.execute(null, project.getRootDir()).text.trim()
        if (changeInfo == null || changeInfo.empty) {
            return filterList
        }

        String[] lines = changeInfo.split("
")
        return lines.toList()
    } catch (Exception e) {
        e.printStackTrace()
        return filterList
    }
}

獲取增量代碼

這是關鍵的一步，因為這一步要獲取增量代碼所在的具體行號，通過使用這些行號數據實現增量檢查的效果。

git diff --unified=0 --ignore-blank-line --ignore-all-space HEAD~1 HEAD filepath

filepath就是增量文件的相對路徑。

數據準備完畢以后，剩下的工作就要交給Lint框架了。接下來開始執行Lint檢查操作。

/**
 * 通過git diff獲取已提交文件的修改,包括文件的添加行的行號、刪除行的行號、修改行的行號
 *
 * @param filePath 文件路徑
 * @param project Project對象
 * @param startIndex 修改開始的下表數組
 * @param endIndex 修改結束的下表數組
 */
void getFileChangeStatus(String filePath, Project project, List startIndex, List endIndex) {
    try {
        String command = "git diff --unified=0 --ignore-blank-lines --ignore-all-space HEAD~1 HEAD " + filePath
        String changeInfo = command.execute(null, project.getRootDir()).text.trim()
        String[] changeLogs = changeInfo.split("@@")
        String[] indexArray

        for (int i = 1; i < changeLogs.size(); i += 2) {
            indexArray = changeLogs[i].trim().split(" ")
            try {
                int start, end
                String[] startArray = null
                if (indexArray.length > 1) {
                    startArray = indexArray[1].split(",")
                }

                if (startArray != null && startArray.length > 1) {
                    start = Integer.parseInt(startArray[0])
                    end = Integer.parseInt(startArray[0]) + Integer.parseInt(startArray[1])
                } else {
                    start = Integer.parseInt(startArray[0])
                    end = start + 1
                }
                startIndex.add(start)
                endIndex.add(end)
            } catch (NumberFormatException e) {
                e.printStackTrace()
                startIndex.add(0)
                endIndex.add(0)
            }

        }
    } catch (Exception e) {
        e.printStackTrace()
    }
}

執行Lint檢查

Lint框架中的主要類說明：

LintCliClient：Lint客戶端，作用是集成lint檢查的操作、相關配置以及lint檢查的入口。

LintCliFlags：Lint標志位管理類，提供了Lint操作的標志位。Lint代碼檢查工具主要使用了該類中生成日志的配置，通過加入不同實現的報告生成類可以實現不同的輸出格式（比如TXT、XML、HTML等）。

LintRequest：執行Lint操作時的一個請求類，主要作用是存儲Lint將要掃描的文件。在Lint工具中重寫LintRequest初始化方法可以實現增量文件的檢查。

LintDriver：執行Lint規則檢查邏輯的類。

IssueRegistry：自定義Lint規則管理類。用于添加Lint自定義規則。

上述對于Lint框架中類的介紹是在實現Lint增量代碼檢查中主要用到的類。

創建LintRequest

class LintToolClient extends LintCliClient {

    @Override
    /**
     * 通過重寫createLintRequest方法創建LintRequest
     */
    protected LintRequest createLintRequest(List files) {
        LintRequest request = super.createLintRequest(files)
        for (Project project : request.getProjects()) {
            for (File file : files) {
                project.addFile(file)
            }
        }
        return new LintRequest(this, files)
    }
}

上面的代碼就是LintRequest的創建過程，通過重寫LintCliClient中的createLintRequest方法。其中參數files就是將要檢查的文件。

Lint檢查的執行邏輯

/*LintCliClient*/
public int run(@NonNull IssueRegistry registry, @NonNull List files) throws IOException {
        assert !flags.getReporters().isEmpty();
        this.registry = registry; //Lint自定義檢查規則

        LintRequest lintRequest = createLintRequest(files); //創建LintRequest
        driver = createDriver(registry, lintRequest); //創建LintDriver

        addProgressPrinter();
        validateIssueIds();

        driver.analyze(); //執行Lint檢查

        Collections.sort(warnings);

        int baselineErrorCount = 0;
        int baselineWarningCount = 0;
        int fixedCount = 0;

        LintBaseline baseline = driver.getBaseline();
        if (baseline != null) {
            baselineErrorCount = baseline.getFoundErrorCount();
            baselineWarningCount = baseline.getFoundWarningCount();
            fixedCount = baseline.getFixedCount();
        }

        Stats stats = new Stats(errorCount, warningCount,
                baselineErrorCount, baselineWarningCount, fixedCount);

        boolean hasConsoleOutput = false;
    	//根據LintCliFlags中的Reports打印Lint報告
        for (Reporter reporter : flags.getReporters()) {
            reporter.write(stats, warnings);
            if (reporter instanceof TextReporter && ((TextReporter)reporter).isWriteToConsole()) {
                hasConsoleOutput = true;
            }
        }
    
    //............省略部分代碼..............

        return flags.isSetExitCode() ");

上面代碼的邏輯就是Lint執行檢查的主要過程。可以看到，在代碼中先傳入自定義的Lint規則IssueRegistry，然后創建LintRequest，接下就開始執行Lint檢查，最后將結果輸出。結果輸出到添加在LintCliFlags的Reports中。

增量代碼檢查的實現

//輸出Lint檢查報告
for (Reporter reporter : flags.getReporters()) {
            reporter.write(stats, warnings);
            if (reporter instanceof TextReporter && ((TextReporter)reporter).isWriteToConsole()) {
                hasConsoleOutput = true;
            }
        }

根據上面代碼的邏輯，是Lint檢查輸出結果的過程。增量代碼檢查的實現就是重寫Reporter類，在重寫的類中實現自定義的輸出規則，這里的實現方法就是使用上文中通過git命令獲取的文件修改行號進行過濾，從而實現增量檢查的效果。

上面描述了Lint增量代碼檢查工具的實現過程，實現增量代碼檢查的關鍵就是獲取文件修改的精確位置，以便在輸出結果是進行過濾。

增量代碼檢查相較于常規的Lint檢查，好處就是能夠避免老代碼的與新規則的沖突，同時結合git使用能夠在提交代碼時增加一些強制性。

最后，Lint增量代碼工具中使用的是Lint的自定義規則。這些還可以作為原生的Lint規則的擴展，在代碼編寫的階段使用，效果跟原聲Lint規則一致。

對Lint增量代碼工具的實現感興趣的同學，可以在github上獲取源碼,感興趣的可以star一下。

Lint增量代碼檢查工具鏈接