Android Quality Essentials

AndroidQualitySentials [中文]

通過靜態代碼分析和運行時檢查改善Android代碼質量：

• 使用CheckStyle命名約定（尤其是用於資源文件）。
• 代碼樣式，帶有CheckStyle。
• 潛在的錯誤，帶有Findbugs，PMD和Android棉絨。
• 潛在的ANR（主線程中的緩慢操作），帶有嚴格模式。
• 資源和內存洩漏，具有嚴格模式和洩漏。

建議您在創建一個新項目並在每個簽到中解決問題（作為連續集成過程的一部分）時添加這些檢查。否則，當您面對並解決大量錯誤時，它將需要巨大的勇氣和耐心。

目錄

• 開始
• 解決問題的提示
  • 允許成員字段以“ M”字母開頭
  • 自動添加“最終”變量
  • 創建實用程序類
• PMD規則的權衡
• 將檢查什麼？
  • 命名約定
  • 使用CheckStyle的代碼樣式
  • 與Findbugs的靜態分析
  • 使用PMD的靜態分析
  • 使用Android棉力分析
  • 使用Strictmode檢查運行時檢查
  • 記憶洩漏檢測與洩漏
• 謝謝
• 執照

開始

1. 將質量目錄添加到您的項目中。
   • 您可以復制它：
     • 同步該項目的代碼，並將質量目錄複製到項目的根目錄。
     • 在您的build.gradle中添加以下行：

      apply from: '../quality/static_analysis.gradle'
     

   • 或添加為遠程模塊。就像我的項目Android-App-Architecture-mvvm-databinding一樣：
     • 添加為遠程模塊：

     git remote add analysis https://github.com/BrianSpace/Android-Quality-Essentials.git

     • 然後在您的build.gradle中：

      apply from: '../analysis/quality/static_analysis.gradle'
     

2. 添加棉布選項

 android {
    ...
    lintOptions {
        // Turn off analysis progress reporting by lint
        quiet true
        // Stop the gradle build if errors are found
        abortOnError true
        // Do not ignore lint warnings
        ignoreWarnings false
        // Treat warnings as errors
        warningsAsErrors true

        // Ignore rules list
        ignore 'GoogleAppIndexingWarning' // Remove this if the app support App Indexing
    }
    ...
}

4. 在您的build.gradle中添加洩漏的依賴性：

 dependencies {
   .. .
   debugCompile ' com.squareup.leakcanary:leakcanary-android:1.5.1 '
   releaseCompile ' com.squareup.leakcanary:leakcanary-android-no-op:1.5.1 '
   testCompile ' com.squareup.leakcanary:leakcanary-android-no-op:1.5.1 '
   .. .
 }

5. 在您的Application類中（不要忘記添加到清單中）：

 public class AndroidQualityEssentialsApplication extends Application {
    @ Override
    public void onCreate () {
        super . onCreate ();
        if ( BuildConfig . DEBUG ) {
            StrictMode . setThreadPolicy ( new StrictMode . ThreadPolicy . Builder ()
                    . detectAll ()
                    . penaltyDeath ()
                    . build ());
            StrictMode . setVmPolicy ( new StrictMode . VmPolicy . Builder ()
                    . detectAll ()
                    . penaltyDeath ()   // If violations are in Android itself or 3rd-party libs, use penaltyLog.
                    . build ());

            // Avoid the process dedicated to LeakCanary for heap analysis.
            if (! LeakCanary . isInAnalyzerProcess ( this )) {
                LeakCanary . install ( this );
            }
        }
        ...
    }
}

6. 在控制台中運行gradlew check以啟動靜態分析。

• 分析報告將位於您應用static_analysis.gradle的項目的build/reports/目錄中。

7. 運行您的調試版本應用程序以進行運行時檢查。
8. 將檢查步驟添加到您的連續集成過程中。

解決問題的提示

允許成員字段以“ M”字母開頭

樣式規則中定義的命名約定不允許單個字母前綴“ mmember”之類的成員字段名稱。但是，如果您喜歡這種樣式，則可以將MemberName模塊的format屬性更改為“^[az] [A-ZA-Z0-9] $”。或更改為“^m [az] [a-za-Z0-9] $”，以強制“ M”前綴。

自動添加“最終”變量

1. 在Android Studio中，選擇“分析” - >“按名稱...”菜單，搜索“最終”，然後在“ Java” - >“代碼樣式問題”下運行以下兩個規則：
   • 場可能是“最終”
   • 本地變量或參數可能是最終的
2. 每次運行後，在結果面板中，單擊“最終”按鈕以自動添加“最終”。

