天天看點

Android dex分包方案

當一個app的功能越來越複雜,代碼量越來越多,也許有一天便會突然遇到下列現象:

1. 生成的apk在2.3以前的機器無法安裝,提示INSTALL_FAILED_DEXOPT

2. 方法數量過多,編譯時出錯,提示:

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

出現這種問題的原因是:

1. Android2.3及以前版本用來執行dexopt(用于優化dex檔案)的記憶體隻配置設定了5M

2. 一個dex檔案最多隻支援65536個方法。

針對上述問題,也出現了諸多解決方案,使用的最多的是插件化,即将一些獨立的功能做成一個單獨的apk,當打開的時候使用DexClassLoader動态加載,然後使用反射機制來調用插件中的類和方法。這固然是一種解決問題的方案:但這種方案存在着以下兩個問題:

1. 插件化隻适合一些比較獨立的子產品;

2. 必須通過反射機制去調用插件的類和方法,是以,必須搭配一套插件架構來配合使用;

由于上述問題的存在,通過不斷研究,便有了dex分包的解決方案。簡單來說,其原理是将編譯好的class檔案拆分打包成兩個dex,繞過dex方法數量的限制以及安裝時的檢查,在運作時再動态加載第二個dex檔案中。faceBook曾經遇到相似的問題,具體可參考:

https://www.facebook.com/notes/facebook-engineering/under-the-hood-dalvik-patch-for-facebook-for-android/10151345597798920

文中有這麼一段話:

However, there was no way we could break our app up this way--too many of our classes are accessed directly by the Android framework. Instead, we needed to inject our secondary dex files directly into the system class loader。

文中說得比較簡單,我們來完善一下該方案:除了第一個dex檔案(即正常apk包唯一包含的Dex檔案),其它dex檔案都以資源的方式放在安裝包中,并在Application的onCreate回調中被注入到系統的ClassLoader。是以,對于那些在注入之前已經引用到的類(以及它們所在的jar),必須放入第一個Dex檔案中。

下面通過一個簡單的demo來講述dex分包方案,該方案分為兩步執行:

Android dex分包方案

整個demo的目錄結構是這樣,我打算将SecondActivity,MyContainer以及DropDownView放入第二個dex包中,其它保留在第一個dex包。

一、編譯時分包

整個編譯流程如下:

Android dex分包方案

除了框出來的兩Target,其它都是編譯的标準流程。而這兩個Target正是我們的分包操作。首先來看看spliteClasses target。

Android dex分包方案

由于我們這裡僅僅是一個demo,是以放到第二個包中的檔案很少,就是上面提到的三個檔案。分好包之後就要開始生成dex檔案,首先打包第一個dex檔案: 

Android dex分包方案

由這裡将${classes}(該檔案夾下都是要打包到第一個dex的檔案)打包生成第一個dex。接着生成第二個dex,并将其打包到資資源檔案中:

Android dex分包方案

可以看到,此時是将${secclasses}中的檔案打包生成dex,并将其加入ap檔案(打包的資源檔案)中。到此,分包完畢,接下來,便來分析一下如何動态将第二個dex包注入系統的ClassLoader。

二、将dex分包注入ClassLoader

這裡談到注入,就要談到Android的ClassLoader體系。

Android dex分包方案

由上圖可以看出,在葉子節點上,我們能使用到的是DexClassLoader和PathClassLoader,通過查閱開發文檔,我們發現他們有如下使用場景:

1. 關于PathClassLoader,文檔中寫到: Android uses this class for its system class loader and for its application class loader(s),

由此可知,Android應用就是用它來加載;

2. DexClass可以加載apk,jar,及dex檔案,但PathClassLoader隻能加載已安裝到系統中(即/data/app目錄下)的apk檔案。

知道了兩者的使用場景,下面來分析下具體的加載原理,由上圖可以看到,兩個葉子節點的類都繼承BaseDexClassLoader中,而具體的類加載邏輯也在此類中:

BaseDexClassLoader:  

[java] view plaincopy

Android dex分包方案

@Override  

