代碼靜態檢查推薦:html
(1)Android自定義Lint實踐android
(2)美團外賣Android Lint代碼檢查實踐程序員
(3)Android自定義Lint實踐2——改進原生Detector安全
Lint 是 Android Studio 提供的 代碼掃描分析工具,它能夠幫助咱們發現代碼結構/質量問題,同時提供一些解決方案,並且這個過程不須要咱們手寫測試用例。服務器
Lint工做方式簡介app
Lint 會根據預先配置的檢測標準檢查咱們 Android 項目的源文件,發現潛在的 bug 或者能夠優化的地方,優化的內容主要包括如下幾方面:工具
Correctness:不夠完美的編碼,好比硬編碼(國際化問題)、使用過期 API 等佈局
Performance:對性能有影響的編碼,好比:靜態引用,循環引用等,性能
佈局性能(之前是 layoutopt工具,能夠解決無用佈局、嵌套太多、佈局太多、overdraw)測試
其餘性能(如:draw/layout 時進行對象的聲明等)
Internationalization:國際化,直接使用漢字,沒有使用資源引用等
Security:不安全的編碼,好比在 WebView 中容許使用 JavaScriptInterface 等
其餘等等。
Lint 檢測代碼的過程以下圖所示:
App 源文件:包括 Java 代碼,XML 代碼,圖標,以及 ProGuard 配置文件等
lint.xml:Lint 檢測的執行標準配置文件,咱們能夠修改它來容許或者禁止報告一些問題
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 對話框,顯示檢查結果,沒想到個人代碼竟然有 1769 個警告!這數字觸目驚心啊:
咱們主要關注紅框內的警告,先來看看個人代碼 Performance 有什麼問題:
咱們主要關注紅框內的警告,先來看看個人代碼 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 報的某些警告的確是不必,這時咱們能夠選擇忽略這些警告。忽略警告能夠分兩種:
1. 在 Java 代碼中
2. 在 XML 文件夾中
在 Java 代碼中忽略 Lint 警告
忽略 Lint 警告的註解跟 @SuppressWarnings 很相似,@SuppressLint(「忽略的警告名稱」)。
下面的代碼演示瞭如何忽略 Lint 對使用新 API 的警告:
要是你不清楚要忽略的警告具體是什麼名字,那就直接忽略 all,固然是當前類/方法/對象:
1 @SuppressLint("all")
在 XML代碼中忽略 Lint 警告
只需兩步:
1. xml 中聲明 tools 命名空間
2. 使用 tools:ignore=」忽略的警告名」
例如:
Gradle配置Lint
Gradle 中也能夠配置 Lint 的關鍵操做,好比是否開啓 Lint 警告,或者關閉指定的警告。
在 module 下的 build.gradle 中添加 lintOptions{…}, 樣例代碼以下:
自動刪除無用資源文件
代碼迭代版本一多,很容易會遺留一些無用的代碼、資源文件,咱們可使用 Lint 進行清除。
點擊 Android Studio 工具欄 -> Analyze -> Run Inspection By Name..,輸入要檢測的內容,這裏是無用資源:
而後選擇 Unused resources,再選擇範圍後就開始檢測。
檢測出這麼多無用文件:
注意,右邊有解決方法:Remove All Unused Resources,放個大圖顯眼一點: