MultiDex使用方法

隨着應用不斷迭代，業務線的擴展,應用越來越大(比如集成了各種第三方sdk或者公共支持的jar包,項目耦合性高，重複作用的類越來越多)，相信很多人都遇到過如下的錯誤:

UNEXPECTED TOP-LEVEL EXCEPTION:  
java.lang.IllegalArgumentException: method ID not in [0, 0xffff]: 65536  
at com.android.dx.merge.DexMerger$6.updateIndex(DexMerger.java:501)  
at com.android.dx.merge.DexMerger$IdMerger.mergeSorted(DexMerger.java:282)  
at com.android.dx.merge.DexMerger.mergeMethodIds(DexMerger.java:490)  
at com.android.dx.merge.DexMerger.mergeDexes(DexMerger.java:167)  
at com.android.dx.merge.DexMerger.merge(DexMerger.java:188)  
at com.android.dx.command.dexer.Main.mergeLibraryDexBuffers(Main.java:439)  
at com.android.dx.command.dexer.Main.runMonoDex(Main.java:287)  
at com.android.dx.command.dexer.Main.run(Main.java:230)  
at com.android.dx.command.dexer.Main.main(Main.java:199)  
at com.android.dx.command.Main.main(Main.java:103)

沒錯，你的應用中的Dex 文件方法數超過了最大值65536的上限,簡單來說，應用爆棚了.

那麼讓我們看一下爲什麼會引起這種錯誤:

在Android系統中，一個App的所有代碼都在一個Dex文件裏面。Dex是一個類似Jar的存儲了多有Java編譯字節碼的歸檔文件。因爲Android系統使用Dalvik虛擬機，所以需要把使用Java Compiler編譯之後的class文件轉換成Dalvik能夠執行的class文件。這裏需要強調的是，Dex和Jar一樣是一個歸檔文件，裏面仍然是Java代碼對應的字節碼文件。當Android系統啓動一個應用的時候，有一步是對Dex進行優化，這個過程有一個專門的工具來處理，叫DexOpt。DexOpt的執行過程是在第一次加載Dex文件的時候執行的。這個過程會生成一個ODEX文件，即Optimised Dex。執行ODex的效率會比直接執行Dex文件的效率要高很多。但是在早期的Android系統中，DexOpt的LinearAlloc存在着限制: Android 2.2和2.3的緩衝區只有5MB，Android 4.x提高到了8MB或16MB。當方法數量過多導致超出緩衝區大小時，會造成dexopt崩潰,導致無法安裝.

另外由於DEX文件格式限制，一個DEX文件中method個數採用使用原生類型short來索引文件中的方法，也就是4個字節共計最多表達65536個method，field/class的個數也均有此限制。對於DEX文件，則是將工程所需全部class文件合併且壓縮到一個DEX文件期間，也就是Android打包的DEX過程中，單個DEX文件可被引用的方法總數被限制爲65536（自己開發以及所引用的Android Framework和第三方類庫的代碼）.

目前比較常用的方法：(1) 應用插件化,比如使用我正在參與開發的插件化框架 : https://github.com/singwhatiwanna/dynamic-load-apk ,如果有建議或者相關的問題,歡迎到Github上積極參與. (2) 分割Dex,多工程: 把所需要的.class文件或者是Jar文件和一些源碼一起編譯生成一個Jar文件。然後使用Android SDK提供的dx工具把Jar文件轉成Dex文件。(可參考facebook:https://www.facebook.com/notes/facebook-engineering/under-the-hood-dalvik-patch-for-facebook-for-android/10151345597798920,這裏邊還可以看到在2.3上動態改變LinearAlloc緩衝的解決思路) 這兩種方法並不衝突,插件化除了解決應用爆棚，還有很多其他的優點，可以看我之前的文章,不再複述.

當然,Google看來也意識到了目前應用方法數爆棚的問題, 目前在已經在API 21中提供了通用的解決方案，那就是android-support-multidex.jar. 這個jar包最低可以支持到API 4的版本(Android L及以上版本會默認支持mutidex).

讓我們看一下如何應用android-support-multidex.jar(以下都以在Anroid studio中的使用爲例,使用eclipse開發需要安裝gradle插件，其他基本上相同):

