android官方技術(shù)文檔翻譯——Android Lint

時(shí)間：2014-12-02 22:26:54

關(guān)鍵字： Android SCANNING HTML TRANS

手機(jī)看文章

掃描二維碼
隨時(shí)隨地手機(jī)看文章

[導(dǎo)讀] Android Lint是在ADT 16(和 Tools 16)引入的一個(gè)新工具，可以?huà)呙鐰ndroid 項(xiàng)目源碼中潛在的bug 。它可同時(shí)作為一個(gè)命令行工具，以及集??成在Eclipse(如下所述)，和Intell

Android Lint是在ADT 16(和 Tools 16)引入的一個(gè)新工具，可以?huà)呙鐰ndroid 項(xiàng)目源碼中潛在的bug 。它可同時(shí)作為一個(gè)命令行工具，以及集??成在Eclipse(如下所述)，和IntelliJ(詳細(xì)信息)中。這個(gè)架構(gòu)是有意獨(dú)立于IDE的，因此它有希望與其他的IDE，其他的構(gòu)建工具和持續(xù)集成系統(tǒng)集成。

以下是它進(jìn)行掃描的一些錯(cuò)誤類(lèi)型的例子：

缺少翻譯(和未使用的翻譯)

布局性能問(wèn)題(老的layoutopt工具會(huì)用于查找所有這樣的問(wèn)題，和除此之外更多的問(wèn)題)

未使用的資源

不一致的數(shù)組大小(當(dāng)在多個(gè)配置中定義數(shù)組)

可訪問(wèn)性和國(guó)際化問(wèn)題(硬編碼字符串，缺少contentDescription等)

圖標(biāo)問(wèn)題 (如丟失密度、重復(fù)圖標(biāo)、錯(cuò)誤尺寸等)

可用性問(wèn)題 (如不在文本字段上指定輸入的類(lèi)型)

清單錯(cuò)誤以及其他更多的問(wèn)題。

請(qǐng)參閱此文檔以了解當(dāng)前 lint 檢查的問(wèn)題的完整列表。有關(guān)如何取消顯示(suppress)特定的 lint 警告信息，請(qǐng)參閱取消警告顯示的文檔.

如果你對(duì)編寫(xiě)自定義的lint 檢查有興趣，可以參閱編寫(xiě)新的 Lint 檢查和編寫(xiě)自定義 Lint 規(guī)則。

命令行用法

在 SDK 工具目錄有一個(gè)命令行工具叫做 lint。如果在你的path上已經(jīng)配置了 SDK 的tools/ 目錄，您可以使用“lint”來(lái)調(diào)用它。只需指向一個(gè)特定的 Android 項(xiàng)目目錄。你也可以指向一個(gè)隨機(jī)的目錄，(如果它不是一個(gè) Android 的項(xiàng)目)將以遞歸方式搜索，并將檢查該目錄下的所有項(xiàng)目。(你還可以指定通過(guò)空格分隔的多個(gè)項(xiàng)目)。

$ lint /src/astrid/

Scanning GreenDroid-GoogleAPIs: ..

Scanning stream: ...

Scanning api: ...........................

Scanning GDCatalog: .......................

Scanning GreenDroid: ...........................................................

Scanning tests: ...

Scanning filters: ....

Scanning tests: .....

Scanning astrid: ....................................................................................................................................................

Scanning simple: .......

api/res/values-ca: Error: Locale ca is missing translations for: sync_SPr_bgwifi_key, sync_SPr_forget_key, sync_SPr_interval_values, sync_SPr_logged_in_prefix... (2 more) [MissingTranslation]

astrid/res/values-ca: Error: Locale ca is missing translations for: DLG_cancel, DLG_dismiss, DLG_ok, EPr_deactivated... (117 more) [MissingTranslation]

api/res/values-cs: Error: Locale cs is missing translations for: sync_SPr_bgwifi_key, sync_SPr_forget_key, sync_SPr_interval_values, sync_SPr_logged_in_prefix... (2 more) [MissingTranslation]

(many lines omitted)

43 errors, 466 warnings

禁用檢查

每種錯(cuò)誤類(lèi)型的“ID”都顯示在錯(cuò)誤消息后面的括號(hào)中，如上面的“MissingTranslation”。

您可以通過(guò)添加 --disable argument，禁用一個(gè)特定的檢查，或一列的檢查，例如：

$ lint --disable MissingTranslation,UnusedIds,Usability:Icons /src/astrid/

注意，您也可以列出類(lèi)別，比如上面的“Usability:Icons”，就是用性類(lèi)別的圖標(biāo)子類(lèi)別。

有些檢查默認(rèn)情況下牌禁用狀態(tài)?？梢酝ㄟ^(guò)添加--enable標(biāo)志啟用它們。

最后，您可以通過(guò)--check標(biāo)志指定運(yùn)行哪些確切的檢查。這讓你可以在代碼庫(kù)中查找一個(gè)具體的問(wèn)題，比如：

$ lint --check MissingPrefix /src/astrid/

如果要找出哪個(gè) id 和類(lèi)別是可用的，請(qǐng)運(yùn)行

$ lint --list

Valid issue categories:

Correctness

Security

Performance

Usability

Usability:Icons

Accessibility

Internationalization

Valid issue id‘s:

ContentDescription: Ensures that image widgets provide a contentDescription

DuplicateIds: Checks for duplicate ids within a single layout

StateListReachable: Looks for unreachable states in a

InefficientWeight: Looks for inefficient weight declarations in LinearLayouts

ScrollViewSize: Checks that ScrollViews use wrap_content in scrolling dimension

MergeRootFrame: Checks whether a root can be replaced with atag

...

使用--show命令加上 id 列表或類(lèi)別 (或不帶參數(shù)查看全部)可以獲取指定的問(wèn)題的解釋?zhuān)?/p>

$ lint --show MissingPrefix

MissingPrefix

-------------

Summary: Detect XML attributes not using the Android namespace

Priority: 8 / 10

Severity: Warning

Category: Correctness

Most Android views have attributes in the Android namespace. When

referencing these attributes you *must* include the namespace prefix,

or your attribute will be interpreted by aapt as just a custom

attribute.

HTML 報(bào)表

這個(gè)命令行工具還可以生成HTML報(bào)告。這相比普通的 lint 輸出有一定的優(yōu)勢(shì)：

它包含每個(gè)問(wèn)題相關(guān)的更長(zhǎng)的解釋?zhuān)⑼ㄟ^(guò)一個(gè)More info 的屬性提供關(guān)于這個(gè)問(wèn)題的更詳細(xì)信息的鏈接。

它包含有錯(cuò)誤的實(shí)際的源代碼行 (上下各有三行代碼的一個(gè)窗口)。

它可以包含關(guān)聯(lián)到該源代碼文件的鏈接

對(duì)于錯(cuò)誤圖標(biāo)，為能夠比較起見(jiàn)，在報(bào)告中會(huì)顯示圖標(biāo)本身要生成 HTML 報(bào)告，只需要添加--html 文件名作為參數(shù)：[!--empirenews.page--]

$ lint --html /tmp/report.html

默認(rèn)情況下，鏈接到源代碼文件將只使用本地的 file:// 路徑資源。您可以通過(guò) --url 選項(xiàng)把 URL 重新映射向不同的前綴。例如：

$ lint --html /tmp/report.html --url /src/MyProj=http://buildserver/src/MyProj

其他命令行選項(xiàng)

運(yùn)行l(wèi)int --help以獲取可用參數(shù)的相關(guān)信息。

Eclipse 中的用法

注：此文檔是在 lint 首次發(fā)布時(shí)編寫(xiě)的。Eclipse 集成已經(jīng)有了顯著的提高。欲了解更多最新的詳細(xì)信息，請(qǐng)參閱新的Eclipse Lint UI(New Eclipse Lint UI)，布局編輯器 Lint 反饋(Layout Editor Lint Feedback) 和 Lint 保存(Lint On Save).

Lint 在 ADT 16及更高的版本上集成。該集成提供了上述 Lint 命令行版本的幾個(gè)功能：

自動(dòng)修復(fù)許多警告

Lint 可以在各種編輯器操作中自動(dòng)運(yùn)行

屏幕某些錯(cuò)誤類(lèi)型及特定的錯(cuò)誤實(shí)例

配置問(wèn)題檢查嚴(yán)重程度

從 lint 視圖直接跳轉(zhuǎn)到問(wèn)題源碼

Lint 自動(dòng)化

在以下情況時(shí) lint 會(huì)自動(dòng)運(yùn)行：

導(dǎo)出 APK。在這種情況下,會(huì)以特殊模式運(yùn)行 lint，它將只查找致命錯(cuò)誤 (這樣會(huì)更快)，并且如果發(fā)現(xiàn)了任何錯(cuò)誤的時(shí)候會(huì)中止導(dǎo)出。你可以在 Lint 選項(xiàng)中關(guān)閉它。

編輯并保存和 XML 文件，例如布局文件或清單文件。在這種情況下，所有適用于給定文件的文件范圍檢查都會(huì)運(yùn)行，并且會(huì)為任何已發(fā)現(xiàn)的問(wèn)題加上編輯器的標(biāo)記。

使用布局編輯器。每個(gè) UI 操作后，在布局文件上會(huì)運(yùn)行文件范圍檢查 (如各種 layoutopt 規(guī)則)，并且結(jié)果將顯示在一個(gè)特別的 lint 窗口(當(dāng)發(fā)現(xiàn)錯(cuò)誤時(shí)它可以從顯示在布局編輯器的右上角的錯(cuò)誤標(biāo)記中打開(kāi))。

