RePlugin外掛化框架的學習

入魔的冬瓜發表於2017-11-21

現狀

最近在接觸外掛化方面的技術,學習後趕緊坐下筆記,給入門的朋友看, 一起學習,一起進步。
當前比較熱門的外掛化框架有下面幾個:

框架 優點 缺點
dynamic-load-apk 1.外掛無需安裝host即可吊起
2.支援R訪問外掛資源
3.外掛支援Activity和FragmentActivity
4.基本無反射呼叫
5.外掛安裝後任可獨立執行
1.不支援Service和BroadcastReceiver
2.遷移成本,需要修改外掛,外掛app需要繼承自proxyActivity
Droid Plugin 1.外掛無需任何修改,可獨立安裝執行,也可以做外掛執行
2.四大元件無需在Host程式註冊
3.超強隔離性,不同外掛執行在不同的程式中
4.資源完全隔離
5.實現程式管理,外掛的空程式會被及時回收,佔用記憶體低外掛的靜態廣播會被當作動態處理,如果外掛沒有執行,靜態廣播永遠不會觸發
6.API侵入性低
1.無法使用自定義資源的通知
2.無法註冊一些特殊Intent Filter的元件(四大元件)
3.對Native支援不好
DynamicAPK 1.遷移成本低(無需做任何activity/fragment/resource的proxy實現)不使用代理來管理外掛的activity/fragment的生命週期。修改後aapt會處理外掛種的資源,R.java中的資源引用和普通Android工程沒有區別,開發者可以保持原有的開發規範
2.更加有利於併發開發
3.提升編譯速度
4.提升啟動速度。dex解壓、dexopt、載入耗時較長,使用按需載入啟動時間過長
5.適合HotFix(程式碼和資源)
6.按需下載和載入任意功能模組(包含程式碼和資源)
目前已停止維護
RePlugin 1.極其靈活:主程式無需升級(無需在Manifest中預埋元件),即可支援新增的四大元件,甚至全新的外掛
2.非常穩定:Hook點僅有一處(ClassLoader),無任何Binder Hook!如此可做到其崩潰率僅為“萬分之一”,並完美相容市面上近乎所有的Android ROM
3.特性豐富:支援近乎所有在“單品”開發時的特性。包括靜態Receiver、Task-Affinity坑位、自定義Theme、程式坑位、AppCompat、DataBinding等
4.易於整合:無論外掛還是主程式,只需“數行”就能完成接入
5.管理成熟:擁有成熟穩定的“外掛管理方案”,支援外掛安裝、升級、解除安裝、版本管理,甚至包括程式通訊、協議版本、安全校驗等
6.數億支撐:有360手機衛士龐大的數億使用者做支撐,三年多的殘酷驗證,確保App用到的方案是最穩定、最適合使用的

介紹

下面我們主要介紹的就是RePlugin框架.中文文件地址:github.com/Qihoo360/Re…
官方對這個框架的介紹:
RePlugin是一套完整的、穩定的、適合全面使用的,佔坑類外掛化方案,由360手機衛士的RePlugin Team研發,也是業內首個提出”全面外掛化“(全面特性、全面相容、全面使用)的方案。
其主要優勢有:

  1. 極其靈活:主程式無需升級(無需在Manifest中預埋元件),即可支援新增的四大元件,甚至全新的外掛
  2. 非常穩定:Hook點僅有一處(ClassLoader),無任何Binder Hook!如此可做到其崩潰率僅為“萬分之一”,並完美相容市面上近乎所有的Android ROM
  3. 特性豐富:支援近乎所有在“單品”開發時的特性。包括靜態Receiver、Task-Affinity坑位、自定義Theme、程式坑位、AppCompat、DataBinding等
  4. 易於整合:無論外掛還是主程式,只需“數行”就能完成接入
    管理成熟:擁有成熟穩定的“外掛管理方案”,支援外掛安裝、升級、解除安裝、版本管理,甚至包括程式通訊、協議版本、安全校驗等
  5. 數億支撐:有360手機衛士龐大的數億使用者做支撐,三年多的殘酷驗證,確保App用到的方案是最穩定、最適合使用的

支援的特性:

特性 描述
元件 四大元件(含靜態Receiver)
升級無需改主程式Manifest 完美支援
Android特性 支援近乎所有(包括SO庫等)
TaskAffinity & 多程式 支援(坑位方案)
外掛型別 支援自帶外掛(自識別)、外接外掛
外掛間耦合 支援Binder、Class Loader、資源等
程式間通訊 支援同步、非同步、Binder、廣播等
自定義Theme & AppComat 支援
DataBinding 支援
安全校驗 支援
資源方案 獨立資源 + Context傳遞(相對穩定)
Android 版本 API Level 9+ (2.3及以上)

