Android插件化最佳方案--Phantom 实践指南

忘是亡心i 2022-04-16 04:42 462阅读 0赞

# PhantomTest #

满帮集团插件化框架[Phantom][]使用演示

[![github-_E9_A1_B9_E7_9B_AE_E5_9C_B0_E5_9D_80-blue.svg][]][github-_E9_A1_B9_E7_9B_AE_E5_9C_B0_E5_9D_80-blue.svg 1]

## Phantom插件化演示（请star支持） ##

![在这里插入图片描述][20181117010841322.gif]

## 演示demo下载 ##

[![E5_AE_BF_E4_B8_BBapk-1.8M-blue.svg][]][E5_AE_BF_E4_B8_BBapk-1.8M-blue.svg 1]  
[![E6_8F_92_E4_BB_B6apk-1M-blue.svg][]][E6_8F_92_E4_BB_B6apk-1M-blue.svg 1]

注意：请将插件apk拷贝至sdcard下。

## Phantom介绍 ##

> Phantom 是满帮集团开源的一套稳定、灵活、兼容性好的 Android 插件化方案。

## Phantom特点 ##

*  兼容性好：零 Hook，没有调用系统的 hidden API，完美兼容 Android 9.0
 *  功能完整：插件支持独立应用的绝大部分特性
 *  稳定可靠：历经货车帮旗下多款产品 50+ 插件两年多千万级用户验证（稳定性和兼容性指标都在 4 个 9 以上）
 *  部署灵活：宿主无需升级（无需在宿主 AndroidManifest.xml 中预埋组件），即可支持插件新增组件，甚至新增插件
 *  易于集成：无论插件端还是宿主端，只需『数行』就能完成接入，改造成本低

## Phantom不支持项 ##

*  暂时不支持 Gradle 4.x + Android Gradle Plugin 3.x
 *  暂时不支持 Android DataBinding
 *  不支持ContentProvider
 *  [其他不支持项][Link 1]

## Phantom 与主流开源插件框架的对比【官方给的】 ##

<table> 
 <thead> 
  <tr> 
   <th>特性</th> 
   <th><a href="https://github.com/alibaba/atlas" title="Atlas" rel="nofollow">Atlas</a></th> 
   <th><a href="https://github.com/wequick/Small" title="Small" rel="nofollow">Small</a></th> 
   <th><a href="https://github.com/didi/VirtualAPK" title="VirtualAPK" rel="nofollow">VirtualAPK</a></th> 
   <th><a href="https://github.com/Qihoo360/RePlugin" title="RePlugin" rel="nofollow">RePlugin</a></th> 
   <th><a href="https://github.com/ManbangGroup/Phantom" title="Phantom" rel="nofollow">Phantom</a></th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>Hook 数量</td> 
   <td>较多</td> 
   <td>较少</td> 
   <td>较少</td> 
   <td>仅一处</td> 
   <td><strong>零</strong></td> 
  </tr> 
  <tr> 
   <td>四大组件</td> 
   <td>全支持</td> 
   <td>只支持 <code>Activity</code></td> 
   <td>全支持</td> 
   <td>全支持</td> 
   <td>除 <code>ContentProvider</code> 外，全支持</td> 
  </tr> 
  <tr> 
   <td>剔除公共库</td> 
   <td>支持</td> 
   <td>支持</td> 
   <td>支持</td> 
   <td>不支持</td> 
   <td>支持</td> 
  </tr> 
  <tr> 
   <td>兼容性适配</td> 
   <td>高</td> 
   <td>高</td> 
   <td>高</td> 
   <td>高</td> 
   <td>非常高</td> 
  </tr> 
  <tr> 
   <td>插件热更新</td> 
   <td>不支持</td> 
   <td>不支持</td> 
   <td>不支持</td> 
   <td>不支持</td> 
   <td>支持</td> 
  </tr> 
  <tr> 
   <td>插件快速部署</td> 
   <td>不支持</td> 
   <td>不支持</td> 
   <td>不支持</td> 
   <td>支持</td> 
   <td>支持</td> 
  </tr> 
  <tr> 
   <td>插件宿主通信</td> 
   <td>一般</td> 
   <td>一般</td> 
   <td>弱</td> 
   <td>一般</td> 
   <td>强</td> 
  </tr> 
 </tbody> 
</table>

## Phantom集成指南 ##

### 宿主程序 ###

> 宿主程序相当于一个空壳容器，用于加载插件APK，需要注意的是，插件使用到的权限，宿主也要同步获取，否则将无法正常运行。

#### 配置Gradle脚本 ####

> 特别需要注意的是，这里一定要使用 `Gradle 3.3 + Android Gradle Plugin 2.3.3`的方式，否则会

1.在宿主项目根目录下的 build.gradle 中增加宿主 gradle 依赖