首先可以用--multi-dex配置(build.gradle)進行解決,生成的Apk中將包含多個dex文件，比如classes.dex, classes2.dex. 如下，需要對build.gradle進行修改:

afterEvaluate {  
    tasks.matching {  
        it.name.startsWith('dex')  
    }.each { dx ->  
        if (dx.additionalParameters == null) {  
            dx.additionalParameters = []  
        }  
        dx.additionalParameters += '--multi-dex' // enable multidex  
  
        // optional  
        // dx.additionalParameters += "--main-dex-list=$projectDir/<filename>".toString() // enable the main-dex-list  
    }  
}

但是默認的Dalvik 類加載器只會尋找classes.dex,所以需要將它們進行合併才能使得被識別

當然，現在有了android.support.multidex.jar的支持,一切都會變得非常簡單,首先我們看一下相關源碼的目錄,具體的原理分析我會在之後的文章中進行講解:

android/support/multidex/BuildConfig.class  
android/support/multidex/MultiDex$V14.class  
android/support/multidex/MultiDex$V19.class  
android/support/multidex/MultiDex$V4.class  
android/support/multidex/MultiDex.class  
android/support/multidex/MultiDexApplication.class  
android/support/multidex/MultiDexExtractor$1.class  
android/support/multidex/MultiDexExtractor.class  
android/support/multidex/ZipUtil$CentralDirectory.class  
android/support/multidex/ZipUtil.class

具體集成:
將如下配置加入工程 build.gradle中

android {  
    defaultConfig {  
        // Enabling multidex support.  
        multiDexEnabled true  
    }  
}  
dependencies {  compile 'com.google.android:multidex:0.1'}

MultiDex實現原理:

Apk在運行的時候，有一個dexpathlist，而Multidex的源碼中，會根據你的系統版本號對dexpathlist做修改，將所有的dex都添加到dexpathlist中.

接下來集成有兩個步驟:

一. 從sdk\extras\android\support\multidex\library\libs 目錄將android-support-multidex.jar導入工程中

二. 如果你的工程中已經含有Application類,那麼讓它繼承android.support.multidex.MultiDexApplication類,

如果你的Application已經繼承了其他類並且不想做改動，那麼還有另外一種使用方式,覆寫attachBaseContext()方法:

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

最後給出build.gradle中的完整配置:

android {  
    compileSdkVersion 21  
    buildToolsVersion "21.1.0"  
  
    defaultConfig {  
        ...  
        minSdkVersion 14  
        targetSdkVersion 21  
        ...  
  
        // Enabling multidex support.  
        multiDexEnabled true  
    }  
    ...  
}  
  
dependencies {  
  compile 'com.android.support:multidex:1.0.0'  
}

使用MutiDex的主意事項

一. 如果你繼承了MutiDexApplication或者覆寫了Application中的attachBaseContext()方法.

Application類中邏輯的注意事項:

Application 中的靜態全局變量會比MutiDex的 instal()方法優先加載，所以建議避免在Application類中使用靜態變量引用main classes.dex文件以外dex文件中的類，可以根據如下所示的方式進行修改:

@Override  
    public void onCreate() {  
        super.onCreate();  
  
        final Context mContext = this;  
        new Runnable() {  
  
            @Override  
            public void run() {  
                // put your logic here!  
                // use the mContext instead of this here  
            }  
        }.run();  
    }

二. 雖然Google解決了應用總方法數限制的問題，但並不意味着開發者可以任意擴大項目規模。Multidex仍有一些限制：

DEX文件安裝到設備的過程非常複雜，如果第二個DEX文件太大，可能導致應用無響應。此時應該使用ProGuard減小DEX文件的大小。
由於Dalvik linearAlloc的Bug，應用可能無法在Android 4.0之前的版本啓動，如果你的應用要支持這些版本就要多執行測試。
同樣因爲Dalvik linearAlloc的限制，如果請求大量內存可能導致崩潰。Dalvik linearAlloc是一個固定大小的緩衝區。在應用的安裝過程中，系統會運行一個名爲dexopt的程序爲該應用在當前機型中運行做準備。dexopt使用LinearAlloc來存儲應用的方法信息。Android 2.2和2.3的緩衝區只有5MB，Android 4.x提高到了8MB或16MB。當方法數量過多導致超出緩衝區大小時，會造成dexopt崩潰。
Multidex構建工具還不支持指定哪些類必須包含在首個DEX文件中，因此可能會導致某些類庫（例如某個類庫需要從原生代碼訪問Java代碼）無法使用。