使用

一、新增依賴

專案目錄下的build.gradle檔案:

dependencies {
        classpath 'com.android.tools.build:gradle:3.0.0'

        classpath 'com.qihoo360.replugin:replugin-host-gradle:2.2.1'
        classpath 'com.qihoo360.replugin:replugin-plugin-gradle:2.2.1'

        // NOTE: Do not place your application dependencies here; they belong
        // in the individual module build.gradle files
    }複製程式碼

宿主目錄下的build.gradle檔案

apply plugin: 'replugin-host-gradle'
/**
 * 配置項均為可選配置,預設無需新增
 * 更多可選配置項參見replugin-host-gradle的RepluginConfig類
 * 可更改配置項參見 自動生成RePluginHostConfig.java
 */
repluginHostConfig {
    /**
     * 是否使用 AppCompat 庫
     * 不需要個性化配置時,無需新增
     */
    useAppCompat = true
//    /**
//     * 背景不透明的坑的數量
//     * 不需要個性化配置時,無需新增
//     */
//    countNotTranslucentStandard = 6
//    countNotTranslucentSingleTop = 2
//    countNotTranslucentSingleTask = 3
//    countNotTranslucentSingleInstance = 2
}

dependencies {
     ……………………………………………………………………………
    compile 'com.qihoo360.replugin:replugin-host-lib:2.2.1'
}複製程式碼

外掛目錄下的build.gradle檔案

apply plugin: 'replugin-plugin-gradle'

dependencies {
    ……………………………………………………………………………
    compile 'com.qihoo360.replugin:replugin-plugin-lib:2.2.1'
}複製程式碼

修改完上面的檔案後,點選sync後,就可以開始實現外掛化了。

配置Application類

如果您的工程已有Application類,則可以將基類切換到RePluginApplication即可。然後可以通過自定義RePluginCallbacks類和RePluginEventCallbacks類來實現宿主針對RePlugin的自定義行為

public class MyApplication extends RePluginApplication{
    @Override
    public void onCreate() {
        super.onCreate();
        RePlugin.App.onCreate();
    }
    @Override
    protected RePluginConfig createConfig() {
        RePluginConfig c = new RePluginConfig();
        // 允許“外掛使用宿主類”。預設為“關閉”
        c.setUseHostClassIfNotFound(true);
        // FIXME RePlugin預設會對安裝的外接外掛進行簽名校驗,這裡先關掉,避免除錯時出現簽名錯誤
        c.setVerifySign(false);
        c.setPrintDetailLog(BuildConfig.DEBUG);
        c.setUseHostClassIfNotFound(true);
        // 針對“安裝失敗”等情況來做進一步的事件處理
        c.setEventCallbacks(new HostEventCallbacks(this));
        c.setMoveFileWhenInstalling(true);
        // FIXME 若宿主為Release,則此處應加上您認為"合法"的外掛的簽名,例如,可以寫上"宿主"自己的。
        // RePlugin.addCertSignature("AAAAAAAAA");

        return c;
    }
    @Override
    protected RePluginCallbacks createCallbacks() {
        return new HostCallbacks(this);
    }

}複製程式碼
/**
 * 宿主針對RePlugin的自定義行為
 */
public class HostCallbacks extends RePluginCallbacks {

    public HostCallbacks(Context context) {
        super(context);
    }

    @Override
    public boolean onLoadLargePluginForActivity(Context context, String plugin, Intent intent, int process) {
        return super.onLoadLargePluginForActivity(context, plugin, intent, process);
    }

    @Override
    public boolean onPluginNotExistsForActivity(final Context context, final String plugin, Intent intent, int process) {
        // FIXME 當外掛"沒有安裝"時觸發此邏輯,可開啟您的"下載對話方塊"並開始下載。
        // FIXME 其中"intent"需傳遞到"對話方塊"內,這樣可在下載完成後,開啟這個外掛的Activity
        if (BuildConfig.DEBUG) {
            Log.d("morse", "onPluginNotExistsForActivity: Start download... p=" + plugin + "; i=" + intent);
        }
        return super.onPluginNotExistsForActivity(context, plugin, intent, process);
    }
}複製程式碼
public class HostEventCallbacks extends RePluginEventCallbacks {
    public HostEventCallbacks(Context context) {
        super(context);
    }

    @Override
    public void onInstallPluginSucceed(PluginInfo info) {
        Log.d("morse", "onInstallPluginSucceed: Failed! info=" + info);
        super.onInstallPluginSucceed(info);
    }

