RePlugin插件化框架的學習

時間 2019-11-21

標籤 replugin 插件框架學習简体版

原文原文鏈接

現狀

最近在接觸插件化方面的技術，學習後趕忙坐下筆記，給入門的朋友看，一塊兒學習，一塊兒進步。
當前比較熱門的插件化框架有下面幾個：java

框架	優勢	缺點
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研發，也是業內首個提出」全面插件化「（全面特性、全面兼容、全面使用）的方案。
其主要優點有：android

極其靈活：主程序無需升級（無需在Manifest中預埋組件），便可支持新增的四大組件，甚至全新的插件
很是穩定：Hook點僅有一處（ClassLoader），無任何Binder Hook！如此可作到其崩潰率僅爲「萬分之一」，並完美兼容市面上近乎全部的Android ROM
特性豐富：支持近乎全部在「單品」開發時的特性。包括靜態Receiver、Task-Affinity坑位、自定義Theme、進程坑位、AppCompat、DataBinding等
易於集成：不管插件仍是主程序，只需「數行」就能完成接入
管理成熟：擁有成熟穩定的「插件管理方案」，支持插件安裝、升級、卸載、版本管理，甚至包括進程通信、協議版本、安全校驗等
數億支撐：有360手機衛士龐大的數億用戶作支撐，三年多的殘酷驗證，確保App用到的方案是最穩定、最適合使用的

支持的特性：git

特性	描述
組件	四大組件（含靜態Receiver）
升級無需改主程序Manifest	完美支持
Android特性	支持近乎全部（包括SO庫等）
TaskAffinity & 多進程	支持（坑位方案）
插件類型	支持自帶插件（自識別）、外置插件
插件間耦合	支持Binder、Class Loader、資源等
進程間通信	支持同步、異步、Binder、廣播等
自定義Theme & AppComat	支持
DataBinding	支持
安全校驗	支持
資源方案	獨立資源 + Context傳遞（相對穩定）
Android 版本	API Level 9+ （2.3及以上）

使用

1、添加依賴

項目目錄下的build.gradle文件：github

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文件bash

apply plugin: 'replugin-plugin-gradle'

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

修改完上面的文件後，點擊sync後，就能夠開始實現插件化了。併發

配置Application類

若是您的工程已有Application類，則能夠將基類切換到RePluginApplication便可。而後能夠經過自定義RePluginCallbacks類和RePluginEventCallbacks類來實現宿主針對RePlugin的自定義行爲app

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);
    }
}複製代碼

安裝或者升級插件

思路：
一、判斷插件是否已經安裝；
二、若是沒有安裝，檢測本地是否下載插件；
三、沒有下載插件，須要先下載插件；
四、若是沒有安裝插件，須要安裝插件；框架

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();
                }複製代碼