創建實用程序類

對於PMD規則使用式頻道，如果您的類只有靜態字段和方法，它將提示創建實用程序類。您只需要：

• 將您的公用事業類定義為最終。
• 創建一個私人構造函數並在其中拋出例外，以防止實例化。樣本：

 public final class FileUtil {

    private static Context appContext ;

    private FileUtil () throws InstantiationException {
        throw new InstantiationException ( "Utility class FileUtil should not be instantiated!" );
    }

    public static void init ( final Context context ) {
        appContext = context . getApplicationContext ();
    }

    /**
     * Get available cache directory. Prefer external over internal.
     */
    @ NonNull
    public static File getAvailableCacheDir () {
        final File externalCacheDir = appContext . getExternalCacheDir ();
        return externalCacheDir == null ? appContext . getCacheDir () : externalCacheDir ;
    }
}

PMD規則的權衡

所有的靜態分析規則都是人們過去經驗的最佳實踐，但它們並不總是無法破壞的真理。一些PMD規則需要基於您自己的偏好：

1. 輔助類擬南芥此規則更喜歡性能和還原方法計數而不是封裝，通常我會更關心封裝，因此我排除了此規則。但是，如果您更多地關心性能和方法計數（以避免使用多戴克斯），則可以包含它。
2. 仿製藥此規則更喜歡單一的上案字母，以獲得通用值。但是，我更喜歡一些更有意義的名稱，“ t”字母作為後綴，例如ItemTypeT ，以提高可讀性。如果您喜歡單個字母命名，則可以從“排除”列表中刪除它。

將檢查什麼？

命名約定

命名約定在質量/checkStyle/naming_convention.xml文件中定義。定義了以下規則：

1. Java文件：
   • 應該使用駱駝盒。
   • 測試文件應命名為“ test.java”或“ base .java”。
2. 資源文件：
   • 資源文件應使用Snake Case（較低的情況，由下劃線串聯）。
   • 可繪製的物品應以“ bg_”，“ ic_”或“ img_”開頭。
   • 佈局應以“ activy_”，“ fragment_”，“ view_”，“ dialog_”，“ item_”或“ btn_”開頭。
   • 值應以“ attrs_”，“ colors_”，“ dimens_”，“ strings_”或“ styles_”開頭。

您可以根據自己的項目需要修改正則表達式。如果您只想檢查命名約定，請運行gradlew checkFileNames 。

使用CheckStyle的代碼樣式

CheckStyle用於檢查Java代碼樣式。樣式規則基於Google Java樣式指南，並具有以下更改：

• 嚴重性：更改為“錯誤”。
• 線長度：更改為120。
• 凹痕：標籤大小更改為4。
• 方法名：不允許下劃線。
• ConstantName：所有上情況，允許下劃線。

如果您只想檢查代碼樣式，請運行gradlew checkCodeStyle 。如果您想排除第三方代碼之類的某些文件，則可以在static_analysis.gradle文件中的checkCodeStyle任務中添加一個exclude項目。

與Findbugs的靜態分析

FindBugs掃描您的代碼是否可能導致錯誤。此處定義要排除分析的文件。如果您只想運行findbugs，請運行gradlew findBugs 。

使用PMD的靜態分析

PMD是一個靜態代碼分析儀，可以檢測常見的編程缺陷。規則以質量/PMD/PMD-Ruleset.xml定義。規則的完整列表可以在此處找到。如果您只想運行PMD，請運行gradlew pmdCheck 。

使用Android棉力分析

Android lint是一種特定於Android的靜態代碼分析工具。完整的檢查列表在這裡。如果您只想運行棉絨規則，請運行gradlew lint 。

使用Strictmode檢查運行時檢查

嚴格模式對於檢測UI線程和資源洩漏中的緩慢操作非常有用。具體而言，ThreadPolicy將檢測磁盤/網絡I/O並在UI Thead中進行緩慢操作，而VMPolicy將檢測資源洩漏。有關詳細信息，請參閱文檔以獲取threadpolicy.builder and vmpolicy.builder。

記憶洩漏檢測與洩漏

洩漏可以幫助檢測內存洩漏。它具有非常好的UI來報告洩漏並顯示整個參考鏈，以便您可以輕鬆地找到用於修復洩漏的位置。

謝謝

• FindBugs和PMD的靜態分析配置基於https://github.com/ribot/android-boilerplate。

執照

 The MIT License

Copyright (c) 2017-2017 AndroidQualityEssentials project contributors

https://github.com/BrianSpace/AndroidQualityEssentials/graphs/contributors

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.