Android Proto3 實戰開發問題一:方法數過大

使用Proto3作為開發相當折騰,經常會出現一些想不到的問題,網上的資源看著比較少,所以我都記錄一下開發中遇到的問題,以便自己遇到可以馬上解決,或者幫助一下其他人,或者你們看見我的有誤可以幫我糾正或者優化一下,互相進步。

這次出現的問題是:隨著項目的越來越大,Protocol Buffer的結構文件也補充越來越多,編譯生成相關的java文件之后發現單個文件居然有1630多K了

Paste_Image.png

5萬 多行

當我拖進As項目中去的時候,要等好半天編輯器才開始反應過來,

運行的時候也是沒有問題的,但是到打包的時候出現了這個錯誤:

Error:Execution failed for task ':app:transformClassesWithDexForRelease'.
> com.android.build.api.transform.TransformException: 
com.android.ide.common.process.ProcessException: 
java.util.concurrent.ExecutionException: com.android.dex.DexIndexOverflowException: 
method ID not in [0, 0xffff]: 65536

簡單的翻譯就是 配置方法數超過 64K
查了一下官方手冊,早期版本的構建系統按如下方式報告這一錯誤:

Conversion to Dalvik format failed:
Unable to execute dex: method ID not in [0, 0xffff]: 65536

較新版本的 Android 構建系統雖然顯示的錯誤不同,但指示的是同一問題:

trouble writing output:
Too many field references: 131000; max is 65536.
You may try using --multi-dex option.

這些錯誤狀況都會顯示下面這個數字:65,536。這個數字很重要,因為它代表的是單個Dalvik Executable (DEX) 字節碼文件內的代碼可調用的引用總數。本頁介紹如何通過啟用被稱為 Dalvik 可執行文件分包的應用配置來越過這一限制,使您的應用能夠構建并讀取 Dalvik 可執行文件分包 DEX 文件。

這里普及一些知識:

關于 64K 引用限制

Android 應用 (APK) 文件包含 Dalvik Executable (DEX) 文件形式的可執行字節碼文件,其中包含用來運行您的應用的已編譯代碼。Dalvik Executable 規范將可在單個 DEX 文件內可引用的方法總數限制在 65,536,其中包括 Android 框架方法、庫方法以及您自己代碼中的方法。在計算機科學領域內,術語千(簡稱 K)表示 1024(或 2^10)。由于 65,536 等于 64 X 1024,因此這一限制也稱為“64K 引用限制”。

Android 5.0 之前版本的 Dalvik 可執行文件分包支持

Android 5.0(API 級別 21)之前的平臺版本使用 Dalvik 運行時來執行應用代碼。默認情況下,Dalvik 限制應用的每個 APK 只能使用單個 classes.dex 字節碼文件。要想繞過這一限制,您可以使用 Dalvik 可執行文件分包支持庫,它會成為您的應用主要 DEX 文件的一部分,然后管理對其他 DEX 文件及其所包含代碼的訪問。

:如果您的項目配置時所面向的 Dalvik 可執行文件分包使用的是 minSdkVersion 20
或更低版本,并且您將其部署到運行 Android 4.4(API 級別 20)或更低版本的目標設備上,則 Android Studio 會停用 Instant Run

Android 5.0 及更高版本的 Dalvik 可執行文件分包支持

Android 5.0(API 級別 21)及更高版本使用名為 ART 的運行時,后者原生支持從 APK 文件加載多個 DEX 文件。ART 在應用安裝時執行預編譯,掃描classesN.dex文件,并將它們編譯成單個 .oat 文件,供 Android 設備執行。因此,如果您的 minSdkVersion 為 21 或更高值,則不需要 Dalvik 可執行文件分包支持庫。
如需了解有關 Android 5.0 運行時的詳細信息,請參閱 ART 和 Dalvik

:如果將應用的 minSdkVersion 設置為 21 或更高值,使用 Instant Run 時,Android Studio 會自動將應用配置為進行 Dalvik 可執行文件分包。由于 Instant Run 僅適用于調試版本的應用,您仍需配置發布構建進行 Dalvik 可執行文件分包,以規避 64K 限制。

規避 64K 限制

在將您的應用配置為支持使用 64K 或更多方法引用之前,您應該采取措施減少應用代碼調用的引用總數,包括由您的應用代碼或包含的庫定義的方法。下列策略可幫助您避免達到 DEX 引用限制:檢查您的應用的直接和傳遞依賴項 - 確保您在應用中使用任何龐大依賴庫所帶來的好處大于為應用添加大量代碼所帶來的弊端。一種常見的反面模式是,僅僅為了使用幾個實用方法就在應用中加入非常龐大的庫。減少您的應用代碼依賴項往往能夠幫助您規避 dex 引用限制。
通過 ProGuard 移除未使用的代碼 - 為您的版本構建啟用代碼壓縮以運行 ProGuard。啟用壓縮可確保您交付的 APK 不含有未使用的代碼。

使用這些技巧使您不必在應用中啟用 Dalvik 可執行文件分包,同時還會減小 APK 的總體大小。

配置您的應用進行 Dalvik 可執行文件分包

將您的應用項目設置為使用 Dalvik 可執行文件分包配置需要對您的應用項目進行以下修改,具體取決于應用支持的最低 Android 版本。

  • 如果您的 minSdkVersion 設置為 21 或更高值,您只需在模塊級 build.gradle 文件中將 multiDexEnabled 設置為 true,如此處所示:
android {
    defaultConfig {
        ...
        minSdkVersion 21 
        targetSdkVersion 26
        multiDexEnabled true
    }
    ...
}
  • 但是,如果您的 minSdkVersion設置為 20 或更低值,則您必須按如下方式使用 Dalvik 可執行文件分包支持庫
    修改模塊級 build.gradle
    文件以啟用 Dalvik 可執行文件分包,并將 Dalvik 可執行文件分包庫添加為依賴項,如此處所示:
android {
    defaultConfig {
        ...
        minSdkVersion 15 
        targetSdkVersion 26
        multiDexEnabled true
    }
    ...
}

dependencies {
  compile 'com.android.support:multidex:1.0.1'
}
  • 根據是否要替換 Application
    類,執行以下操作之一:
    如果您沒有替換 Application
    類,請編輯清單文件,按如下方式設置 <application>
    標記中的 android:name:
<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.example.myapp">
    <application
            android:name="android.support.multidex.MultiDexApplication" >
        ...
    </application>
</manifest>

如果您替換了 Application
類,請按如下方式對其進行更改以擴展 MultiDexApplication
(如果可能):

public class MyApplication extends MultiDexApplication { ... }

或者,如果您替換了 Application
類,但無法更改基本類,則可以改為替換 attachBaseContext() 方法并調用 MultiDex.install(this) 來啟用 Dalvik 可執行文件分包:

public class MyApplication extends SomeOtherApplication {
  @Override
  protected void attachBaseContext(Context base) {
     super.attachBaseContext(context);
     Multidex.install(this);
  }
}

構建應用后,Android 構建工具會根據需要構建主 DEX 文件 (classes.dex) 和輔助 DEX 文件(classes2.dex 和 classes3.dex 等)。然后,構建系統會將所有 DEX 文件打包到您的 APK 中。

運行時,Dalvik 可執行文件分包 API 使用特殊的類加載器來搜索適用于您的方法的所有 DEX 文件(而不是僅在主 classes.dex 文件中搜索)。

Dalvik 可執行文件分包支持庫的局限性

