Qihoo360/RePlugin 主程序接入指南

只需三步,就能让您的“主程序”接入RePlugin:

注意:目前有开发同学反馈,开启Instant Run时可能会出现运行时异常情况,请临时关掉此功能后再试。需要重新编译和安装之前因开启Instant Run的插件和宿主。我们正在为此做兼容处理。谢谢理解!

有关“混淆”

RePlugin的AAR自带Proguard文件,您无需关心,直接引入AAR即可生效。此外,其内部仅Keep了关键的接口类,大部分都是允许被混淆的,故对应用来说也没有影响。

第 1 步:添加 RePlugin Host Gradle 依赖

项目根目录的 build.gradle(注意:不是 app/build.gradle) 中添加 replugin-host-gradle 依赖:

buildscript { dependencies { classpath 'com.qihoo360.replugin:replugin-host-gradle:2.2.4'... } }

第 2 步:添加 RePlugin Host Library 依赖

app/build.gradle 中应用 replugin-host-gradle 插件,并添加 replugin-host-lib 依赖:

android { // ATTENTION!!! Must CONFIG this to accord with Gradle's standard, and avoid some error defaultConfig { applicationId "com.qihoo360.replugin.sample.host"... } ... } // ATTENTION!!! Must be PLACED AFTER "android{}" to read the applicationId apply plugin: 'replugin-host-gradle' repluginHostConfig {  useAppCompat =true countNotTranslucentStandard =6 countNotTranslucentSingleTop =2 countNotTranslucentSingleTask =3 countNotTranslucentSingleInstance =2 } dependencies { compile 'com.qihoo360.replugin:replugin-host-lib:2.2.4'... }

务必注意

以下请务必注意:

  • 请一定要确保符合Gradle开发规范,也即“必须将包名写在applicatonId”,而非AndroidManifest.xml中(通常从Eclipse迁移过来的项目可能出现此问题)。如果不这么写,则有可能导致运行时出现“Failed to find provider info for com.ss.android.auto.loader.p.main”的问题。具体可参见 #87 Issue的问答
  • 请将apply plugin: 'replugin-host-gradle'放在 android{} 块之后,防止出现无法读取applicationId,导致生成的坑位出现异常
  • 如果您的应用需要支持AppComat,则除了在主程序中引入AppComat-v7包以外,还需要在宿主的build.gradle中添加下面的代码若不支持AppComat则请不要设置此项
repluginHostConfig { useAppCompat =true }

开启useAppCompat后,我们会在编译期生成AppCompat专用坑位,这样插件若使用AppCompat的Theme时就能生效了。若不设置,则可能会出现“IllegalStateException: You need to use a Theme.AppCompat theme (or descendant) with this activity.”的异常。

  • 如果您的应用需要个性化配置坑位数量,则需要在宿主的build.gradle中添加下面的代码:
repluginHostConfig {  countNotTranslucentStandard =6 countNotTranslucentSingleTop =2 countNotTranslucentSingleTask =3 countNotTranslucentSingleInstance =2 }

更多可选配置项参见replugin-host-gradle的RepluginConfig类

第 3 步:配置 Application 类

让工程的 Application 直接继承自 RePluginApplication。

如果您的工程已有Application类,则可以将基类切换到RePluginApplication即可。或者您也可以用“非继承式”接入。

publicclassMainApplicationextendsRePluginApplication { }

既然声明了Application,自然还需要在AndroidManifest中配置这个Application

 <applicationandroid:name=".MainApplication" ... />

备选:“非继承式”配置Application

若您的应用对Application类继承关系的修改有限制,或想自定义RePlugin加载过程(慎用!),则可以直接调用相关方法来使用RePlugin。

publicclassMainApplicationextendsApplication { @OverrideprotectedvoidattachBaseContext(Contextbase) { super.attachBaseContext(base); RePlugin.App.attachBaseContext(this); .... } @OverridepublicvoidonCreate() { super.onCreate(); RePlugin.App.onCreate(); .... } @OverridepublicvoidonLowMemory() { super.onLowMemory(); RePlugin.App.onLowMemory(); .... } @OverridepublicvoidonTrimMemory(intlevel) { super.onTrimMemory(level); RePlugin.App.onTrimMemory(level); .... } @OverridepublicvoidonConfigurationChanged(Configurationconfig) { super.onConfigurationChanged(config); RePlugin.App.onConfigurationChanged(config); .... } }

针对“非继承式”的注意点

  • 所有方法必须在UI线程来“同步”调用。切勿放到工作线程,或者通过post方法来执行
  • 所有方法必须一一对应,例如 RePlugin.App.attachBaseContext 方法只在Application.attachBaseContext中调用
  • 请将RePlugin.App的调用方法,放在“仅次于super.xxx()”方法的后面

接下来

如果您想马上着手开发插件,请移步到插件接入指南,跟随指引完成插件的开发

如果您想看下如何安装、运行插件,请移步到详细教程,了解更多玩法。