Android中的動態加載機制--薛彥順

  在目前的軟硬件環境下，Native App與Web App在用戶體驗上有着明顯的優勢，但在實際項目中有些會因爲業務的頻繁變更而頻繁的升級客戶端，造成較差的用戶體驗，而這也恰恰是Web App的優勢。本文對網上Android動態加載jar的資料進行梳理和實踐在這裏與大家一起分享，試圖改善頻繁升級這一弊病。

Android應用開發在一般情況下，常規的開發方式和代碼架構就能滿足我們的普通需求。但是有些特殊問題，常常引發我們進一步的沉思。我們從沉思中產生頓悟，從而產生新的技術形式。
如何開發一個可以自定義控件的Android應用？就像eclipse一樣，可以動態加載插件；如何讓Android應用執行服務器上的不可預知的代碼？如何對Android應用加密，而只在執行時自解密，從而防止被破解？……
熟悉Java技術的朋友，可能意識到，我們需要使用類加載器靈活的加載執行的類。這在Java裏已經算是一項比較成熟的技術了，但是在Android中，我們大多數人都還非常陌生。
類加載機制
       Dalvik虛擬機如同其他Java虛擬機一樣，在運行程序時首先需要將對應的類加載到內存中。而在Java標準的虛擬機中，類加載可以從class文件中讀取，也可以是其他形式的二進制流，因此，我們常常利用這一點，在程序運行時手動加載Class，從而達到代碼動態加載執行的目的
       然而Dalvik虛擬機畢竟不算是標準的Java虛擬機，因此在類加載機制上，它們有相同的地方，也有不同之處。我們必須區別對待

       例如，在使用標準Java虛擬機時，我們經常自定義繼承自ClassLoader的類加載器。然後通過defineClass方法來從一個二進制流中加載Class。然而，這在Android裏是行不通的，大家就沒必要走彎路了。參看源碼我們知道，Android中ClassLoader的defineClass方法具體是調用VMClassLoader的defineClass本地靜態方法。而這個本地方法除了拋出一個“UnsupportedOperationException”之外，什麼都沒做，甚至連返回值都爲空

static void Dalvik_java_lang_VMClassLoader_defineClass(const u4* args,JValue* pResult){
    Object* loader = (Object*) args[0];
    StringObject* nameObj = (StringObject*) args[1];
    const u1* data = (const u1*) args[2];
    int offset = args[3];
    int len = args[4];
    Object* pd = (Object*) args[5];
    char* name = NULL;
    name = dvmCreateCstrFromString(nameObj);
    LOGE("ERROR: defineClass(%p, %s, %p, %d, %d, %p)\n",loader, name, data, offset, len, pd);
    dvmThrowException("Ljava/lang/UnsupportedOperationException;","can't load this type of class file");
    free(name);
    RETURN_VOID();
}

Dalvik虛擬機類加載機制
       那如果在Dalvik虛擬機裏，ClassLoader不好使，我們如何實現動態加載類呢？Android爲我們從ClassLoader派生出了兩個類：DexClassLoader和PathClassLoader。其中需要特別說明的是PathClassLoader中一段被註釋掉的代碼：

/* --this doesn't work in current version of Dalvik--
    if (data != null) {
        System.out.println("--- Found class " + name
            + " in zip[" + i + "] '" + mZips[i].getName() + "'");
        int dotIndex = name.lastIndexOf('.');
        if (dotIndex != -1) {
            String packageName = name.substring(0, dotIndex);
            synchronized (this) {
                Package packageObj = getPackage(packageName);
                if (packageObj == null) {
                    definePackage(packageName, null, null,
                            null, null, null, null, null);
                }
            }
        }
        return defineClass(name, data, 0, data.length);
    }
*/

這從另一方面佐證了defineClass函數在Dalvik虛擬機裏確實是被閹割了。而在這兩個繼承自ClassLoader的類加載器，本質上是重載了ClassLoader的findClass方法。在執行loadClass時，我們可以參看ClassLoader部分源碼：

protected Class<?> loadClass(String className, boolean resolve) throws ClassNotFoundException {
Class<?> clazz = findLoadedClass(className);
    if (clazz == null) {
        try {
            clazz = parent.loadClass(className, false);
        } catch (ClassNotFoundException e) {
            // Don't want to see this.
        }
        if (clazz == null) {
            clazz = findClass(className);
        }
    }
    return clazz;
}

