前言

在保證代碼沒(méi)有功能問(wèn)題，完成業(yè)務(wù)開(kāi)發(fā)之余，有追求的程序員還要追求代碼的規(guī)范、可維護(hù)性。

今天，以“成為優(yōu)秀的程序員”為目標(biāo)的拭心將和大家一起精益求精，學(xué)習(xí)使用 Lint 優(yōu)化我們的代碼。

什么是 Lint

Lint 是 Android Studio 提供的 代碼掃描分析工具 ，它可以幫助我們發(fā)現(xiàn)代碼結(jié)構(gòu)/質(zhì)量問(wèn)題，同時(shí)提供一些解決方案，而且這個(gè)過(guò)程不需要我們手寫(xiě) 測(cè)試 用例。

Lint 發(fā)現(xiàn)的每個(gè)問(wèn)題都有描述信息和等級(jí)(和測(cè)試發(fā)現(xiàn) bug 很相似)，我們可以很方便地定位問(wèn)題，同時(shí)按照嚴(yán)重程度進(jìn)行解決。

當(dāng)然這個(gè)“嚴(yán)重程度”我們可以手動(dòng)調(diào)節(jié)，有些原則問(wèn)題不容侵犯，必須提升到 error，而有的個(gè)別問(wèn)題也可以無(wú)視，畢竟人非圣賢孰能無(wú)過(guò)嘛。

Lint 工作方式簡(jiǎn)單介紹

Lint 會(huì)根據(jù)預(yù)先配置的檢測(cè)標(biāo)準(zhǔn)檢查我們 Android 項(xiàng)目的源文件，發(fā)現(xiàn)潛在的 bug 或者可以?xún)?yōu)化的地方，優(yōu)化的內(nèi)容主要包括以下幾方面：

• Correctness：不夠***的編碼，比如硬編碼、使用過(guò)時(shí) API 等
• Performance：對(duì)性能有影響的編碼，比如：靜態(tài)引用，循環(huán)引用等
• Internationalization：國(guó)際化，直接使用漢字，沒(méi)有使用資源引用等
• Security：不安全的編碼，比如在 WebView 中允許使用 JavaScriptInterface 等

Lint 檢測(cè)代碼的過(guò)程如下圖所示： 

• App 源文件 ：包括 Java 代碼，XML 代碼，圖標(biāo)，以及 ProGuard 配置文件等
• lint.xml ：Lint 檢測(cè)的執(zhí)行標(biāo)準(zhǔn)配置文件，我們可以修改它來(lái)允許或者禁止報(bào)告一些問(wèn)題

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

Lint 的命令很簡(jiǎn)單：

lint [flags] <project directory> 

Lint 也可以使用 Gradle 運(yùn)行：

Windows:

gradlew lint 

Mac:

./gradlew lint 

具體命令行相關(guān)的操作這里就不介紹了，因?yàn)檫@個(gè)過(guò)程實(shí)在太痛苦，上一張命令行運(yùn)行 Lint 后得到的 XML 文件截圖讓你體驗(yàn)一下： 

我們還是直接進(jìn)入 Lint 的 GUI 操作吧。

Android Studio 中使用 Lint

Android Studio 中內(nèi)置了 Lint，我們小手一點(diǎn)就可以直接使用。

Lint 的使用路徑：

工具欄 -> Analyze -> Inspect Code…

點(diǎn)擊 Inspect Code 后會(huì)彈出檢查范圍的對(duì)話(huà)框： 

默認(rèn)是檢查整個(gè)項(xiàng)目，我們可以點(diǎn)擊 Custom scope 自定義檢查范圍。

點(diǎn)擊右邊的下拉框，會(huì)出現(xiàn)以下選擇： 

分別有：

• Project Files：所有項(xiàng)目文件
• Project Production Files：項(xiàng)目的代碼文件
• Project Test Files：項(xiàng)目的測(cè)試文件
• OpenFiles：當(dāng)前打開(kāi)的文件
• Module ‘app’：主要的 app 模塊
• Current File：當(dāng)前文件

