【騰訊TMQ】管中窺豹：結合NewApi實踐來了解Lint代碼掃描

2019-11-09 17:48:57

字體：大中小

來源：轉載

供稿：網友

導讀

lint是著名的C/C++語言靜態代碼分析工具之一，Android Lint顧名思義，針對Android的靜態代碼分析工具，能夠對Android項目中潛在的bug、可優化的代碼、安全性、性能、可用性、可訪問性、國際化等進行檢查。

在Android SDK Tools 16及更高的版本中，Lint工具會自動安裝。通過對Android工程源代碼等進行掃描檢查，可發現潛在的問題，更好的提升代碼質量。Android Lint提供了命令行方式執行，也與IDE（如Eclipse、Android Studio）集成提供了IDE圖形界面，單獨輸出的xml和html結果報告可以提供更豐富的信息。

lint掃描規則初覽

1. NewApi規則說明

初步掃描手管代碼得到一份html的報告，結果分類比較清晰，但有2000+error，12000+warning，，嚇的手一抖直接關掉了。。

為了降低大家的心理門檻，我們從手管已經接入Daily的NewApi規則來看看lint是怎么工作的

最簡單的，先來看看NewApi規則說明：

可以對NewApi規則有個大致的了解,掃描App中的Android Api，對起始版本大于AndroidManifest.xml中聲明的minSdkVersion，即未加判斷調用的高版本Api進行提示。沒有判斷調用不支持的Api會怎么樣呢?低版本機器在執行到該代碼段時就會拋出NoSuchMethodException異常crash。

2. NewApi掃描結果

再來看看NewApi的掃描結果：

可以看到檢查結果中的issueid、summary、PRiority、severity、category、explanation和說明中是一致的，message中有更詳細的代碼段接口版本說明，location字段中給出了對應的代碼位置。

Issueid：規則名，唯一；

Summary：規則的簡單概述；

Priority：優先級，1~10，10為最嚴重

Severity：嚴重性，Fatal，Error，Warning，Information，Ignore

Category：類別，Correctness 正確性Security 安全性Performance 性能Usability 可用性 accessibility 可達性i18n 國際化

Explanation：規則詳細描述及問題解決建議

lint規則實現原理篇

1.lint規則主要模塊

從NewApi在手管的落地實踐來看NewApi確實是解決Api版本兼容性的一大利器，lint是怎么實現這一規則的呢？lint支持的280+規則都是怎么實現的呢？

我們來看看lint規則的主要模塊：

Issue：lint規則定義，比如NewApi，lint已有規則列表維護在BuiltinIssueRegistry類中，目前lint官網提供有280+個規則，可以按需打開也可以修改各個規則的嚴重級別，已有規則配置可以見實踐篇；

Detetor：檢索項目中檢測項對應的問題，一個檢測器可以檢索多個獨立但相關的問題，比如通過一個檢測器查找多種Manifest相關的問題；

Implematation：連接檢查項和檢測器，也聲明規則的查找范圍，常用的scope包括CLASS_FILE,java_FILE,RESOURCE_FILE等;

Registry：注冊模塊，lint維護了一張所有規則的列表，檢查規則通過注冊添加到規則列表中；

2.NewApi規則注冊類

從NewApi檢查項的注冊定義可以看到，issueid、summary等均在issue注冊時傳入以便在結果報告中展示，Implematations中scope聲明了規則查找范圍，Scope.CLASS_FILE標明了NewApi檢查項針對編譯后的class字節碼進行掃描：

3.NewApi掃描核心類

再來看看NewApi掃描核心的ApiDetector：

ApiDetector檢測器繼承自ResourceXmlDetector并實現Detector.ClassScanner和Detector.JavaScanner接口，Detector類中提供了7種XXXScanner接口

Scanner也并不是直接進行代碼行查找，scanner中通過lombok.ast（Abstract Syntax Tree抽象語法樹） API來進行代碼節點的查找，有興趣的童鞋可以參照Eclipse AST介紹。

掃描規則實際上就是實現detector的過程，每個detector可以定義1個或多個不同類型的issue，像ApiDetector中會處理多個Api調用相關的規則：NewApi，InlinedApi，Override，UnusedAttribute；

繼續查看ApiDetector最主要的checkClass()可以更深入了解NewApi的掃描過程：

Api版本庫中維護了一份Android每個版本Class的類關系和成員變量，是Api兼容性檢測的前提條件

首先進行類掃描處理，如果沒有TargetApi定義的局部miniSDK則獲取AndroidManifest.xml中minSdkVersion定義，首先進行繼承類和接口類的掃描判斷，發現的問題通過report()函數輸出：

掃描結果-類兼容問題

然后開始對類節點的掃描處理，同樣判斷方法前是否有TargetApi標注定義了局部miniSdk，依次檢查類中method、field、LDC引用值，源碼中可以看到在method、field的調用判斷中，也對android常用的版本判斷格式if(Build.VERSION.SDK_INT >= XX)的分支進行判斷檢查

對應的掃描結果中message字段返回了兼容性調用問題的類型及起始版本，并將發現的問題通過report()函數輸出。

掃描結果-Field調用兼容問題：

掃描結果-method調用兼容問題：

自定義掃描規則篇

通過走讀lintNewApi的實現過程，我們也清楚了lint中的規則是如何定義并實現的，我們自己是否也可以參照這個結構來自定義規則呢？答案是肯定的，lint也支持自定義規則擴展，自定義規則通過IssueRegistry加入到規則表中和其他規則一起使用。什么場景適合自定義規則呢？比如手管UI庫的編寫規范，典型問題的修復情況，某些封裝了不建議直接使用的Api的調用等都可以通過自定義規則來規范和提醒。