避免應用過大、方法過多仍然是Android開發者要注意的問題。Mihai Parparita的開源項目dex-method-counts可以用於統計APK中每個包的方法數量。

通常開發者自己的代碼很難達到這樣的方法數量限制，但隨着第三方類庫的加入，方法數就會迅速膨脹。因此選擇合適的類庫對Android開發者來說尤爲重要。

開發者應該避免使用Google Guava這樣的類庫，它包含了13000多個方法。儘量使用專爲移動應用設計的Lite/Android版本類庫，或者使用小類庫替換大類庫，例如用Google-gson替換Jackson JSON。而對於Google Protocol Buffers這樣的數據交換格式，其標準實現會自動生成大量的方法。採用Square Wire的實現則可以很好地解決此問題。

常見問題

DexException: Library dex files are not supported in multi-dex mode,你可能會見到如下的錯誤:

Error:Execution failed for task ':app:dexDebug'.  
> com.android.ide.common.internal.LoggedErrorException: Failed to run command:  
    $ANDROID_SDK/build-tools/android-4.4W/dx --dex --num-threads=4 --multi-dex  
    ...  
  Error Code:  
    2  
  Output:  
    UNEXPECTED TOP-LEVEL EXCEPTION:  
    com.android.dex.DexException: Library dex files are not supported in multi-dex mode  
        at com.android.dx.command.dexer.Main.runMultiDex(Main.java:322)  
        at com.android.dx.command.dexer.Main.run(Main.java:228)  
        at com.android.dx.command.dexer.Main.main(Main.java:199)  
        at com.android.dx.command.Main.main(Main.java:103)

對於dex 的--multi-dex 選項設置與預編譯的library工程有衝突,因此如果你的應用中包含引用的lirary工程,需要將預編譯設置爲false:

android {  
    // ...  
    dexOptions {  
        preDexLibraries = false  
    }  
}

OutOfMemoryError: Java heap space

當運行時如果看到如下錯誤:

UNEXPECTED TOP-LEVEL ERROR:  
java.lang.OutOfMemoryError: Java heap space

在dexOptions中有一個字段用來增加java堆內存大小:

android {  
    // ...  
    dexOptions {  
        javaMaxHeapSize "2g"  
    }  
}

使用eclipse的開發人員可以參考Google官方文檔

https://developer.android.com/tools/building/multidex.html#mdex-gradle

需要安裝支持gradle構建的插件，下載地址:

http://dist.springsource.com/release/TOOLS/gradle (目前可能需要翻牆)

2. http://blog.osom.info/2014/10/multi-dex-to-rescue-from-infamous-65536.html

另附android -support-mutidex.jar下載地址: http://download.csdn.net/detail/t12x3456/8143383

補充注意事項：

com.android.dex.DexException: Multiple dex files define L{package}/BuildConfig;

如果遇到這個錯誤請進行如下檢查：

1. 主工程與依賴library工程包名是否重複
2. 檢查主工程與依賴library工程是否含有重複的support.jar或者其他jar包

解決方案:

1. 修改library工程包名

2. 刪除重複jar包

3.手工添加lib包,增加如下配置

dependencies {  
            compile fileTree(dir: 'libs', include: ['*.jar'])  
            compile project(':lib-project-module')  
        }

MultiDex使用方法

關於接口協議，你必須要知道這些！

一鍵自動化博客發佈工具,用過的人都說好(頭條篇)

01 穩定性（一）如何應對事故並做好覆盤？

美團一面：項目中有 10000 個 if else 如何優化？想了半天，被問懵了！

京東面試：如何進行JVM調優？

線程池那些坑爹的參數-核心線程數&最大線程數&工作隊列

Stream流常用方法總結

Android Fragment嵌套使用存在的一些BUG

Android WebView開發問題及優化彙總 .

MultiDex使用方法

Intent,Action,大全

Android 屬性動畫（Property Animation）完全解析

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結