插件的管理

无论是插件还是主程序，都可以对自己和其它插件做相应的插件管理工作。

这篇文档主要讲解有关插件管理方面的基本用法。分为：外置插件（主要）和内置插件。

外置插件

外置插件是指可通过“下载”、“放入SD卡”等方式来安装并运行的插件。

以下是“外置插件”的管理方案。

安装插件

要安装一个插件，只需使用 RePlugin.install 方法，传递一个“APK路径”即可。

RePlugin.install("/sdcard/exam.apk");

最佳实践

以下为360手机卫士或其它合作App采用的设计，可供您参考：

• 除非是基础和核心功能插件，否则请尽量减少“静默安装”插件的情况，以减少内部存储空间的消耗，降低对用户的影响。
• 若插件需要下载，则请覆写RePluginCallbacks.onPluginNotExistsForActivity方法，并在此打开您的下载页面并控制其逻辑
• 下载插件前建议告知用户其“插件大小”，尤其针对运营商网络的情况

有关“插件下载”处理的具体方法，请点击此处阅读《插件自定义行为》中“插件下载”一节

升级插件

为了简化操作，升级插件的做法和“安装”是一样的，仍可以直接调用 RePlugin.install 方法。

RePlugin.install("/sdcard/exam_new.apk");

注意

• 如果插件正在运行，则不会立即升级，而是“缓存”起来。直到所有“正在使用插件”的进程结束并重启后才会生效
• 升级可能会占用“内部存储空间”（因为要释放新的APK）
• 不支持“插件降级”，但可以“同版本覆盖”

出于稳定性和实际需求考虑，RePlugin暂时没有计划支持“热修复”方案。然而，如您有0 Hook（极其稳定的前提下）能和RePlugin融合的“热修复”方案，欢迎提出您的PR，我们非常期待您的贡献。

最佳实践

以下为360手机卫士或其它合作App采用的设计，可供您参考：

• 大部分情况下，应尽可能“静默升级”，以减少对用户的打扰
• 针对升级而言，可在后台线程做一次“预加载”，提前释放Dex。具体做法：

PluginInfo pi = RePlugin.install("/sdcard/exam_new.apk");
if (pi != null) {
	RePlugin.preload(pi);
}

• 若插件正在运行，则会有两种场景，需分别对待：
  • 若是遇到严重问题，需要“强制升级”，则应立即提示用户，待同意后则重启进程
  • 通常情况下，建议在“锁定屏幕”后重启进程，让其在后台生效
• 若插件没有运行，则可直接升级

卸载插件

要卸载插件，则需要使用 RePlugin.uninstall 方法。只需传递一个“插件名”即可。

RePlugin.uninstall("exam");

注意

• 如果插件正在运行，则不会立即卸载插件，而是将卸载诉求记录下来。直到所有“正在使用插件”的进程结束并重启后才会生效
• 由于内置插件是捆在主程序包内的，故无法卸载“内置插件”（此处有优化空间，我们还在商量对策）

出于稳定性和实际需求考虑，RePlugin暂时没有计划支持“热卸载”方案。然而，如您有0 Hook（极其稳定的前提下）能和RePlugin融合的方法，欢迎提出您的PR，我们非常期待您的贡献。

最佳实践

以下为360手机卫士或其它合作App采用的设计，可供您参考：

• 在卸载时弹出对话框，提示用户“是否同意卸载”
• 若插件在运行时需要被卸载，则有两种做法：
  • 提示用户“需要重新启动应用才能生效”
  • 在“锁定屏幕”后重新启动进程，让其在后台生效
• 若插件没有运行，则可以直接卸载，无需提示用户

内置插件

内置插件是指可以“随着主程序发版”而下发的插件，通常这个插件会放到主程序的Assets目录下。

针对内置插件而言，开发者可无需调用安装方法，由RePlugin来“按需安装”。

“内置插件”是可以被“升级”的。升级后的插件等同于“外置插件”

添加内置插件

添加一个内置插件是非常简单的，甚至可以“无需任何Java代码”。只需两步即可：

• 将APK改名为：[插件名].jar
• 放入主程序的assets/plugins目录

这样，当编译主程序时，我们的“动态编译方案”会自动在assets目录下生成一个名叫“plugins-builtin.json”文件，记录了其内置插件的主要信息，方便运行时直接获取。

必须改成“[插件名].jar”后，才能被RePlugin-Host-Gradle识别，进而成为“内置插件”。

[插件名]可以是“包名”，也可以是“插件别名”。

有关这方面的说明，请点击此处阅读《插件的信息》中“插件命名”一节。

删除内置插件

删除内置插件非常简单，直接移除相应的Jar文件，其余均交给RePlugin来自动化完成。

注意：若用户已使用了内置插件，则即便用户升级主程序，其包内已不带这个内置插件，但用户仍可继续使用它

这样可防止出现“用户升级主程序后，发现内置插件突然用不了”的情况。

使用内置插件的时机

不同于“外置插件”需要先调用 RePlugin.install 方法后才能使用，内置插件可无需调用此方法。而一旦插件被使用，则RePlugin会在触发相应逻辑前，为您做下列操作：

• 将内置插件释放到数据目录下（近似于调用install方法）
• 若需要加载Dex，则还会释放“优化后的Dex”到数据目录下，这可能会需要一些时间

这样做的好处是，不会占用太多的“内部存储空间”，毕竟不是所有内置插件，都一定会被用到。

内置插件的升级

内置插件的升级分为两种情况：主程序随包升级、通过install方法升级

• 主程序随包升级：当用户升级了带“新版本内置插件”的主程序时，则RePlugin会在使用插件前先做升级
• 通过install方法升级：若通过 RePlugin.install 方法做的升级（大多为用户从服务器上下载并更新），则RePlugin在调用install方法时开始做升级。当然，其规则仍遵循安装插件的规则，例如“插件运行时先不覆盖”等。

值得注意的是，无论采用何种方式，均“不支持降级”，但支持“同版本覆盖”升级，也即：

• 内置插件：只要APK的时间戳和大小发生变化就升级，若两者均无变化，则不会升级。（在 RePlugin 2.2.0版本中开始支持)
• 外置插件：只要调用 RePlugin.install 方法即可将“内置插件”转化为“外置插件”。同样的，需遵循安装插件规则。

最佳实践

以下为360手机卫士或其它合作App采用的设计，可供您参考：

• 需控制“内置插件”的数量，因为会占用主程序APK的大小
• 比较适合成为“内置插件”的有：
  • 核心业务插件：没有它就等于“核心功能缺失”。比如360手机卫士的“首页体检”、“清理”插件等
  • 基础插件：各插件都需要用到，且为必须的。比如“安全WebView”、“下载”插件等
  • 启动时必备插件：明确要在启动时要用到的功能。比如360手机卫士的“Push”、“常驻服务管理”等
• 可将一些启动时必须要加载的，以及经常要用到的内置插件做一次“预加载”。具体做法：

RePlugin.preload("exam");