    @Override
    public void onInstallPluginFailed(String path, InstallResult code) {
        // FIXME 當外掛安裝失敗時觸發此邏輯。您可以在此處做“打點統計”,也可以針對安裝失敗情況做“特殊處理”
        // 大部分可以通過RePlugin.install的返回值來判斷是否成功
        Log.d("morse", "onInstallPluginFailed: Failed! path=" + path + "; r=" + code);
        super.onInstallPluginFailed(path, code);
    }

    @Override
    public void onStartActivityCompleted(String plugin, String activity, boolean result) {
        // FIXME 當開啟Activity成功時觸發此邏輯,可在這裡做一些APM、打點統計等相關工作
        Log.d("morse", "onStartActivityCompleted: plugin=" + plugin + "\r\n result=" + result);
        super.onStartActivityCompleted(plugin, activity, result);
    }
}複製程式碼

安裝或者升級外掛

思路:
1、判斷外掛是否已經安裝;
2、如果沒有安裝,檢測本地是否下載外掛;
3、沒有下載外掛,需要先下載外掛;
4、如果沒有安裝外掛,需要安裝外掛;

private void startRePlugin(String pluginName,String apkPath) {
        //安裝外掛過程
        PluginInfo pluginInfo = RePlugin.getPluginInfo(pluginName);
        //外掛檔案,只有存在就進行安裝或者更新
        File file = new File(apkPath);
        //判斷是否已經安裝外掛
        if (pluginInfo == null) {
            //外掛未安裝的情況
            if (!file.exists()) {
                Toast.makeText(HostActivity.this, "外掛安裝失敗,外掛檔案不存在", Toast.LENGTH_SHORT).show();
            } else {
                //安裝外掛
                PluginInfo pluginInfo1 = RePlugin.install(apkPath);
                if (pluginInfo1 == null) {
                    Toast.makeText(HostActivity.this, "外掛安裝失敗,安裝出錯", Toast.LENGTH_SHORT).show();
                } else {
                    Toast.makeText(HostActivity.this, "外掛安裝成功", Toast.LENGTH_SHORT).show();
                }
            }

        } else {
            //外掛已安裝,是否需要升級,判斷條件是file是否為空
            if (file.exists()) {
                PluginInfo pluginInfo1 = RePlugin.install(file.getAbsolutePath());
                if (pluginInfo1 == null) {
                    Toast.makeText(HostActivity.this, "外掛升級失敗", Toast.LENGTH_SHORT).show();
                } else {
                    Toast.makeText(HostActivity.this, "外掛升級成功", Toast.LENGTH_SHORT).show();
                }
            } else {
                Toast.makeText(HostActivity.this, "外掛已安裝", Toast.LENGTH_SHORT).show();
                RePlugin.preload(pluginInfo);
            }
        }
    }複製程式碼

宿主呼叫外掛

開啟外掛的activity

可以直接呼叫Replugin.startActivity方式,然後傳入相應的引數就可以了,也可以通過forResult的方法進行啟動。有挺多個過載的方法可以呼叫,具體的原始碼是位於RePlugin這個類中

    /**
     * 開啟一個外掛的Activity <p>
     * 其中Intent的ComponentName的Key應為外掛名(而不是包名),可使用createIntent方法來建立Intent物件
     *
     * @param context Context物件
     * @param intent  要開啟Activity的Intent,其中ComponentName的Key必須為外掛名
     * @return 外掛Activity是否被成功開啟?
     * FIXME 是否需要Exception來做?
     * @see #createIntent(String, String)
     * @since 1.0.0
     */
    public static boolean startActivity(Context context, Intent intent) {
        // TODO 先用舊的開啟Activity方案,以後再優化
        ComponentName cn = intent.getComponent();
        if (cn == null) {
            // TODO 需要支援Action方案
            return false;
        }
        String plugin = cn.getPackageName();
        String cls = cn.getClassName();
        return Factory.startActivityWithNoInjectCN(context, intent, plugin, cls, IPluginManager.PROCESS_AUTO);
    }

    /**
     * 通過 forResult 方式啟動一個外掛的 Activity
     *
     * @param activity    源 Activity
     * @param intent      要開啟 Activity 的 Intent,其中 ComponentName 的 Key 必須為外掛名
     * @param requestCode 請求碼
     * @param options     附加的資料
     * @see #startActivityForResult(Activity, Intent, int, Bundle)
     * @since 2.1.3
     */
    public static boolean startActivityForResult(Activity activity, Intent intent, int requestCode, Bundle options) {
        return Factory.startActivityForResult(activity, intent, requestCode, options);
    }複製程式碼

繫結外掛中的service

