天天看點
傳回

深入解析Android-Plugin-Framework使用方法

Android-Plugin-Framework是一個Android插件化架構，用于通過動态加載的方式免安裝運作插件apk

最新版本: ‘com.github.limpoxe:Android-Plugin-Framework:[email protected]’

此項目主要目标是為了運作非獨立插件，而不是任意第三方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:[email protected]')
        //可選，用于支援插件全局函數式服務，不使用全局函數式服務不需要添加此依賴
        //implementation('com.limpoxe.support:android-servicemanager:[email protected]')
    }

           
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:[email protected]'
        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:[email protected]'
        innerPlugin '/xx/xx/xx/xx.apk'
    }

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

其他

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

推薦閱讀：2017-2020曆年位元組跳動Android面試真題解析（累計下載下傳1082萬次，持續更新中）

騰訊技術團隊整理，萬字長文輕松徹底入門 Flutter，秒變大前端

37歲老碼農現身說法：那些年，我走過的彎路

android 安卓 java framework
上一篇: QtCreator運作報錯FTH: (8744)
下一篇: 使用熔斷器防止服務雪崩

繼續閱讀