Dalvik 可執行文件分包支持庫具有一些已知的局限性,將其納入您的應用構建配置之中時,您應該注意這些局限性并進行針對性的測試:

  • 啟動期間在設備數據分區中安裝 DEX 文件的過程相當復雜,如果輔助 DEX 文件較大,可能會導致應用無響應 (ANR) 錯誤。在此情況下,您應該通過 ProGuard 應用代碼壓縮以盡量減小 DEX 文件的大小,并移除未使用的那部分代碼。

  • 由于存在 Dalvik linearAlloc 錯誤(問題 22586),使用 Dalvik 可執行文件分包的應用可能無法在運行的平臺版本早于 Android 4.0(API 級別 14)的設備上啟動。如果您的目標 API 級別低于 14,請務必針對這些版本的平臺進行測試,因為您的應用可能會在啟動時或加載特定類群時出現問題。代碼壓縮可以減少甚至有可能消除這些潛在問題。

  • 由于存在 Dalvik linearAlloc 限制(問題 78035),因此,如果使用 Dalvik 可執行文件分包配置的應用發出非常龐大的內存分配請求,則可能會在運行期間發生崩潰。盡管 Android 4.0(API 級別 14)提高了分配限制,但在 Android 5.0(API 級別 21)之前的 Android 版本上,應用仍有可能遭遇這一限制。

聲明主 DEX 文件中需要的類

為 Dalvik 可執行文件分包構建每個 DEX 文件時,構建工具會執行復雜的決策制定來確定主要 DEX 文件中需要的類,以便應用能夠成功啟動。如果啟動期間需要的任何類未在主 DEX 文件中提供,那么您的應用將崩潰并出現錯誤java.lang.NoClassDefFoundError

該情況不應出現在直接從應用代碼訪問的代碼上,因為構建工具能識別這些代碼路徑,但可能在代碼路徑可見性較低(如使用的庫具有復雜的依賴項)時出現。例如,如果代碼使用自檢機制或從原生代碼調用 Java 方法,那么這些類可能不會被識別為主 DEX 文件中的必需項。

因此,如果您收到java.lang.NoClassDefFoundError,則必須使用構建類型中的 multiDexKeepFilemultiDexKeepProguard
屬性聲明它們,以手動將這些其他類指定為主DEX文件中的必需項。如果類在multiDexKeepFilemultiDexKeepProguard 文件中匹配,則該類會添加至主 DEX 文件。

multiDexKeepFile 屬性

您在 multiDexKeepFile 中指定的文件應該每行包含一個類,并且采用 com/example/MyClass.class 的格式。例如,您可以創建一個名為multidex-config.txt 的文件,如下所示:

com/example/MyClass.class
com/example/MyOtherClass.class

然后,您可以按以下方式針對構建類型聲明該文件:

android {
    buildTypes {
        release {
            multiDexKeepFile file 'multidex-config.txt'
            ...
        }
    }
}

請記住,Gradle 會讀取相對于build.gradle 文件的路徑,因此如果 multidex-config.txtbuild.gradle文件在同一目錄中,以上示例將有效。

multiDexKeepProguard 屬性

multiDexKeepProguard 文件使用與 Proguard 相同的格式,并且支持整個 Proguard 語法。如需了解有關 Proguard 格式和語法的詳細信息,請參閱 Proguard 手冊中的 Keep Options 一節。

您在 multiDexKeepProguard中指定的文件應該在任何有效的 ProGuard 語法中包含 -keep 選項。例如,-keep com.example.MyClass.class。您可以創建一個名為 multidex-config.pro 的文件,如下所示:

-keep class com.example.MyClass
-keep class com.example.MyClassToo

如果您想要指定包中的所有類,文件將如下所示:

-keep class com.example.** { *; } // All classes in the com.example package

然后,您可以按以下方式針對構建類型聲明該文件:

android {
    buildTypes {
        release {
            multiDexKeepProguard 'multidex-config.pro'
            ...
        }
    }
}
優化開發構建中的 Dalvik 可執行文件分包

Dalvik 可執行文件分包配置會大幅增加構建處理時間,因為構建系統必須就哪些類必須包括在主 DEX 文件中以及哪些類可以包括在輔助 DEX 文件中作出復雜的決策。這意味著使用 Dalvik 可執行文件分包的增量式構建通常耗時更長,可能會拖慢您的開發進度。

為了縮短耗時更長的 Dalvik 可執行文件分包輸出構建時間,請利用 productFlavors
(一個開發定制和一個發布定制,具有不同的 minSdkVersion 值)創建兩個構建變型。