因此DexClassLoader和PathClassLoader都屬於符合雙親委派模型的類加載器（因爲它們沒有重載loadClass方法）。也就是說，它們在加載一個類之前，回去檢查自己以及自己以上的類加載器是否已經加載了這個類。如果已經加載過了，就會直接將之返回，而不會重複加載。
DexClassLoader和PathClassLoader其實都是通過DexFile這個類來實現類加載的。這裏需要順便提一下的是，Dalvik虛擬機識別的是dex文件，而不是class文件。因此，我們供類加載的文件也只能是dex文件，或者包含有dex文件的.apk或.jar文件。
也許有人想到，既然DexFile可以直接加載類，那麼我們爲什麼還要使用ClassLoader的子類呢？DexFile在加載類時，具體是調用成員方法loadClass或者loadClassBinaryName。其中loadClassBinaryName需要將包含包名的類名中的”.”轉換爲”/”我們看一下loadClass代碼就清楚了：

public Class loadClass(String name, ClassLoader loader) {
        String slashName = name.replace('.', '/');
        return loadClassBinaryName(slashName, loader);
}

       在這段代碼前有一段註釋，截取關鍵一部分就是說：If you are not calling this from a class loader, this is most likely not going to do what you want. Use {@link Class#forName(String)} instead. 這就是我們需要使用ClassLoader子類的原因。至於它是如何驗證是否是在ClassLoader中調用此方法的，我沒有研究，大家如果有興趣可以繼續深入下去。
       有一個細節，可能大家不容易注意到。PathClassLoader是通過構造函數new DexFile(path)來產生DexFile對象的；而DexClassLoader則是通過其靜態方法loadDex（path, outpath, 0）得到DexFile對象。這兩者的區別在於DexClassLoader需要提供一個可寫的outpath路徑，用來釋放.apk包或者.jar包中的dex文件。換個說法來說，就是PathClassLoader不能主動從zip包中釋放出dex，因此只支持直接操作dex格式文件，或者已經安裝的apk（因爲已經安裝的apk在cache中存在緩存的dex文件）。而DexClassLoader可以支持.apk、.jar和.dex文件，並且會在指定的outpath路徑釋放出dex文件。

       另外，PathClassLoader在加載類時調用的是DexFile的loadClassBinaryName，而DexClassLoader調用的是loadClass。因此，在使用PathClassLoader時類全名需要用”/”替換”.”

實際操作

使用到的工具都比較常規：javac、dx、eclipse等其中dx工具最好是指明--no-strict，因爲class文件的路徑可能不匹配
加載好類後，通常我們可以通過Java反射機制來使用這個類但是這樣效率相對不高，而且老用反射代碼也比較複雜凌亂。更好的做法是定義一個interface，並將這個interface寫進容器端。待加載的類，繼承自這個interface，並且有一個參數爲空的構造函數，以使我們能夠通過Class的newInstance方法產生對象然後將對象強制轉換爲interface對象，於是就可以直接調用成員方法了，下面是具體的實現步驟了:
第一步：

編寫好動態代碼類：

package com.dynamic.interfaces;
import android.app.Activity;
/**
 * 動態加載類的接口
 */
public interface IDynamic {
    /**初始化方法*/
    public void init(Activity activity);
    /**自定義方法*/
    public void showBanner();
    public void showDialog();
    public void showFullScreen();
    public void showAppWall();
    /**銷燬方法*/
    public void destory();
}

實現類代碼如下：

package com.dynamic.impl;

import android.app.Activity;
import android.widget.Toast;

import com.dynamic.interfaces.IDynamic;

/**
 * 動態類的實現
 *
 */
public class Dynamic implements IDynamic{

    private Activity mActivity;

    @Override
    public void init(Activity activity) {
        mActivity = activity;
    }

    @Override
    public void showBanner() {
        Toast.makeText(mActivity, "我是ShowBannber方法", 1500).show();
    }

    @Override
    public void showDialog() {
        Toast.makeText(mActivity, "我是ShowDialog方法", 1500).show();
    }

    @Override
    public void showFullScreen() {
        Toast.makeText(mActivity, "我是ShowFullScreen方法", 1500).show();
    }

    @Override
    public void showAppWall() {
        Toast.makeText(mActivity, "我是ShowAppWall方法", 1500).show();
    }

    @Override
    public void destory() {
    }

}

這樣動態類就開發好了

第二步：

將上面開發好的動態類打包成.jar，這裏要注意的是隻打包實現類Dynamic.Java，不打包接口類IDynamic.java，

然後將打包好的jar文件拷貝到android的安裝目錄中的platform-tools目錄下，使用dx命令:(我的jar文件是dynamic.jar)

dx --dex --output=dynamic_temp.jar dynamic.jar

這樣就生成了dynamic_temp.jar，這個jar和dynamic.jar有什麼區別呢？

其實這條命令主要做的工作是:首先將dynamic.jar編譯成dynamic.dex文件(Android虛擬機認識的字節碼文件)，然後再將dynamic.dex文件壓縮成dynamic_temp.jar，當然你也可以壓縮成.zip格式的，或者直接編譯成.apk文件都可以的，這個後面會說到。

到這裏還不算完事，因爲你想想用什麼來連接動態類和目標類呢？那就是動態類的接口了，所以這時候還要打個.jar包，這時候只需要打接口類IDynamic.java了

然後將這個.jar文件引用到目標類中，下面來看一下目標類的實現：

package com.jiangwei.demo;

import java.io.File;
import java.util.List;

import android.app.Activity;
import android.content.Intent;
import android.content.pm.ActivityInfo;
import android.content.pm.PackageManager;
import android.content.pm.ResolveInfo;
import android.os.Bundle;
import android.os.Environment;
import android.view.View;
import android.widget.Button;
import android.widget.Toast;

import com.dynamic.interfaces.IDynamic;

import dalvik.system.DexClassLoader;
import dalvik.system.PathClassLoader;

public class AndroidDynamicLoadClassActivity extends Activity {

    //動態類加載接口
    private IDynamic lib;

    @Override
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.main);
        //初始化組件
        Button showBannerBtn = (Button) findViewById(R.id.show_banner_btn);
        Button showDialogBtn = (Button) findViewById(R.id.show_dialog_btn);
        Button showFullScreenBtn = (Button) findViewById(R.id.show_fullscreen_btn);
        Button showAppWallBtn = (Button) findViewById(R.id.show_appwall_btn);
        /**使用DexClassLoader方式加載類*/
        //dex壓縮文件的路徑(可以是apk,jar,zip格式)
        String dexPath = Environment.getExternalStorageDirectory().toString() + File.separator + "Dynamic.apk";
        //dex解壓釋放後的目錄
        //String dexOutputDir = getApplicationInfo().dataDir;
        String dexOutputDirs = Environment.getExternalStorageDirectory().toString();
        //定義DexClassLoader
        //第一個參數：是dex壓縮文件的路徑
        //第二個參數：是dex解壓縮後存放的目錄
        //第三個參數：是C/C++依賴的本地庫文件目錄,可以爲null
        //第四個參數：是上一級的類加載器
        DexClassLoader cl = new DexClassLoader(dexPath,dexOutputDirs,null,getClassLoader());

        /**使用PathClassLoader方法加載類*/
        //創建一個意圖，用來找到指定的apk：這裏的"com.dynamic.impl是指定apk中在AndroidMainfest.xml文件中定義的<action name="com.dynamic.impl"/>
        Intent intent = new Intent("com.dynamic.impl", null);
        //獲得包管理器
        PackageManager pm = getPackageManager();
        List<ResolveInfo> resolveinfoes =  pm.queryIntentActivities(intent, 0);
        //獲得指定的activity的信息
        ActivityInfo actInfo = resolveinfoes.get(0).activityInfo;
        //獲得apk的目錄或者jar的目錄
        String apkPath = actInfo.applicationInfo.sourceDir;
        //native代碼的目錄
        String libPath = actInfo.applicationInfo.nativeLibraryDir;
        //創建類加載器，把dex加載到虛擬機中
        //第一個參數：是指定apk安裝的路徑，這個路徑要注意只能是通過actInfo.applicationInfo.sourceDir來獲取
        //第二個參數：是C/C++依賴的本地庫文件目錄,可以爲null
        //第三個參數：是上一級的類加載器
        PathClassLoader pcl = new PathClassLoader(apkPath,libPath,this.getClassLoader());
        //加載類
        try {
            //com.dynamic.impl.Dynamic是動態類名
            //使用DexClassLoader加載類
            //Class libProviderClazz = cl.loadClass("com.dynamic.impl.Dynamic");
            //使用PathClassLoader加載類
            Class libProviderClazz = pcl.loadClass("com.dynamic.impl.Dynamic");
            lib = (IDynamic)libProviderClazz.newInstance();
            if(lib != null){
                lib.init(AndroidDynamicLoadClassActivity.this);
            }
        } catch (Exception exception) {
            exception.printStackTrace();
        }
        /**下面分別調用動態類中的方法*/
        showBannerBtn.setOnClickListener(new View.OnClickListener() {
            public void onClick(View view) {
               if(lib != null){
                   lib.showBanner();
               }else{
                   Toast.makeText(getApplicationContext(), "類加載失敗", 1500).show();
               }
            }
        });
        showDialogBtn.setOnClickListener(new View.OnClickListener() {
            public void onClick(View view) {
               if(lib != null){
                   lib.showDialog();
               }else{
                   Toast.makeText(getApplicationContext(), "類加載失敗", 1500).show();
               }
            }
        });
        showFullScreenBtn.setOnClickListener(new View.OnClickListener() {
            public void onClick(View view) {
               if(lib != null){
                   lib.showFullScreen();
               }else{
                   Toast.makeText(getApplicationContext(), "類加載失敗", 1500).show();
               }
            }
        });
        showAppWallBtn.setOnClickListener(new View.OnClickListener() {
            public void onClick(View view) {
               if(lib != null){
                   lib.showAppWall();
               }else{
                   Toast.makeText(getApplicationContext(), "類加載失敗", 1500).show();
               }
            }
        });
    }
}