Lint 窗口

要在一個(gè)項(xiàng)目上運(yùn)行 Lint，請(qǐng)?jiān)诎鼮g覽器中選擇項(xiàng)目，然后單擊 Lint 工具欄上的功能(見(jiàn)下面的圖片)。

或者您可以在項(xiàng)目上右擊，在 Android Tools 子菜單中，有一個(gè)“運(yùn)行 Lint”的功能。它將打開(kāi)一個(gè) Lint 窗口，其中包含各種錯(cuò)誤。選擇一個(gè)錯(cuò)誤將會(huì)在右側(cè)的文本區(qū)顯示相關(guān)聯(lián)的解釋。

如果 lint 視圖上有任何錯(cuò)誤，你可以在錯(cuò)誤上雙擊，來(lái)跳轉(zhuǎn)到相關(guān)聯(lián)的源代碼位置。每個(gè)警告圖標(biāo)將顯示其嚴(yán)重程度，并具對(duì)于已修復(fù)的警告(見(jiàn)下一節(jié))會(huì)有一個(gè)小燈泡重疊。

該窗口也有一個(gè)操作欄(在右上角)，它可以讓你

再次運(yùn)行 lint 檢查以刷新結(jié)果 (在刷新期間它會(huì)變成一個(gè) Stop 按鈕，用于中止檢查)

如果有錯(cuò)誤，運(yùn)行與此錯(cuò)誤相關(guān)聯(lián)的修復(fù)

忽略此修復(fù)

刪除警告標(biāo)記

刪除所有的警告標(biāo)記

快速修復(fù)

許多 lint 警告有自動(dòng)修復(fù)功能。例如，各種 layoutopt 修復(fù)的替換提示 (如替換 wrap_content 為 0dp)。

從 lint 視圖中，單擊燈泡來(lái)調(diào)用一個(gè)修復(fù)程序。

從布局編輯器警告摘要中，單擊修復(fù)按鈕來(lái)修復(fù)。

從 XML 代碼編輯器中，調(diào)用快速修復(fù) (Ctrl+1 或Command+1)并選擇與該警告關(guān)聯(lián)的快速修復(fù)。

取消錯(cuò)誤警告的顯示

從編輯器快速修復(fù)菜單中，你也可以選擇

僅忽略此文件中的這個(gè)警告

忽略此項(xiàng)目中的這個(gè)警告

在此期間忽略此警告。

通過(guò)添加注解或?qū)傩院雎源藦V告，此處有解釋。

(如果你在 quickfix 列表找不到 lint 的修復(fù)操作，請(qǐng)參閱已知 Bug 章節(jié))

這些選擇都存儲(chǔ)項(xiàng)目里名為lint.xml的文件中，可以通過(guò)命令行工具讀取。因此，您可以在 UI 中忽略警告，并在你的源項(xiàng)目關(guān)聯(lián)的lint.xml文件中進(jìn)行記錄，其他運(yùn)行著的lint將不會(huì)看到你已經(jīng)忽略的警告(大概是因?yàn)橐呀?jīng)手動(dòng)驗(yàn)證了)。

選項(xiàng)

要編輯用于所有項(xiàng)目備用選項(xiàng)的 lint 全局選項(xiàng)，可以調(diào)用正常的 Eclipse 選項(xiàng)對(duì)話(huà)框，并選擇 Android > Lint Options：

如果你選擇了一個(gè)問(wèn)題，您可以在右下角的下拉列表中編輯其嚴(yán)重程度。這使您可以把某些問(wèn)題指定為 Error(即會(huì)在啟用了靠近頂部的對(duì)話(huà)框中的選項(xiàng)的情況下中止導(dǎo)出 APK)。

要完全關(guān)閉問(wèn)題檢查，請(qǐng)選擇“Ignore”作為嚴(yán)重程度。

請(qǐng)注意此操作不會(huì)編輯每個(gè)項(xiàng)目的 lint 設(shè)置

。打開(kāi)項(xiàng)目設(shè)置對(duì)話(huà)框 (右擊該項(xiàng)目)，你將在這里找到 Android Lint 的屬性頁(yè)。在選項(xiàng)對(duì)話(huà)框中手動(dòng)嚴(yán)重性編輯也會(huì)與取消顯示的錯(cuò)誤一起被記錄在lint.xml文件中，所以您的團(tuán)隊(duì)中的其他人將會(huì)獲得你對(duì)這個(gè)項(xiàng)目編輯的相同的嚴(yán)重性設(shè)置。子頁(yè) (2)：取消 Lint 警告的顯示(Suppressing Lint Warnings) 編寫(xiě)一個(gè) Lint 檢查(Writing a Lint Check)