buildscript {
        dependencies {
          classpath 'com.wlqq.phantom:phantom-host-gradle:3.0.0'
        }
    }

2.在宿主项目的 App 模块的 build.gradle 中增加宿主 library 依赖，并应用宿主 gradle 依赖包含的 gradle 插件 `com.wlqq.phantom.host`。

apply plugin: 'com.wlqq.phantom.host'
    
    dependencies {
        compile 'com.wlqq.phantom:phantom-host-lib:3.0.0'
    }

#### 插件初始化 ####

在Application的onCreate初始化 Phantom 插件框架.详细配置可[点击查看][Link 2]

public class YourApplication extends Application {
        @Override
        public void onCreate() {
           super.onCreate();
           //初始化Phantom框架，并加载已经安装的插件
           PhantomCore.getInstance().init(this, new PhantomCore.Config());
        }
    }

#### 插件安装和卸载 ####

> 详细说明请见[官方文档][Link 3]

1.插件安装

*  installPlugin: 从SDCard卡上安装插件。

PhantomCore.getInstance().installPlugin(Environment.getExternalStorageDirectory() + "/com.xuexiang.xqrcodetest_1.0.apk");

*  installPluginFromAssets: 从assets下安装插件

PhantomCore.getInstance().installPluginFromAssets("plugins/com.wlqq.phantom.plugin.view_1.0.0.apk")

2.如何判断插件是否已安装

使用PhantomCore.getInstance().isPluginInstalled(“插件包名”)判断。

PhantomCore.getInstance().isPluginInstalled("com.xuexiang.xqrcodetest")

3.插件卸载

使用PhantomCore.getInstance().uninstallPlugin(“插件包名”)来卸载插件。

PhantomCore.getInstance().uninstallPlugin("com.xuexiang.xqrcodetest");

4.插件启用

插件安装完之后，启动插件代表该插件将被立即加载到内存中，调用 PluginInfo 接口中 start() 即可.

InstallResult ret = PhantomCore.getInstance().installPlugin(Environment.getExternalStorageDirectory() + "/com.xuexiang.xqrcodetest_1.0.apk");
    // 插件安装成功后启动插件(执行插件的 Application#onCreate 方法)
    if (ret.isSuccess() && ret.plugin.start()) {
        Intent intent = new Intent();
        // 指定插件 Activity 所在的插件包名以及 Activity 类名
        intent.setClassName("com.xuexiang.xqrcodetest", "com.xuexiang.xqrcodetest.Main2Activity");
        PhantomCore.getInstance().startActivity(this, intent);
    }

### 插件程序 ###

> 插件程序作为一个独立的apk，可以独立安装，也可以被宿主程序安装加载使用。需要注意的是，插件使用到的权限，宿主也要同步获取，否则将无法正常运行。

#### 配置Gradle脚本 ####

> 特别需要注意的是，这里一定要使用 `Gradle 3.3 + Android Gradle Plugin 2.3.3`的方式，否则会

1.在插件项目根目录下的 build.gradle 中增加插件 gradle 依赖

buildscript {
        dependencies {
          classpath 'com.wlqq.phantom:phantom-plugin-gradle:3.0.0'
        }
    }

2.在插件项目 App 模块的 build.gradle 中增加插件 library 依赖，并应用宿主 gradle 依赖包含的 gradle 插件 `com.wlqq.phantom.plugin`

apply plugin: 'com.wlqq.phantom.plugin'
    
    android {
        buildTypes {
            release {
                minifyEnabled true
                proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
                // Phantom 混淆配置文件
                proguardFile 'proguard-phantom.pro'
            }
        }
    }
    
    dependencies {
        provided 'com.wlqq.phantom:phantom-plugin-lib:3.0.0'
        compile 'com.android.support:support-v4:28.0.0'
    }

3.配置PhantomPlugin插件的参数

着重注意`hostApplicationId`和`hostAppLauncherActivity`这两个参数，是需要你配成自己的宿主信息。

phantomPluginConfig {
        // BEGIN 剔除公共库配置
        // 若插件中有使用 support-v4 ，则需要剔除掉(必须)
        excludeLib "com.android.support:support-v4:28.0.0"
        // END
    
        // BEGIN 生成插件额外的混淆配置文件，避免因剔除公共库引起的混淆问题
        libraryJarsProguardFile file('proguard-phantom.pro')
        // END
    
        // BEGIN 快速部署插件配置
        // 宿主包名,这里需要改成你自己的
        hostApplicationId = "com.xuexiang.phantomtest"
        // 宿主 launcher Activity full class name
        hostAppLauncherActivity = "com.xuexiang.phantomtest.MainActivity"
        // 插件包名,这里需要改成你自己的
        pluginApplicationId = android.defaultConfig.applicationId
        // 插件版本名
        pluginVersionName = android.defaultConfig.versionName
        // END
    }

