快捷導(dǎo)航

詳解Android Lint的原理及其使用

更新時(shí)間：2021年04月12日 16:48:44 作者：卜大爺

這篇文章主要介紹了詳解Android Lint的原理及其使用，想了解Lint的同學(xué)，一定要著重看一下

Android Lint 原理及使用詳解

Android Lint 是 ADT 16中引入的新工具，用于掃描 Android 項(xiàng)目源中的潛在錯(cuò)誤。

Lint 是 Android 提供的一個(gè)強(qiáng)大的，用于靜態(tài)掃描應(yīng)用源碼并找出其中的潛在問題的實(shí)用工具。lint 工具可以檢查你的 Android 項(xiàng)目源文件是否有潛在的錯(cuò)誤，以及在正確性、安全性、性能、易用性、無障礙性和國際化方面是否需要優(yōu)化改進(jìn)。

Lint 既可以用作命令行工具，也可以與 Eclipse 和 IntelliJ 集成在一起。它被設(shè)計(jì)成獨(dú)立于 IDE 的工具，我們可以在 Android Studio 中非常方便的使用它。

Lint 的工作過程

lint 工具的代碼掃描工作流：

應(yīng)用源文件：源文件包含組成 Android 項(xiàng)目的文件，包括 Java、Kotlin 和 XML 文件、圖標(biāo)以及 ProGuard 配置文件。
lint.xml 文件：一個(gè)配置文件，可用于指定要排除的任何 lint 檢查以及自定義問題嚴(yán)重級(jí)別。lint 工具：一個(gè)靜態(tài)代碼掃描工具，你可以從命令行或在 Android Studio 中對(duì) Android 項(xiàng)目運(yùn)行該工具。
lint 工具檢查可能會(huì)影響 Android 應(yīng)用的質(zhì)量和性能的代碼結(jié)構(gòu)問題。強(qiáng)烈建議你先更正 lint 檢測(cè)到的所有錯(cuò)誤，然后再發(fā)布你的應(yīng)用。
lint 檢查結(jié)果：我們可以在控制臺(tái)或 Android Studio 的 Inspection Results 窗口中查看 lint 檢查結(jié)果。

Lint 的工作過程由 Lint Tool（檢測(cè)工具），Source Files（項(xiàng)目源文件）和 lint.xml（配置文件）三個(gè)部分組成，Lint Tool 讀取 Source Files，根據(jù) lint.xml 配置的規(guī)則（issue）輸出最終的結(jié)果。

Lint 的功能

Lint 可以檢查并發(fā)現(xiàn)以下幾類問題：

缺少翻譯（和未使用的翻譯）
布局性能問題（所有以前實(shí)用 layoutopt 工具用來查找的問題，等等）
數(shù)組大小不一致
可訪問性和國際化問題（硬編碼字符串，缺少 contentDescription 等）
圖標(biāo)問題（例如缺少密度，重復(fù)的圖標(biāo)，錯(cuò)誤的尺寸等）
可用性問題（如未在文本字段中指定輸入類型）
Manifest 錯(cuò)誤

問題等級(jí)

Lint 發(fā)現(xiàn)的每個(gè)問題都有描述信息和等級(jí)，我們可以很方便地定位問題，同時(shí)按照嚴(yán)重程度進(jìn)行解決。當(dāng)然，我們也可以手動(dòng)配置每個(gè)問題的嚴(yán)重級(jí)別。Lint 本身包含大量已經(jīng)封裝好的接口，能提供豐富的代碼信息，開發(fā)者可以基于這些信息進(jìn)行自定義規(guī)則的編寫。

Lint 會(huì)按照問題的嚴(yán)重程度分為幾個(gè)等級(jí)：

Fatal
Error
Warning
Information
Ignore

問題嚴(yán)重程序由高到低依次降低。

從命令行運(yùn)行 lint

如果你使用的是 Android Studio 或 Gradle，你可以在項(xiàng)目的根目錄下輸入以下某個(gè)命令，使用 Gradle 封裝容器對(duì)項(xiàng)目調(diào)用 lint 任務(wù)：

在 Windows 上：

gradlew lint

在 Linux 或 Mac 上：

./gradlew lint

