Android Lint 實踐 —— 簡介及常見問題分析

Kayo發表於2017-10-11
Android

概況

QMUI Android 剛更新了 1.0.4 版本，其中主要的特性是引入了 Android Lint，對專案程式碼進行優化。Android Lint 是 SDK Tools 16（ADT 16）開始引入的一個程式碼掃描工具，通過對程式碼進行靜態分析，可以幫助開發者發現程式碼質量問題和提出一些改進建議。除了檢查 Android 專案原始碼中潛在的錯誤，對於程式碼的正確性、安全性、效能、易用性、便利性和國際化方面也會作出檢查。

而最終選擇了 Android Lint 作為專案的程式碼檢測工具，是因為它具有以下幾個特性：

  • 已經被整合到 Android Studio，使用方便。
  • 能在編寫程式碼時實時反饋出潛在的問題。
  • 可以自定義規則。Android Lint 本身包含大量已經封裝好的介面，能提供豐富的程式碼資訊，開發者可以基於這些資訊進行自定義規則的編寫。

開始使用

Android Lint 的工作過程比較簡單，一個基礎的 Lint 過程由 Lint Tool（檢測工具），Source Files（專案原始檔） 和 lint.xml（配置檔案） 三個部分組成，Lint Tool 讀取 Source Files，根據 lint.xml 配置的規則（issue）輸出結果（如下圖）。

如上面所描述，在 Android Studio 中，Android Lint 已經被整合，只需要點選選單 —— Analyze —— Inspect Code 即可執行 Android Lint，在彈出的對話方塊中可以設定執行 Lint 的範圍，可以選擇整個專案，也可以只選擇當前的子模組或者其他自定義的範圍：

檢查完畢後會彈出 Inspection 的控制檯，並在其中列出詳細的檢查結果：

如上圖所展示的，Android Lint 對檢查的結果進行了分類，同一個規則（issue）下的問題會聚合，其中針對 Android 的規則類別會在分類前說明是 Android 相關的，主要是六類：

  • Accessibility 無障礙，例如 ImageView 缺少 contentDescription 描述，String 編碼字串等問題。
  • Correctness 正確性，例如 xml 中使用了不正確的屬性值，Java 程式碼中直接使用了超過最低 SDK 要求的 API 等。
  • Internationalization 國際化，如字元缺少翻譯等問題。
  • Performance 效能，例如在 onMeasure、onDraw 中執行 new，記憶體洩露，產生了冗餘的資源，xml 結構冗餘等。
  • Security 安全性，例如沒有使用 HTTPS 連線 Gradle，AndroidManifest 中的許可權問題等。
  • Usability 易用性，例如缺少某些倍數的切圖，重複圖示等。

其他的結果條目則是針對 Java 語法的問題，另外每一個問題都有區分嚴重程度（severity），從高到底依次是：

  • Fatal
  • Error
  • Warning
  • Information
  • Ignore

其中 Fatal 和 Error 都是指錯誤，但是 Fatal 型別的錯誤會直接中斷 ADT 匯出 APK，更為嚴重。另外如下圖所示，在結果列表中點選一個條目，可以看到詳細的原始檔名和位置，以及命中的錯誤規則（issue）、解決方案或者遮蔽提示：

上圖的例子是在 ScrollView 的第一層子元素中設定了高度為 match_parent，Android Lint 會直接給出解決辦法——使用 wrap_content 代替，大部分靜態語法相關的問題 Android Lint 都可以直接給出解決辦法。

除了直接在選單中執行 Lint 外，大部分問題程式碼在編寫時 Android Studio 就會給出提醒：

配置

對於執行 Lint 操作的相關配置，是定義在 gradle 檔案的 lintOptions 中，可定義的選項及其預設值包括（翻譯自 LintOptions - Android Plugin 2.3.0 DSL Reference）：

android {
    lintOptions {
        // 設定為 true，則當 Lint 發現錯誤時停止 Gradle 構建
        abortOnError false
        // 設定為 true，則當有錯誤時會顯示檔案的全路徑或絕對路徑 (預設情況下為true)
        absolutePaths true
        // 僅檢查指定的問題（根據 id 指定）
        check 'NewApi', 'InlinedApi'
        // 設定為 true 則檢查所有的問題，包括預設不檢查問題
        checkAllWarnings true
        // 設定為 true 後，release 構建都會以 Fatal 的設定來執行 Lint。
        // 如果構建時發現了致命（Fatal）的問題，會中止構建（具體由 abortOnError 控制）
        checkReleaseBuilds true
        // 不檢查指定的問題（根據問題 id 指定）
        disable 'TypographyFractions','TypographyQuotes'
        // 檢查指定的問題（根據 id 指定）
        enable 'RtlHardcoded','RtlCompat', 'RtlEnabled'
        // 在報告中是否返回對應的 Lint 說明
        explainIssues true
        // 寫入報告的路徑，預設為構建目錄下的 lint-results.html
        htmlOutput file("lint-report.html")
        // 設定為 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"?>
<lint>
    <!-- Disable the given check in this project -->
    <issue id="HardcodedText" severity="ignore"/>
    <issue id="SmallSp" severity="ignore"/>
    <issue id="IconMissingDensityFolder" severity="ignore"/>
    <issue id="RtlHardcoded" severity="ignore"/>
    <issue id="Deprecated" severity="warning">
        <ignore regexp="singleLine"/>
    </issue>
</lint>複製程式碼

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<QMUIProgressBar> weakRectProgressBar;
    private WeakReference<QMUIProgressBar> 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

onMeasure、onDraw 都是被頻繁呼叫的方法，因此 Lint 不建議在其中執行 new 操作，可以在 onCreateView 等非頻繁呼叫的時機進行 new 操作，並用成員變數儲存，再在 onMeasure 中使用成員變數。

‘private’ method declared ‘final’

private static final void addLinkMovementMethod(TextView t) {
    MovementMethod m = t.getMovementMethod();

    // ...
}複製程式碼

如上面的示例程式碼，會產生 ‘private’ method declared ‘final’ 的警告，因為私有方法是不會被 override 的，因此完全沒有必要宣告 final。

參考資料：

使用 Lint 改進您的程式碼 | Android Studio
LintOptions - Android Plugin 2.3.0 DSL Reference
Android Lint Checks - Android Studio Project Site

相關文章