4.在插件 AndroidManifest.xml 中申明对宿主 Phantom 插件框架版本依赖（目前版本名是 3.0.0，对应版本号为 30000）

### 编译 ###

#### 编译插件 ####

与编译独立 APK 相同，如：

*  `./gradlew assembleDebug`
 *  `./gradlew assembleRelease`

#### 编译插件并将插件 APK 安装到宿主 ####

插件端使用的 Gradle 插件会自动为项目的 variant 生成相应的插件安装 task ，格式为 `phInstallPlugin${variant}` ，例如：

*  `./gradlew phInstallPluginDebug`
 *  `./gradlew phInstallPluginRelease`

注意：以上命令会自动将插件的apk文件push到手机的sdcard目录。

## 其他说明 ##

*  [四大组件][Link 4]
 *  [Phantom 通信服务][Phantom 1]
 *  [插件 meta-data][meta-data]
 *  [Phantom 安全签名校验][Phantom 2]
 *  [Native 支持][Native]

## 联系方式 ##

Phantom官方交流 QQ 群号：**690051836**

[![E7_82_B9_E5_87_BB_E4_B8_80_E9_94_AE_E5_8A_A0_E5_85_A5QQ_E4_BA_A4_E6_B5_81_E7_BE_A4-602082750-blue.svg][]][E7_82_B9_E5_87_BB_E4_B8_80_E9_94_AE_E5_8A_A0_E5_85_A5QQ_E4_BA_A4_E6_B5_81_E7_BE_A4-602082750-blue.svg 1]

![在这里插入图片描述][20181117010924672.jpg]

[Phantom]: https://github.com/ManbangGroup/Phantom
[github-_E9_A1_B9_E7_9B_AE_E5_9C_B0_E5_9D_80-blue.svg]: https://img.shields.io/badge/github-%E9%A1%B9%E7%9B%AE%E5%9C%B0%E5%9D%80-blue.svg
[github-_E9_A1_B9_E7_9B_AE_E5_9C_B0_E5_9D_80-blue.svg 1]: https://github.com/xuexiangjys/PhantomTest
[20181117010841322.gif]: /images/20220416/292e333a84aa4f62af76c7a905bc8689.png
[E5_AE_BF_E4_B8_BBapk-1.8M-blue.svg]: https://img.shields.io/badge/%E5%AE%BF%E4%B8%BBapk-1.8M-blue.svg
[E5_AE_BF_E4_B8_BBapk-1.8M-blue.svg 1]: https://github.com/xuexiangjys/PhantomTest/blob/master/apk/com.xuexiang.phantomtest_1.0.apk
[E6_8F_92_E4_BB_B6apk-1M-blue.svg]: https://img.shields.io/badge/%E6%8F%92%E4%BB%B6apk-1M-blue.svg
[E6_8F_92_E4_BB_B6apk-1M-blue.svg 1]: https://github.com/xuexiangjys/PhantomTest/blob/master/apk/com.xuexiang.xqrcodetest_1.0.apk
[Link 1]: https://github.com/ManbangGroup/Phantom/blob/master/docs/known-issues.md
[Link 2]: https://github.com/ManbangGroup/Phantom/blob/master/docs/phantom-core-init.md
[Link 3]: https://github.com/ManbangGroup/Phantom/blob/master/docs/plugin-management.md
[Link 4]: https://github.com/ManbangGroup/Phantom/blob/master/docs/components.md
[Phantom 1]: https://github.com/ManbangGroup/Phantom/blob/master/docs/phantom-service.md
[meta-data]: https://github.com/ManbangGroup/Phantom/blob/master/docs/android-manifest-metadata.md
[Phantom 2]: https://github.com/ManbangGroup/Phantom/blob/master/docs/security.md
[Native]: https://github.com/ManbangGroup/Phantom/blob/master/docs/native.md
[E7_82_B9_E5_87_BB_E4_B8_80_E9_94_AE_E5_8A_A0_E5_85_A5QQ_E4_BA_A4_E6_B5_81_E7_BE_A4-602082750-blue.svg]: https://img.shields.io/badge/%E7%82%B9%E5%87%BB%E4%B8%80%E9%94%AE%E5%8A%A0%E5%85%A5QQ%E4%BA%A4%E6%B5%81%E7%BE%A4-602082750-blue.svg
[E7_82_B9_E5_87_BB_E4_B8_80_E9_94_AE_E5_8A_A0_E5_85_A5QQ_E4_BA_A4_E6_B5_81_E7_BE_A4-602082750-blue.svg 1]: http://shang.qq.com/wpa/qunwpa?idkey=9922861ef85c19f1575aecea0e8680f60d9386080a97ed310c971ae074998887
[20181117010924672.jpg]: /images/20220416/88c624dfebde4910bdbccbfa527f9497.png