lint 工具完成其檢查后，會(huì)提供 XML 和 HTML 版 lint 報(bào)告的路徑。然后，我們可以轉(zhuǎn)到 HTML 報(bào)告并在瀏覽器中將其打開

Android Studio 中使用 Lint

Lint 已經(jīng)被集成到 Android Studio，所以可以直接使用，使用非常方便。lint 的代碼掃描工具，可幫助你發(fā)現(xiàn)并更正代碼結(jié)構(gòu)質(zhì)量的問題，而無需您實(shí)際執(zhí)行應(yīng)用，也不必編寫測(cè)試用例。系統(tǒng)會(huì)報(bào)告該工具檢測(cè)到的每個(gè)問題并提供問題的描述消息和嚴(yán)重級(jí)別，以便你可以快速確定需要優(yōu)先進(jìn)行的關(guān)鍵改進(jìn)。此外，你還可以降低問題的嚴(yán)重級(jí)別以忽略與項(xiàng)目無關(guān)的問題，或者提高嚴(yán)重級(jí)別以突出特定問題。

從菜單欄，選擇Analyze > Inspect Code

選擇檢查范圍

選擇后，點(diǎn)擊"OK"，稍等一會(huì)就會(huì)生成掃描結(jié)果：

左側(cè)是問題分類，選中一個(gè)問題條目，則右側(cè)會(huì)展示具體的問題代碼，這樣就可以很方便的進(jìn)行問題排查、定位和更改了。

Android 的規(guī)則類別：

Accessibility 輔助選項(xiàng)，例如 ImageView 缺少 contentDescription 描述，String 編碼字符串等問題。
Compliance 合規(guī)性，違反了Google Play的要求，比如使用了過期的庫版本，性能、安全性、API等級(jí)等沒有遵循新系統(tǒng)的要求等。
Correctness 不夠完美的編碼，比如硬編碼、使用過時(shí)API等。
Internationalization 國際化，如直接使用漢字，沒有使用資源引用等。
Interoperability 互操作性，比如和Kotln的交互等。
Performance 性能，例如：靜態(tài)引用，循環(huán)引用等。
Security 安全性，例如沒有使用 HTTPS 連接 Gradle，AndroidManifest 中的權(quán)限問題等。
Usability 易用性，有更好的替換的，例如缺少某些倍數(shù)的切圖，排版、圖標(biāo)格式建議.png格式等等。

lint 配置

配置 lint 文件

我們可以在 lint.xml 文件中進(jìn)行 lint 配置。我們可以手動(dòng)創(chuàng)建該文件，并放置在 Android 項(xiàng)目的根目錄下。

lint.xml 文件由封閉的父標(biāo)記組成，此標(biāo)記包含一個(gè)或多個(gè) 子元素。lint 會(huì)為每個(gè) 定義唯一的 id 屬性值。

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

我們可以通過在標(biāo)記中設(shè)置嚴(yán)重性級(jí)別屬性來更改某個(gè)問題的嚴(yán)重性級(jí)別或?qū)υ搯栴}停用 lint 檢查。

下面來看一個(gè)示例：

<?xml version="1.0" encoding="UTF-8"?>
<lint>
    <!-- Disable the given check in this project -->
    <issue id="IconMissingDensityFolder" severity="ignore" />

    <!-- Ignore the ObsoleteLayoutParam issue in the specified files -->
    <issue id="ObsoleteLayoutParam">
        <ignore path="res/layout/activation.xml" />
        <ignore path="res/layout-xlarge/activation.xml" />
    </issue>

    <!-- Ignore the UselessLeaf issue in the specified file -->
    <issue id="UselessLeaf">
        <ignore path="res/layout/main.xml" />
    </issue>

    <!-- Change the severity of hardcoded strings to "error" -->
    <issue id="HardcodedText" severity="error" />
</lint>

禁用某個(gè)文件或方法進(jìn)行 lint 檢查

如果我們?cè)?Android 項(xiàng)目中想對(duì)某個(gè)類或方法禁用 lint 檢查，可以請(qǐng)向該代碼添加 @SuppressLint 注解。

以下示例展示了如何對(duì) onCreate 方法中的 NewApi 問題停用 lint 檢查。lint 工具會(huì)繼續(xù)檢查該類的其他方法中的 NewApi 問題。

