標籤:write schema 搜尋 for ide 表徵圖 turn 空間 uri
讀完本文你將瞭解到:
-
- 前言
- 什麼是 Lint
- Lint 工作方式簡單介紹
- 從命令列運行 Lint
- Android Studio 中使用 Lint
- 團隊中建立代碼規範利器提升降低問題的等級
- Lint 雖好也不能貪杯
- 在 Java 代碼中忽略 Lint 警告
- 在 XML代碼中忽略 Lint 警告
- Gradle 中配置 Lint
- 自動刪除尋找出來的無用資源檔
- 總結
- Thanks
前言
在保證代碼沒有功能問題,完成業務開發之餘,有追求的程式員還要追求代碼的規範、可維護性。
今天,以“成為優秀的程式員”為目標的拭心將和大家一起精益求精,學習使用 Lint 最佳化我們的代碼。
什麼是 Lint
Lint 是Android Studio 提供的 代碼掃描分析工具,它可以協助我們發現代碼結構/品質問題,同時提供一些解決方案,而且這個過程不需要我們手寫測試案例。
Lint 發現的每個問題都有描述資訊和等級(和測試發現 bug 很相似),我們可以很方便地定位問題,同時按照嚴重程度進行解決。
當然這個“嚴重程度”我們可以手動調節,有些原則問題不容侵犯,必須提升到 error,而有的個別問題也可以無視,畢竟人非聖賢孰能無過嘛。
Lint 工作方式簡單介紹
Lint 會根據預先配置的檢測標準檢查我們 Android 項目的源檔案,發現潛在的 bug 或者可以最佳化的地方,最佳化的內容主要包括以下幾方面:
- Correctness:不夠完美的編碼,比如寫入程式碼、使用過時 API 等
- Performance:對效能有影響的編碼,比如:靜態引用,循環參考等
- Internationalization:國際化,直接使用漢字,沒有使用資源引用等
- Security:不安全的編碼,比如在 WebView 中允許使用 JavaScriptInterface 等
- …
Lint 檢測代碼的過程如所示:
- App 源檔案:包括 Java 代碼,XML 代碼,表徵圖,以及 ProGuard 設定檔等
- lint.xml:Lint 檢測的執行標準設定檔,我們可以修改它來允許或者禁止報告一些問題
從命令列運行 Lint
Lint 的命令很簡單:
lint [flags] <project directory>
Lint 也可以使用 Gradle 運行:
Windows:
gradlew lint
Mac:
./gradlew lint
具體命令列相關的操作這裡就不介紹了,因為這個過程實在太痛苦,上一張命令列運行 Lint 後得到的 XML 檔案讓你體驗一下:
看著渾身不舒服,想瞭解如何從命令列使用 Lint 的同學可以點擊這裡前往官方學習。
我們還是直接進入 Lint 的 GUI 操作吧。
Android Studio 中使用 Lint
Android Studio 中內建了 Lint,我們小手一點就可以直接使用。
Lint 的使用路徑:
工具列 -> Analyze -> Inspect Code…
點擊 Inspect Code 後會彈出檢查範圍的對話方塊:
預設是檢查整個項目,我們可以點擊 Custom scope 自訂檢查範圍。
點擊右邊的下拉框,會出現以下選擇:
分別有:
- Project Files:所有專案檔
- Project Production Files:項目的代碼檔案
- Project Test Files:項目的測試檔案
- OpenFiles:當前開啟的檔案
- Module ‘app’:主要的 app 模組
- Current File:當前檔案
- …
除了內建的選項我們還可以自己選擇特定的類進行檢查,點擊中的紅色框部分:
會彈出自訂範圍選取框,預設是空的,我們可以點擊左上方的“+”號新增一個檢查範圍:
- Local:只能當前項目使用
- Shared:其他 Android Studio 項目也可以使用
我們選擇 Shared,然後起個帥氣的名字 “ShixinCuteLint”,預設按項目顯示,這時檢查的檔案數為 0 :
中右邊的四個按鈕表示要操作的類型:
- Include:包括當前檔案夾內的檔案,但不包括他的子檔案夾
- Include Recursively:包括當前檔案夾以及它的子檔案夾內所有的檔案夾,遞迴添加
- Exclude:移除當前檔案夾,不包括子檔案夾
- Exclude Recursively:移除當前檔案夾及所有子檔案夾
我們點擊左邊的 app 檔案夾後,點擊右邊的 Include Recursively 按鈕,把 app 下的所有檔案添加到檢查列表:
可以看到,這時 app 下的檔案都變綠了,總共有 689 個檔案夾要掃描。
點擊 OK 進行檢測,稍等一會兒,會彈出 Inspection 對話方塊,顯示檢查結果,沒想到My Code居然有 1769 個警告!這數字觸目驚心啊:
我們主要關注紅框內的警告,先來看看My Code Performance 有什麼問題:
哈哈,沒想到我還有這麼多進步空間!
可以看到,Lint 真是神器,可以幫我們發現自己忽略或者沒有意識到的問題,尤其是效能方面,如果你覺得自己代碼想最佳化又不知道從何做起,不妨讓 Lint 給你指指路。
團隊中建立代碼規範利器:提升、降低問題的等級
雖然 Lint 可以幫我們檢查代碼的問題,但多人合作時,我們更期望可以在寫代碼時就發現問題、解決問題。
鑒於團隊成員中水平良莠不齊,靠個人意識有時候很難保證品質,這時可以修改 Lint 對於特定問題的警告層級,以最直觀的 IDE 提示來警醒成員。
Lint 的警告嚴重程度有以下幾種:
- Unused Entry:沒有使用的屬性,灰色,很不起眼
- Typo:拼字錯誤,綠色波浪底線,也不太起眼
- Server Problem:伺服器錯誤?好像不是
- Info:注釋文檔,綠色,比較顯眼
- Weak Warning:比較弱的警告,提示比較弱
- Warning:警告,略微顯眼一點
- Error:錯誤,最顯眼的一個
日常開發中,好一點的程式員會關注 Warning 的警告,根據警告最佳化代碼,但那也只是很少一部分。但是紅色的 Error 就不一樣了,基本上看到就想要消滅掉。
我們拿命名拼字錯誤舉個例子。
類、對象、遍曆拼字錯誤看起來不是什麼問題,但是如果你見過大量的無意義或者錯誤命名,你一定會贊同我的接下來做法。
預設的拼字錯誤是 Typo ,提示很弱,所以常被人忽略:
上面的 String 類型變數 login 寫成了 logn,Lint 預設對拼字錯誤是個下滑波浪線,很不起眼。我們修改一下。
開啟 Preferences/Settings,搜尋 Inspections,會出現 Lint 的檢測配置頁面:
要修改拼字的警告層級,搜尋“spelling”:
然後選擇出現的 Typo,再點擊右邊的 Severity 就是嚴重程度,改成 Error,OK。
可以看到,現在拼字錯誤就會出現紅色的錯誤警告了,讓你不好好寫變數名!
Lint 雖好,也不能貪杯。
Lint 就像是一個潔癖患者,雖然可以讓我們代碼乾淨許多,但是如果真要把它提示的全解決,恐怕老闆要發怒了:給你發工資天天玩電腦,怎麼不出活呢?!
Lint 報的某些警告的確是沒必要,這時我們可以選擇忽略這些警告。忽略警告可以分兩種:
- 在 Java 代碼中
- 在 XML 檔案夾中
在 Java 代碼中忽略 Lint 警告:
忽略 Lint 警告的註解跟 @SuppressWarnings 很類似,@SuppressLint(“忽略的警告名稱”)。
下面的代碼示範了如何忽略 Lint 對使用新 API 的警告:
@SuppressLint("NewApi")@Overridepublic void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.main);}
要是你不清楚要忽略的警告具體是什麼名字,那就直接忽略 all,當然是當前類/方法/對象:
@SuppressLint("all")
在 XML代碼中忽略 Lint 警告:
只需兩步:
- xml 中聲明 tools 命名空間
- 使用 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 的關鍵操作,比如是否開啟 Lint 警告,或者關閉指定的警告。
在 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 }}...
自動刪除尋找出來的無用資源檔
代碼迭代版本一多,很容易會遺留一些無用的代碼、資源檔,我們可以使用 Lint 進行清除。
點擊 Android Studio 工具列 -> Analyze -> Run Inspection By Name..,輸入要檢測的內容,這裡是無用資源:
然後選擇 Unused resources,再選擇範圍後就開始檢測。
檢測出這麼多無用檔案:
注意,右邊有解決方案:Remove All Unused Resources,放個大圖顯眼一點:
點擊後,boom ,從此世界清靜了。
總結
Lint 是優秀程式員之友,吾日三省吾身,今日 Lint 了沒?!
歡迎掃描關注我的公眾號 安卓進化論,第一時間閱讀文章~
Thanks
https://developer.android.com/studio/write/lint.html
http://blog.csdn.net/u010687392/article/details/47835743
http://www.jianshu.com/p/991155725a68
Android 效能最佳化:使用 Lint 最佳化代碼、去除多餘資源