protected Class<?> findClass(String name) throws ClassNotFoundException {  

    List<Throwable> suppressedExceptions = new ArrayList<Throwable>();  

    Class c = pathList.findClass(name, suppressedExceptions);  

    if (c == null) {  

        ClassNotFoundException cnfe = new ClassNotFoundException("Didn't find class \"" + name + "\" on path: " + pathList);  

        for (Throwable t : suppressedExceptions) {  

            cnfe.addSuppressed(t);  

       }  

        throw cnfe;  

    }  

     return c;  

}  

由上述函數可知,當我們需要加載一個class時,實際是從pathList中去需要的,查閱源碼,發現pathList是DexPathList類的一個執行個體。ok,接着去分析DexPathList類中的findClass函數,

DexPathList:

Android dex分包方案

public Class findClass(String name, List<Throwable> suppressed) {  

    for (Element element : dexElements) {  

        DexFile dex = element.dexFile;  

        if (dex != null) {  

            Class clazz = dex.loadClassBinaryName(name, definingContext, suppressed);  

            if (clazz != null) {  

                return clazz;  

            }  

        }  

   }  

    if (dexElementsSuppressedExceptions != null) {  

        suppressed.addAll(Arrays.asList(dexElementsSuppressedExceptions));  

    return null;  

上述函數的大緻邏輯為:周遊一個裝在dex檔案(每個dex檔案實際上是一個DexFile對象)的數組(Element數組,Element是一個内部類),然後依次去加載所需要的class檔案,直到找到為止。

看到這裡,注入的解決方案也就浮出水面,假如我們将第二個dex檔案放入Element數組中,那麼在加載第二個dex包中的類時,應該可以直接找到。

帶着這個假設,來完善demo。

在我們自定義的BaseApplication的onCreate中,我們執行注入操作:

Android dex分包方案

public String inject(String libPath) {  

    boolean hasBaseDexClassLoader = true;  

    try {  

        Class.forName("dalvik.system.BaseDexClassLoader");  

    } catch (ClassNotFoundException e) {  

        hasBaseDexClassLoader = false;  

    if (hasBaseDexClassLoader) {  

        PathClassLoader pathClassLoader = (PathClassLoader)sApplication.getClassLoader();  

        DexClassLoader dexClassLoader = new DexClassLoader(libPath, sApplication.getDir("dex", 0).getAbsolutePath(), libPath, sApplication.getClassLoader());  

        try {  

            Object dexElements = combineArray(getDexElements(getPathList(pathClassLoader)), getDexElements(getPathList(dexClassLoader)));  

            Object pathList = getPathList(pathClassLoader);  

            setField(pathList, pathList.getClass(), "dexElements", dexElements);  

            return "SUCCESS";  

        } catch (Throwable e) {  

            e.printStackTrace();  

            return android.util.Log.getStackTraceString(e);  

    return "SUCCESS";  

}   

這是注入的關鍵函數,分析一下這個函數:

參數libPath是第二個dex包的檔案資訊(包含完整路徑,我們當初将其打包到了assets目錄下),然後将其使用DexClassLoader來加載(這裡為什麼必須使用DexClassLoader加載,回顧以上的使用場景),然後通過反射擷取PathClassLoader中的DexPathList中的Element數組(已加載了第一個dex包,由系統加載),以及DexClassLoader中的DexPathList中的Element數組(剛将第二個dex包加載進去),将兩個Element數組合并之後,再将其指派給PathClassLoader的Element數組,到此,注入完畢。

現在試着啟動app,并在TestUrlActivity(在第一個dex包中)中去啟動SecondActivity(在第二個dex包中),啟動成功。這種方案是可行。

但是使用dex分包方案仍然有幾個注意點:

1. 由于第二個dex包是在Application的onCreate中動态注入的,如果dex包過大,會使app的啟動速度變慢,是以,在dex分包過程中一定要注意,第二個dex包不宜過大。

2. 由于上述第一點的限制,假如我們的app越來越臃腫和龐大,往往會采取dex分包方案和插件化方案配合使用,将一些非核心獨立功能做成插件加載,核心功能再分包加載。