這裏面定義了一個IDynamic接口變量，同時使用了DexClassLoader和PathClassLoader來加載類，這裏面先來說一說DexClassLoader方式加載:

//定義DexClassLoader
//第一個參數：是dex壓縮文件的路徑
//第二個參數：是dex解壓縮後存放的目錄
//第三個參數：是C/C++依賴的本地庫文件目錄,可以爲null
//第四個參數：是上一級的類加載器
DexClassLoader cl = new DexClassLoader(dexPath,dexOutputDirs,null,getClassLoader());

上面已經說了，DexClassLoader是繼承ClassLoader類的，這裏面的參數說明：

第一個參數是:dex壓縮文件的路徑:這個就是我們將上面編譯後的dynamic_temp.jar存放的目錄，當然也可以是.zip和.apk格式的

第二個參數是:dex解壓後存放的目錄:這個就是將.jar,.zip,.apk文件解壓出的dex文件存放的目錄，這個就和PathClassLoader方法有區別了，同時你也可以看到PathClassLoader方法中沒有這個參數，這個也真是這兩個類的區別:

PathClassLoader不能主動從zip包中釋放出dex，因此只支持直接操作dex格式文件，或者已經安裝的apk（因爲已經安裝的apk在手機的data/dalvik目錄中存在緩存的dex文件）。而DexClassLoader可以支持.apk、.jar和.dex文件，並且會在指定的outpath路徑釋放出dex文件。

然而我們可以通過DexClassLoader方法指定解壓後的dex文件的存放目錄，但是我們一般不這麼做，因爲這樣做無疑的暴露了dex文件，所以我們一般不會將.jar/.zip/.apk壓縮文件存放到用戶可以察覺到的位置，同時解壓dex的目錄也是不能讓用戶看到的。

第三個參數和第四個參數用到的不是很多，所以這裏就不做太多的解釋了。

這裏還要注意一點就是PathClassLoader方法的時候，第一個參數是dex存放的路徑，這裏傳遞的是:

//獲得apk的目錄或者jar的目錄
String apkPath = actInfo.applicationInfo.sourceDir;

指定的apk安裝路徑,這個值只能這樣獲取，不然會加載類失敗的

第三步：

運行目標類:

要做的工作是:

如果用的是DexClassLoader方式加載類:這時候需要將.jar或者.zip或者.apk文件放到指定的目錄中，我這裏爲了方便就放到sd卡的根目錄中

如果用的是PathClassLoader方法加載類:這時候需要先將Dynamic.apk安裝到手機中，不然找不到這個activity，同時要注意的是:

//創建一個意圖，用來找到指定的apk：這裏的"com.dynamic.impl是指定apk中在AndroidMainfest.xml文件中定義的<action name="com.dynamic.impl"/>
Intent intent = new Intent("com.dynamic.impl", null);

這裏的com.dynamic.impl是一個action需要在指定的apk中定義，這個名稱是動態apk和目標apk之間約定好的

運行結果

點擊showBanner顯示一個Toast，成功的運行了動態類中的代碼！

其實更好的辦法就是將動態的.jar.zip.apk文件從網絡上獲取，安全可靠，同時本地的目標項目不需要改動代碼就可以執行不同的邏輯了

關於代碼加密的一些設想
    最初設想將dex文件加密，然後通過JNI將解密代碼寫在Native層。解密之後直接傳上二進制流，再通過defineClass將類加載到內存中。
    現在也可以這樣做，但是由於不能直接使用defineClass，而必須傳文件路徑給dalvik虛擬機內核，因此解密後的文件需要寫到磁盤上，增加了被破解的風險。
    Dalvik虛擬機內核僅支持從dex文件加載類的方式是不靈活的，由於沒有非常深入的研究內核，我不能確定是Dalvik虛擬機本身不支持還是Android在移植時將其閹割了。不過相信Dalvik或者是Android開源項目都正在向能夠支持raw數據定義類方向努力。
    我們可以在文檔中看到Google說：Jar or APK file with "classes.dex". (May expand this to include "raw DEX" in the future.)；在Android的Dalvik源碼中我們也能看到RawDexFile的身影（不過沒有具體實現）
    在RawDexFile出來之前，我們都只能使用這種存在一定風險的加密方式。需要注意釋放的dex文件路徑及權限管理，另外，在加載完畢類之後，除非出於其他目的否則應該馬上刪除臨時的解密文件