深入解析Android-Plugin-Framework

Android-Plugin-Framework是一個Android插件化框架，用於通過動態加載的方式免安裝運行插件apk

最新版本: ‘com.github.limpoxe:Android-Plugin-Framework:0.0.70@aar’

此項目主要目標是爲了運行非獨立插件，而不是任意第三方app。

儘管此框架支持獨立插件，但目標並不是爲了支持任意三方app，不同於平行空間或應用分身之類的產品。 非獨立插件相比任意三方app來說，可以預見到其使用了哪些系統api和特性，而且所有行爲都是可以預測的。而任意三方app是不可預測的。 框架的做法是按需hook，即需要用到哪些系統特性和api，就對哪些特性和api提供支持。這種做法對開發非獨立插件和二方獨立插件而言完全足夠。 目前已經添加了對常用特性和api的支持，如需使用的api還未支持請聯繫作者。

FEATURE

• 框架透明, 插件開發與普通apk開發無異，無約定約束
• 支持非獨立插件和獨立插件(非任意三方)
• 支持四大組件/Application/Fragment/Accessibility/LaunchMode/so
• 支持插件Theme/Style,宿主Theme/Style,輕鬆支持基於主題屬性的皮膚切換
• 支持插件發送Notification/時在RemoteViews中攜帶插件中的資源（只支持5.x及以上, 且不支持miui8）
• 支持插件熱更新：即在插件模塊已經被喚起的情況先安裝新版本插件，無需重啓插件進程（前提是插件高度內斂，宿主不主動持有插件中的任何對象）
• 支持全局服務：即插件向容器註冊一個服務，其他所有插件已經宿主都獲取並調用此服務
• 支持DataBinding（僅限獨立插件）
• 支持插件WebView加載插件本地HTML文件
• 支持插件Fragment/View內嵌宿主Activity中
• 支持FileProvider
• 支持2.3-9.0

LIMIT

• 不支持插件Activity轉場動畫使用插件中的動畫資源
• 不支持插件Manifest中申請權限，所有權限必須預埋到宿主Manifest中
• 不支持第三方app試圖喚起插件中的組件時直接使用插件組件的Intent。 第三方app要喚起插件中的靜態組件，例如Activity/service/Provider，必須由宿主程序進行橋接，即此組件需同時預埋到宿主和插件的Manifest中
• 不支持android.app.NativeActivity
• 不支持當一個插件依賴另一個插件時，被插件依賴的包含資源
• 不支持插件中的webview彈出原生Chrome組件 例如通過html的標籤設置時間選擇器。 說明：是否能支持原生組件取決於系統中使用WebView的實現。 如果是使用的Android System Webview，則可以支持。因爲它packageId是以0x3f開頭； 如果是使用的Chrome Webview，則不支持。因爲它packageId是以0x7f開頭，會和插件衝突。 這是採用Public.xml進行資源分組的缺陷。
• 可能不支持對插件或者宿主進行加殼加固處理，未嘗試

使用方法

    allprojects {
    		repositories {
    			...
    			maven { url 'https://jitpack.io' }
    		}
    }

宿主側

1、 新建一個工程，作爲宿主工程

2、 在宿主工程的build.gradle文件下添加如下3個配置

    //插件腳本
    apply from: "https://raw.githubusercontent.com/limpoxe/Android-Plugin-Framework/master/FairyPlugin/host.gradle"        

    android {
        defaultConfig {
            //這個配置不可省略
            applicationId 宿主app包名        
        }
    }

    dependencies {
        //請務必使用@aar結尾，以中斷依賴傳遞
        implementation('com.github.limpoxe:Android-Plugin-Framework:0.0.70@aar')
        //可選，用於支持插件全局函數式服務，不使用全局函數式服務不需要添加此依賴
        //implementation('com.limpoxe.support:android-servicemanager:1.0.5@aar')
    }

    fairy {
        //可選配置，用於指定插件進程名。默認插件進程爲單獨的進程，進程名爲":plugin"
        //若設置爲空串或者null即是使用宿主進程作爲插件進程
        //pluginProcess = ""
        //pluginProcess = null
        //pluginProcess = ":xxx"
    }

3、 在宿主工程中新建一個類繼承自Application類, 並配置到AndroidManifest.xml中並重寫這個類的下面2個方法

    @Override
    protected void attachBaseContext(Context base) {
        super.attachBaseContext(base);

        //框架日誌開關, 默認false
        FairyGlobal.setLogEnable(true);

        //首次加載插件會創建插件對象，比較耗時，通過彈出loading頁來過渡。
        //這個方法是設置首次加載插件時, 定製loading頁面的UI, 不傳即默認沒有loading頁
        //在宿主中創建任意一個layout傳進去即可
        //注意：首次喚起插件組件時，如果是通過startActivityForResult喚起的，如果配置了loading頁，
        //則實際是先打開了loading頁，再轉到目標頁面，此時會忽略ForResult的結果。這種情況下應該禁用loading頁配置
        FairyGlobal.setLoadingResId(R.layout.loading);

        //是否支持插件中使用本地html, 默認false
        FairyGlobal.setLocalHtmlenable(true);

        //初始化框架
        PluginLoader.initLoader(this);
    }

    @Override
    public Context getBaseContext() {
        return PluginLoader.fixBaseContextForReceiver(super.getBaseContext());
    }