@SuppressLint("NewApi")
@Override
public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.main);

以下示例展示了如何對(duì) FeedProvider 類中的 ParserError 問題停用 lint 檢查：

@SuppressLint("ParserError")
public class FeedProvider extends ContentProvider {

要禁止 lint 檢查文件中的所有問題，請(qǐng)使用 all 關(guān)鍵字，如下所示：

@SuppressLint("all")

xml 文件的 lint 檢測(cè)配置

我們可以使用 tools:ignore 屬性對(duì) XML 文件的特定部分停用 lint 檢查。在 lint.xml 文件中添加以下命名空間值，以便 lint 工具能夠識(shí)別該屬性：

namespace xmlns:tools="http://schemas.android.com/tools"

以下示例展示了如何對(duì) XML 布局文件的元素中的 UnusedResources 問題停用 lint 檢查。如果某個(gè)父元素聲明了 ignore 屬性，則該元素的子元素會(huì)繼承此屬性。在本示例中，也會(huì)對(duì) 子元素停用 lint 檢查。

<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>

要禁止檢查多個(gè)問題，請(qǐng)使用以英文逗號(hào)分隔的字符串列出要禁止檢查的問題。例如：

tools:ignore="NewApi,StringFormatInvalid"

要禁止 lint 檢查 XML 元素中的所有問題，請(qǐng)使用 all 關(guān)鍵字，如下所示：

tools:ignore="all"

通過 Gradle 配置 lint 選項(xiàng)

通過 Android Plugin for Gradle，我們可以使用模塊級(jí) build.gradle 文件中的 lintOptions {} 代碼塊配置某些 lint 選項(xiàng)，例如要運(yùn)行或忽略哪些檢查。

例如：

android {
  ...
  lintOptions {
    // Turns off checks for the issue IDs you specify.
    disable 'TypographyFractions','TypographyQuotes'
    // Turns on checks for the issue IDs you specify. These checks are in
    // addition to the default lint checks.
    enable 'RtlHardcoded','RtlCompat', 'RtlEnabled'
    // To enable checks for only a subset of issue IDs and ignore all others,
    // list the issue IDs with the 'check' property instead. This property overrides
    // any issue IDs you enable or disable using the properties above.
    check 'NewApi', 'InlinedApi'
    // If set to true, turns off analysis progress reporting by lint.
    quiet true
    // if set to true (default), stops the build if errors are found.
    abortOnError false
    // if true, only report errors.
    ignoreWarnings true
  }
}
...

在 Android Studio 中修改 lint 配置文件

我們可以很方便的在 Android Studio 中修改 lint 檢查時(shí)的配置。

Android Studio 附帶了許多 lint 及其他檢查配置文件，這些配置文件可通過 Android 更新進(jìn)行更新。我們可以原封不動(dòng)地使用這些配置文件，也可以修改它們的名稱、說明、嚴(yán)重級(jí)別和范圍。當(dāng)然，還可以激活和禁用整組的配置文件或一組配置文件中的個(gè)別配置文件。

依次選擇 Analyze > Inspect Code，在 Specify Scope 對(duì)話框的 Inspection Profile 下，點(diǎn)擊 More。

此時(shí)將顯示 Inspections 對(duì)話框，其中列出了支持的檢查及其說明：

選擇 Profile 下拉列表，以在 Default (Android Studio) 與 Project Default（活動(dòng)項(xiàng)目）檢查之間切換。
在左側(cè)窗格的 Inspections 對(duì)話框中，選擇一個(gè)頂級(jí)配置文件類別，或展開一個(gè)組并選擇特定的配置文件。選擇一個(gè)配置文件類別后，我們可以將該類別中的所有檢查項(xiàng)目當(dāng)作一個(gè)檢查項(xiàng)目進(jìn)行修改。
選擇 Manage 下拉列表，以復(fù)制檢查項(xiàng)目、對(duì)檢查項(xiàng)目進(jìn)行重命名、向檢查項(xiàng)目添加說明以及導(dǎo)出/導(dǎo)入檢查項(xiàng)目。
操作完成后，點(diǎn)擊 OK。

以上就是詳解Android Lint的原理及其使用的詳細(xì)內(nèi)容，更多關(guān)于Android Lint的原理的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: