VirtualAPK是什么

VirtualAPK是滴滴出行自研的一款优秀的插件化框架。

VirtualAPK使用场景

项目庞大，想分多个APK实现，但不希望占用过多内存时——复杂性、内存

我们知道Android打开一个APK应用，就是创建了一个进程，并跑在一个单独的虚拟机内，而创建一个进程对内存消耗是相对较大的，如果创建多个进程便会占用更多内存。但我们又希望将项目分成多个APK，并行开发，然后多个APK之间又能相互通信。针对这样的需求痛点，VirtualAPK是可以满足，因为它就是以APK作为插件的方式嵌入到项目中，而又不会创建新的进程。

项目需要解耦合时——解耦合

比如，一个项目分一个宿主和多个模块，我们希望各个模块和宿主尽量解耦合。VirtualAPK是以独立APK的方式，可以满足。

项目中各模块可以和宿主通信，也可以相互通信——通信

宿主和各模块通过引用相同的aar来实现，即aar作为一个三方中转，来进行相互通信，并且模块构建的时候会自动将这个aar从APK中剔除。

项目中的模块可以自升级——多变性

各模块可能频繁更新功能或者修复bug，如果我们还采用一个Apk接入所有模块需求的话，那么每一个模块的变动都需要Apk去更新，所以我们希望各模块可以自升级。VirtualAPK加载APK的时候是去某个绝对路径下，我们只需更改这个绝对路径下的APK文件，就做到了模块自升级。

VirtualAPK如何使用

按如下12个步骤可轻松接入VirtualAPK，先整体罗列，然后分步展开：

在宿主项目，根目录下的build.gradle文件中添加 classpath 'com.didi.virtualapk:gradle:0.9.8.6'
在宿主项目，app下的build.gradle文件中顶端添加 apply plugin: 'com.didi.virtualapk.host'
在宿主项目，app下的build.gradle文件中底部添加 compile 'com.didi.virtualapk:core:0.9.8'
在宿主项目，Application下的attachBaseContext()方法中添加 PluginManager.getInstance(base).init();
在宿主项目，app下的proguard-rules.pro文件中添加混淆规则
在模块APK，根目录下的build.gradle文件中添加 classpath 'com.didi.virtualapk:gradle:0.9.8.6'
在模块APK，app下的build.gradle文件中顶端添加 apply plugin: 'com.didi.virtualapk.plugin'
在模块APK，app下的build.gradle文件中底部配置 VirtualAPK
在宿主项目，app下的文件中加载模块APK，然后可以跳转模块APK，或者与之通信
在宿主项目，app下的AndroidManifest.xml文件中添加读写存储权限
构建宿主项目与模块APK
将模块APK拷贝至存储设备某个目录，安装运行宿主APK

（1）在宿主项目，根目录下的build.gradle文件中添加 classpath 'com.didi.virtualapk:gradle:0.9.8.6'

扫描二维码关注公众号，回复： 9254390 查看本文章

dependencies {
//noinspection GradleDependency
classpath 'com.android.tools.build:gradle:3.1.3'
classpath group: 'org.tmatesoft.svnkit', name: 'svnkit', version: '1.8.11'
classpath 'com.didi.virtualapk:gradle:0.9.8.6'
// NOTE: Do not place your application dependencies here; they belong
// in the individual module build.gradle files
}

（2）在宿主项目，app下的build.gradle文件中顶端添加 apply plugin: 'com.didi.virtualapk.host'

apply plugin: 'com.android.application'
apply plugin: 'com.didi.virtualapk.host'

（3）在宿主项目，app下的build.gradle文件中底部添加 compile 'com.didi.virtualapk:core:0.9.8'

dependencies {
implementation fileTree(dir: 'libs', include: ['*.jar'])
testImplementation 'junit:junit:4.12'
androidTestImplementation 'com.android.support.test:runner:1.0.2'
androidTestImplementation 'com.android.support.test.espresso:espresso-core:3.0.2'

implementation 'com.android.support:recyclerview-v7:27.1.1'
implementation 'com.android.support:appcompat-v7:27.1.1'
implementation(name: 'wifidiagnose-release', ext: 'aar')
implementation 'com.didi.virtualapk:core:0.9.8'
}

（4）在宿主项目，Application下的attachBaseContext()方法中添加 PluginManager.getInstance(base).init();

@Override
protected void attachBaseContext(Context base) {
super.attachBaseContext(base);
PluginManager.getInstance(base).init();
}