跟啟動外掛中的activity方式差不多,具體的原始碼是位於PluginServiceClient這個類中,下面是繫結service的方法:

  /**
     * 繫結外掛服務,獲取其AIDL。近似於Context.bindService
     *
     * @param context Context物件
     * @param intent  要開啟的服務名。如何填寫請參見類的說明
     * @param sc      ServiceConnection物件(等同於系統)
     * @param flags   flags物件。目前僅支援BIND_AUTO_CREATE標誌
     * @return 是否成功繫結服務。大於0表示成功
     * @see android.content.Context#bindService(Intent, ServiceConnection, int)
     */
    public static boolean bindService(Context context, Intent intent, ServiceConnection sc, int flags) {
        return bindService(context, intent, sc, flags, false);
    }複製程式碼

外掛呼叫宿主元件

開啟宿主的activity,更加簡單。呼叫service也是一樣的道理。

Intent intent = new Intent();
intent.setComponent(new ComponentName("com.qihoo360.replugin.sample.host", "com.qihoo360.replugin.sample.host.MainActivity"));
context.startActivity(intent);複製程式碼
Intent intent1 = new Intent();
                intent1.setComponent(new ComponentName("com.example.asus.replugindemo",
                        "com.example.asus.replugindemo.HostService"));
                startService(intent1);複製程式碼

資源的互相獲取

因為外掛apk與宿主apk不在一個apk內,那麼一些資源的訪問必然要通過反射進行獲取。

宿主獲取外掛資源
Context context = RePlugin.fetchContext("com.example.asus.plugin");
                //獲取外掛中的圖片資源
                Class<?> c=null;
                try {
                    c=context.getClassLoader().loadClass("com.example.asus.plugin.R$drawable");
                    int drawableId= (int) c.getField("ic_face_black_24dp").get(null);
                    iv.setImageDrawable(context.getResources().getDrawable(drawableId));
                } catch (ClassNotFoundException e) {
                    e.printStackTrace();
                } catch (IllegalAccessException e) {
                    e.printStackTrace();
                } catch (NoSuchFieldException e) {
                    e.printStackTrace();
                }
                //獲取外掛中的字串資源
                Class<?> c1=null;
                try {
                    c1=context.getClassLoader().loadClass("com.example.asus.plugin.R$string");
                    Field field=c1.getField("app_name");
                    int strId= (int) field.get(null);
                    tv.setText(context.getResources().getString(strId));
                } catch (ClassNotFoundException e) {
                    e.printStackTrace();
                } catch (IllegalAccessException e) {
                    e.printStackTrace();
                } catch (NoSuchFieldException e) {
                    e.printStackTrace();
                }複製程式碼
外掛獲取宿主資源
            //獲取宿主中的字串資源
                Class<?> clazz = null;
                try {
                    clazz = RePlugin.getHostClassLoader().loadClass("com.example.asus.replugindemo.R$string");
                    Field field = clazz.getField("app_name");
                    int identifierID = (int) field.get(null);
                    tv.setText(RePlugin.getHostContext().getResources().getString(identifierID));
                } catch (ClassNotFoundException e) {
                    e.printStackTrace();
                } catch (IllegalAccessException e) {
                    e.printStackTrace();
                } catch (NoSuchFieldException e) {
                    e.printStackTrace();
                }
                //獲取宿主中的圖片資源
                Class<?> c = null;
                try {
                    c = RePlugin.getHostClassLoader().loadClass("com.example.asus.replugindemo.R$drawable");
                    Field field = c.getField("ic_tag_faces_black_24dp");
                    int drawableId = (int) field.get(null);
                    Drawable drawable = RePlugin.getHostContext().getResources().getDrawable(drawableId);
                    iv.setImageDrawable(drawable);
                } catch (ClassNotFoundException e) {
                    e.printStackTrace();
                } catch (NoSuchFieldException e) {
                    e.printStackTrace();
                } catch (IllegalAccessException e) {
                    e.printStackTrace();
                }複製程式碼

注意問題

  1. context上下文物件,注意用的是外掛的context還是宿主的context
  2. 外掛相關許可權要提前在宿主中註冊。
  3. 利用反射來進行資源的訪問

執行結果

自己寫了個簡單的Demo,就是宿主和外掛之間四大元件的相互呼叫以及資源的相互獲取。外掛是外接外掛。
原始碼地址:github.com/LXD31256949…

image.png
image.png

image.png
image.png

總結

通過這個簡單RePlugin的Demo,學會到了外掛化的基本使用,以及瞭解到了外掛化的原理實現。還有一點,就是RePlugin的原始碼註釋寫得真是非常清晰明瞭,很詳細,值得學習。

相關文章