除了內(nèi)置的選項(xiàng)我們還可以自己選擇特定的類(lèi)進(jìn)行檢查，點(diǎn)擊下圖中的紅色框部分： 

會(huì)彈出自定義范圍選擇框，默認(rèn)是空的，我們可以點(diǎn)擊左上角的“+”號(hào)新增一個(gè)檢查范圍： 

- Local ：只能當(dāng)前項(xiàng)目使用

- Shared ：其他 Android Studio 項(xiàng)目也可以使用

我們選擇 Shared，然后起個(gè)帥氣的名字 “ShixinCuteLint”，默認(rèn)按項(xiàng)目顯示，這時(shí)檢查的文件數(shù)為 0 ： 

上圖中右邊的四個(gè)按鈕表示要操作的類(lèi)型：

• Include ：包括當(dāng)前文件夾內(nèi)的文件，但不包括他的子文件夾
• Include Recursively ：包括當(dāng)前文件夾以及它的子文件夾內(nèi)所有的文件夾，遞歸添加
• Exclude ：移除當(dāng)前文件夾，不包括子文件夾
• Exclude Recursively ：移除當(dāng)前文件夾及所有子文件夾

我們點(diǎn)擊左邊的 app 文件夾后，點(diǎn)擊右邊的 Include Recursively 按鈕，把 app 下的所有文件添加到檢查列表： 

可以看到，這時(shí) app 下的文件都變綠了，總共有 689 個(gè)文件夾要掃描。

點(diǎn)擊 OK 進(jìn)行檢測(cè)，稍等一會(huì)兒，會(huì)彈出 Inspection 對(duì)話(huà)框，顯示檢查結(jié)果，沒(méi)想到我的代碼居然有 1769 個(gè)警告!這數(shù)字觸目驚心啊： 

我們主要關(guān)注紅框內(nèi)的警告，先來(lái)看看我的代碼 Performance 有什么問(wèn)題： 

哈哈，沒(méi)想到我還有這么多進(jìn)步空間!

上圖可以看到，Lint 真是神器，可以幫我們發(fā)現(xiàn)自己忽略或者沒(méi)有意識(shí)到的問(wèn)題，尤其是性能方面，如果你覺(jué)得自己代碼想優(yōu)化又不知道從何做起，不妨讓 Lint 給你指指路。

團(tuán)隊(duì)中建立代碼規(guī)范利器：提升、降低問(wèn)題的等級(jí)

雖然 Lint 可以幫我們檢查代碼的問(wèn)題，但多人合作時(shí)，我們更期望可以在寫(xiě)代碼時(shí)就發(fā)現(xiàn)問(wèn)題、解決問(wèn)題。

鑒于團(tuán)隊(duì)成員中水平良莠不齊，靠個(gè)人意識(shí)有時(shí)候很難保證質(zhì)量，這時(shí)可以修改 Lint 對(duì)于特定問(wèn)題的警告等級(jí)，以最直觀(guān)的 IDE 提示來(lái)警醒成員。

Lint 的警告嚴(yán)重程度有以下幾種： 

• Unused Entry：沒(méi)有使用的屬性，灰色，很不起眼
• Typo：拼寫(xiě)錯(cuò)誤，綠色波浪下劃線(xiàn)，也不太起眼
• Server Problem：服務(wù)器錯(cuò)誤?好像不是
• Info：注釋文檔，綠色，比較顯眼
• Weak Warning：比較弱的警告，提示比較弱
• Warning：警告，略微顯眼一點(diǎn)
• Error：錯(cuò)誤，最顯眼的一個(gè)

日常開(kāi)發(fā)中，好一點(diǎn)的程序員會(huì)關(guān)注 Warning 的警告，根據(jù)警告優(yōu)化代碼，但那也只是很少一部分。但是紅色的 Error 就不一樣了，基本上看到就想要消滅掉。