對于開發定制,將 minSdkVersion 設置為 21。該設置將啟用一個名為 pre-dexing 的構建功能,此功能使用僅適用于 Android 5.0(API 級別 21)和更高版本的 ART 格式更快生成 Dalvik 可執行文件分包輸出。對于發布定制,將 minSdkVersion
設置為適于您的實際最低支持級別。此設置生成的 Dalvik 可執行文件分包 APK 可兼容更多設備,但構建時間更長。

以下構建配置示例展示了如何在 Gradle 構建文件中設置這些定制:

android {
    defaultConfig {
        ...
        multiDexEnabled true
    }
    productFlavors {
        dev {
            // Enable pre-dexing to produce an APK that can be tested on
            // Android 5.0+ without the time-consuming DEX build processes.
            minSdkVersion 21
        }
        prod {
            // The actual minSdkVersion for the production version.
            minSdkVersion 14
        }
    } 
   buildTypes {
        release {
            minifyEnabled true
            proguardFiles getDefaultProguardFile('proguard-android.txt'),
                                                 'proguard-rules.pro'
        }
    }
}

dependencies {
    compile 'com.android.support:multidex:1.0.1'
}

您完成此配置變更后,可以為增量式構建使用應用的 devDebug變體,后者集 dev 產品定制與 debug構建類型的屬性于一身。這將創建已啟用 Dalvik 可執行文件分包且禁用 proguard 的可調試應用(因為 minifyEnabled默認為 false)。這些設置會使適用于 Gradle 的 Android 插件執行以下操作:

  • 執行 pre-dexing:將每個應用模塊和每個依賴項構建為單獨的 DEX 文件。
  • 將每個 DEX 文件加入 APK,并且不做任何修改(不執行代碼壓縮)。
  • 最重要的是,模塊 DEX 文件不執行合并操作,因此可以避免為確定主 DEX 文件的內容而進行長時間的計算。

這些設置的好處是,可以進行快速的增量式構建,因為只有修改過的模塊的 DEX 文件才會在后續構建期間重新計算并重新打包。但是,這些構建的 APK 只能用于在 Android 5.0 設備上進行測試。不過,由于是以定制形式實現配置,您保留了使用與發布相適的最低 API 級別和 ProGuard 代碼壓縮執行正常構建的能力。

您還可以構建其他變體,包括prodDebug 變體構建,該變體雖然構建時間更長,但可用于開發以外的測試。在所示配置內,prodRelease變體將是最終測試和發布版本。如需了解有關使用構建變體的詳細信息,請參閱配置構建變體

提示:由于您有適用于不同 Dalvik 可執行文件分包需求的不同構建變體,因此也可以為不同變體提供不同清單文件(這樣,只有適用于 API 級別 20 和更低版本的清單文件會更改 <application>標記名稱),或者為每個變體創建不同的 Application子類(這樣,只有適用于 API 級別 20 和更低版本的清單文件會擴展 MultiDexApplication 類或調用 MultiDex.install(this))。

測試 Dalvik 可執行文件分包應用

編寫面向 Dalvik 可執行文件分包應用的儀器測試時,無需進行其他配置。AndroidJUnitRunner直接支持 Dalvik 可執行文件分包,前提是您使用MultiDexApplication
或替換您的自定義 Application
對象中的 attachBaseContext() 方法,并調用 MultiDex.install(this)
以啟用 Dalvik 可執行文件分包。

或者,您可以替換 AndroidJUnitRunner 中的 onCreate()方法:

public void onCreate(Bundle arguments) {
    MultiDex.install(getTargetContext());
    super.onCreate(arguments);
    ...
}

:目前不支持使用 Dalvik 可執行文件分包來創建測試 APK。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,363評論 6 532
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,497評論 3 416
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,305評論 0 374
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,962評論 1 311
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,727評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,193評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,257評論 3 441
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,411評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,945評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,777評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,978評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,519評論 5 359
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,216評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,642評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,878評論 1 286
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,657評論 3 391
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,960評論 2 373

推薦閱讀更多精彩內容