（5）在宿主项目，app下的proguard-rules.pro文件中添加混淆规则

-keep class com.didi.virtualapk.internal.VAInstrumentation { *; }
-keep class com.didi.virtualapk.internal.PluginContentResolver { *; }

-dontwarn com.didi.virtualapk.**
-dontwarn android.**
-keep class android.** { *; }

（6）在模块APK，根目录下的build.gradle文件中添加 classpath 'com.didi.virtualapk:gradle:0.9.8.6'

dependencies {
classpath 'com.android.tools.build:gradle:3.1.2'
// classpath ('com.tencent.tinker:tinker-patch-gradle-plugin:1.9.1')
// classpath ("com.tinkerpatch.sdk:tinkerpatch-gradle-plugin:${TINKERPATCH_VERSION}") { changing = true }
// NOTE: Do not place your application dependencies here; they belong
// in the individual module build.gradle files
classpath 'com.didi.virtualapk:gradle:0.9.8.6'
}

（7）在模块APK，app下的build.gradle文件中顶端添加 apply plugin: 'com.didi.virtualapk.plugin'

apply plugin: 'com.android.application'
//apply from: 'tinkerpatch.gradle'
apply plugin: 'com.didi.virtualapk.plugin'

（8）在模块APK，app下的build.gradle文件中底部配置VirtualAPK

virtualApk {
// 插件资源表中的packageId，需要确保不同插件有不同的packageId.
// 范围 0x1f - 0x7f
packageId = 0x6f

// 宿主工程application模块的路径，插件的构建需要依赖这个路径
targetHost = 'C:\\AndroidStudioProjects\\SystemDiagnose\\app'

//默认为true，如果插件有引用宿主的类，那么这个选项可以使得插件和宿主保持混淆一致
applyHostMapping = true
}

（9）在宿主项目，app下的文件中加载模块APK，然后可以跳转模块APK，或者与之通信

public class TestActivity extends Activity {
private static final String TAG = TestActivity.class.getSimpleName();

@Override
protected void onCreate(@Nullable Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
Log.d(TAG,"onCreate()");
String pluginPath = Environment.getExternalStorageDirectory().getAbsolutePath().concat("/plugin.apk");
File plugin = new File(pluginPath);
try {
PluginManager.getInstance(getApplicationContext()).loadPlugin(plugin);
} catch (Exception e) {
Log.e(TAG,"error");
e.printStackTrace();
}
findViewById(R.id.iv_get_plugin).setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
Log.d(TAG,"onCLick");
// Given "com.agg.application" is the package name of plugin APK,
// and there is an activity called `MainActivity`.
Intent intent = new Intent();
intent.setClassName("com.agg.application", "com.agg.application.view.activity.MainActivity");
startActivity(intent);
}
});
}
}

（10）在宿主项目，app下的AndroidManifest.xml文件中添加读写存储权限

<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />

（11）构建宿主项目与模块APK

宿主的构建和正常apk的构建方式是相同的，可以通过Build > Generate Signed APK的方式，也可以命令：gradlew clean assembleRelease，或者如下图方式，构建完成的apk在app > build > outputs > apk > release目录下。

模块APK构建可以命令：gradlew clean assemblePlugin，也可以如下图方式，构建完成的apk在app > build > outputs > plugin > release目录下。

（12）将模块APK拷贝至存储设备某个目录，安装运行宿主APK

存储设备目录在第9步中使用，至此，接入VirtualAPK大功告成。

备注：

targetHost配置问题——targetHost可以设置绝对路径或相对路径，它是宿主工程application模块的路径，模块APK的构建需要依赖这个路径。
读写存储的权限设置——6.0以上手机需要动态申请,或手动在设置中打开权限。

VirtualAPK原理简析

基本原理

合并宿主和插件的ClassLoader 需要注意的是，插件中的类不可以和宿主重复
合并插件和宿主的资源 重设插件资源的packageId，将插件资源和宿主资源合并
去除插件包对宿主的引用 构建时通过Gradle插件去除插件对宿主的代码以及资源的引用

四大组件的实现原理

Activity 采用宿主manifest中占坑的方式来绕过系统校验，然后再加载真正的activity；
Service 动态代理AMS，拦截service相关的请求，将其中转给Service Runtime去处理，Service Runtime会接管系统的所有操作；
Receiver 将插件中静态注册的receiver重新注册一遍；
ContentProvider 动态代理IContentProvider，拦截provider相关的请求，将其中转给Provider Runtime去处理，Provider Runtime会接管系统的所有操作。