我們拿命名拼寫(xiě)錯(cuò)誤舉個(gè)例子。

類(lèi)、對(duì)象、遍歷拼寫(xiě)錯(cuò)誤看起來(lái)不是什么問(wèn)題，但是如果你見(jiàn)過(guò)大量的無(wú)意義或者錯(cuò)誤命名，你一定會(huì)贊同我的接下來(lái)做法。

默認(rèn)的拼寫(xiě)錯(cuò)誤是 Typo ，提示很弱，所以常被人忽略： 

[[182197]] 

上面的 String 類(lèi)型變量 login 寫(xiě)成了 logn，Lint 默認(rèn)對(duì)拼寫(xiě)錯(cuò)誤是個(gè)下滑波浪線(xiàn)，很不起眼。我們修改一下。

打開(kāi) Preferences/Settings，搜索 Inspections，會(huì)出現(xiàn) Lint 的檢測(cè)配置頁(yè)面： 

要修改拼寫(xiě)的警告等級(jí)，搜索“spelling”： 

然后選擇出現(xiàn)的 Typo，再點(diǎn)擊右邊的 Severity 就是嚴(yán)重程度，改成 Error，OK。 

[[182198]] 

可以看到，現(xiàn)在拼寫(xiě)錯(cuò)誤就會(huì)出現(xiàn)紅色的錯(cuò)誤警告了，讓你不好好寫(xiě)變量名!

Lint 雖好，也不能貪杯。

Lint 就像是一個(gè)潔癖患者，雖然可以讓我們代碼干凈許多，但是如果真要把它提示的全解決，恐怕老板要發(fā)怒了：給你發(fā)工資天天玩電腦，怎么不出活呢?!

Lint 報(bào)的某些警告的確是沒(méi)必要，這時(shí)我們可以選擇忽略這些警告。忽略警告可以分兩種：

1. 在 Java 代碼中
2. 在 XML 文件夾中

在 Java 代碼中忽略 Lint 警告：

忽略 Lint 警告的注解跟 @SuppressWarnings 很類(lèi)似，@SuppressLint(“忽略的警告名稱(chēng)”)。

下面的代碼演示了如何忽略 Lint 對(duì)使用新 API 的警告：

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

要是你不清楚要忽略的警告具體是什么名字，那就直接忽略 all，當(dāng)然是當(dāng)前類(lèi)/方法/對(duì)象：

@SuppressLint("all") 

在 XML代碼中忽略 Lint 警告：

只需兩步：

1. xml 中聲明 tools 命名空間
2. 使用 tools:ignore=”忽略的警告名”

例如：

<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android" 
              xmlns:tools="http://schemas.android.com/tools" 
              tools:ignore="all" 
              android:layout_width="match_parent" 
              android:layout_height="match_parent" 
              android:orientation="vertical" 
              android:background="@color/white">  

Gradle 中配置 Lint

Gradle 中也可以配置 Lint 的關(guān)鍵操作，比如是否開(kāi)啟 Lint 警告，或者關(guān)閉指定的警告。

在 module 下的 build.gradle 中添加 lintOptions{…}， 樣例代碼如下：

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

自動(dòng)刪除查找出來(lái)的無(wú)用資源文件

代碼迭代版本一多，很容易會(huì)遺留一些無(wú)用的代碼、資源文件，我們可以使用 Lint 進(jìn)行清除。

點(diǎn)擊 Android Studio 工具欄 -> Analyze -> Run Inspection By Name..，輸入要檢測(cè)的內(nèi)容，這里是無(wú)用資源： 

然后選擇 Unused resources，再選擇范圍后就開(kāi)始檢測(cè)。

檢測(cè)出這么多無(wú)用文件： 

注意，右邊有解決方法： Remove All Unused Resources ，放個(gè)大圖顯眼一點(diǎn)： 

點(diǎn)擊后，boom ，從此世界清靜了。

Lint 是優(yōu)秀程序員之友，吾日三省吾身，今日 Lint 了沒(méi)?!