4、在宿主工程中通過下面3個方法進行最基本的插件操作

    安裝: PluginManagerHelper.installPlugin( SDcard上插件apk的路徑 );
    卸載: PluginManagerHelper.remove( 插件packageName );
    列表: PluginManagerHelper.getPlugins();

5、通過構造一個插件組件Intent打開插件

例如打開插件的Launcher界面

   Intent launchIntent = getPackageManager().getLaunchIntentForPackage( 插件packageName );			
   startActivity(launchIntent);

宿主編譯完成後，會在outputs/distrubites目錄下生成一個名爲host.bar的基線包，作爲編譯插件的基線。 以上所有內容及更多詳情可以參考Demo

插件側

獨立插件：

新建一個工程, 作爲插件工程，無需任何其他配置，編譯出來即可當插件apk安裝到宿主中。

非獨立插件：

1、新建一個工程, 作爲插件工程。

2、在build.gradle中添加如下2個配置

    //插件腳本
    apply from: "https://raw.githubusercontent.com/limpoxe/Android-Plugin-Framework/master/FairyPlugin/plugin.gradle"

    android {
        defaultConfig {
            //這個配置不可省略
            applicationId 插件app包名        
        }
    }

    dependencies {
        //***這是demo中的示例，請根據自己的實際情況修改，作用是指向插件依賴的宿主基線包***
        //支持文件、maven座標等寫法
        //baselinePatch 'xxx:xxx:xxx@bar'
        baselinePatch files(project(':Samples:PluginMain').getBuildDir().absolutePath + '/distributions/host.bar')
    }

完成以上2步後即可編譯出非獨立插件，以上所有內容及更多詳情可以參考Demo

Demo編譯方法

a）如果是命令行中：

   cd  Android-Plugin-Framework

   ./gradlew clean

   ./gradlew :Samples:PluginMain:assembleF1Debug

   ./gradlew :Samples:PluginTesBase:assembleF1Debug

   ./gradlew assembleF1Debug

   ./gradlew :Samples:PluginMain:assembleF1Debug

   說明：由於框架、demo宿主和各個demo插件都在同一個工程下，依賴關係互相影響，因此需要一定的編譯順序才能正常運行

   第一個assembleF1Debug是爲了編譯宿主，產生基線bar文件

   第二個assembleF1Debug是爲了編譯基礎插件，產生插件apk和jar，基礎插件jar會被其他插件依賴

   第三個assembleF1Debug是爲了編譯所有插件，產生插件apk

   第四個assembleF1Debug是爲了重新編譯宿主，將前面編譯生成的插件apk內置到宿主的assets目錄中，作爲內置插件使用

   接下來將宿主的out目錄下的apk安裝到設備上即可

b）如果是studio中：

打開studio右側gradle面板區，點clean、點assembleDebug。不要使用菜單欄的菜單編譯。

重要：

    1、由於編譯腳本依賴Task.doLast, 使用其他編譯方法（如菜單編譯）可能不會觸發Task.doLast導致編譯失敗

    2、必須先編譯宿主，再編譯非獨立插件。（這也是使用菜單欄編譯會失敗的原因之一）
       原因很簡單，既然是非獨立插件，肯定是需要引用宿主的類和資源的。所以編譯非獨立插件時會用到編譯宿主時的輸出物

    3、由於宿主和插件在同一個工程中，點擊assembleDebug時編譯順序不可控，會導致每次clean後，首次assembleDebug會失敗，此時重新編譯即可
       可能需要執行3次assembleDebug，
           第一次是編譯宿主，產生bar文件，
           第二次是依賴bar編譯插件，產生插件文件
           第三次是重新編譯宿主，將插件文件內置到宿主assets中
        所以如果使用其他編譯方法，請務必仔細閱讀build.gradle，瞭解編譯過程和依賴關係後可以自行調整編譯腳本，否則可能會失敗。

    4、Demo中使用了arm平臺的so，若在x86平臺上測試Demo可能會有so異常，請自行適配so。

待插件編譯完成後，即可通過宿主在運行時下載插件apk或者將插件apk複製到sdcard調用PluginManagerHelper.installPlugin(“插件apk絕對路徑”)進行插件安裝。

通常插件會內置一個版本到宿主中隨宿主一起發佈，則需要將插件配置到宿主的assets目錄下，再編譯一次宿主（即上述3中的第三次編譯）。 配置方法如下：

    dependencies {
        //支持座標依賴
        //innerPlugin 'xxx:xxx:xxx@apk'
        innerPlugin '/xx/xx/xx/xx.apk'
    }

增加這個配置以後，宿主在打包時會將這個依賴的插件apk打包到宿主的assets目錄中

其他

1. 使用指南
2. 原理簡介
3. 使用Public.xml的坑和填坑.
4. 更新記錄

推薦閱讀：2017-2020歷年字節跳動Android面試真題解析（累計下載1082萬次，持續更新中）
騰訊技術團隊整理，萬字長文輕鬆徹底入門 Flutter，秒變大前端
37歲老碼農現身說法：那些年，我走過的彎路