https://github.com/cherishyan/VirtualAPKDemo
为什么Virtual APK
早在去年就已经想要做一些插件化开发的尝试,或者准确点说,想做功能插件化及热修复的实践;
在7,8月的时候正好看见VirtualAPk开源的相关信息,比较了以后选择Virtual APk,下面这张图可能会比较清晰:
如果想要对github上VirtualAPk的demo尝试,这篇文章VirtualAPK插件框架介绍（一）----框架接入推荐一读.
配置
我认为还是有必要再再再写一遍配置流程,现有的VirtualAPk版本是0.9.1,但是推荐使用0.9.0的版本.毕竟现在还不算是正式版本,0.9.1会带来新的问题
Gradle版本最好还是配置成2.14.1
com.android.tools.build版本号最好还是配置成2.1.3
以上无论宿主工程还是插件工程都适用
- 宿主
项目build.gradle中依赖:
dependencies {
classpath 'com.didi.virtualapk:gradle:0.9.0'
}
app的build.gradle中:
apply plugin: 'com.didi.virtualapk.host'
...
...
dependencies {
compile 'com.didi.virtualapk:core:0.9.0'
}
做了混淆的添加混淆规则:
-keep class com.didi.virtualapk.internal.VAInstrumentation { *; }
-keep class com.didi.virtualapk.internal.PluginContentResolver { *; }
-dontwarn com.didi.virtualapk.**
-dontwarn android.content.pm.**
-keep class android.** { *; }
自定义的Application类中初始化SDK:
@Override
protected void attachBaseContext(Context base) {
super.attachBaseContext(base);
PluginManager.getInstance(base).init();
}
以上宿主的初始化部分基本完成,如果想要加载已经下载的插件apk,一句话即可:
pluginManager.loadPlugin(apk);这个放在后面介绍.
- 插件
项目build.gradle依赖:
dependencies {
classpath 'com.didi.virtualapk:gradle:0.9.0'
}
app的build.gradle中:
apply plugin: 'com.didi.virtualapk.plugin'
...
...
// 插件配置信息,放在文件最下面
virtualApk {
packageId = 0x6f // 插件资源id，避免资源id冲突
targetHost='../host/app' // 宿主工程的路径
applyHostMapping = true // 插件编译时是否启用应用宿主的apply mapping
}
以上插件配置完成,剩下的就是功能编写和编译,插件的编译使用:
gradle clean assemblePlugin
或者
./gradlew clean assemblePlugin
前者要保证环境中的gradle是2.14.1版本,后者要保证项目中的gradle是2.14.1版本;
接下来我们实现一个功能模块来踩坑.
功能实践
我们假设要实现一个地图功能开发,地图SDK选择高德地图,现在需要实现的是:
- 插件地图功能的开发
- 宿主下载插件apk的能力
- 本地(或者云)服务提供下载地址
插件功能
高德地图的集成可以详见官网.值得注意的是,注册的地图SDK的key,需要填写宿主工程的SHA1和包名,填写插件工程的包名,打包编译以后的地图功能是无法无法使用的.
同时,VirtualAPk对于插件的编译都是release包,没有debug包,所以建议debug的时候也加上签名信息.
宿主下载插件的能力
我们使用rxjava+retrofit实现一个下载apk的功能,同时,为了便于观察下载进度,我们做一个下载进度的拦截和显示.
- 实现一个okhttp3的拦截器:
public class DownloadInterceptor implements Interceptor{
private DownloadListener listener;
public DownloadInterceptor(DownloadListener listener){
this.listener = listener;
}
@Override
public Response intercept(Chain chain) throws IOException {
Response originalResponse = chain.proceed(chain.request());
return originalResponse.newBuilder()
.body(new DownloadResponseBody(originalResponse.body(), listener))
.build();
}
}
- 其中
DownloadResponseBody的实现:
public class DownloadResponseBody extends ResponseBody{
private ResponseBody responseBody;
private DownloadListener listener;
private BufferedSource bufferedSource;
public DownloadResponseBody(ResponseBody responseBody,DownloadListener listener){
this.responseBody = responseBody;
this.listener = listener;
}
@Override
public MediaType contentType() {
return responseBody.contentType();
}
@Override
public long contentLength() {
return responseBody.contentLength();
}
@Override
public BufferedSource source() {
if (bufferedSource == null) {
bufferedSource = Okio.buffer(source(responseBody.source()));
}
return bufferedSource;
}
private Source source(Source source) {
return new ForwardingSource(source) {
long totalBytesRead = 0L;
@Override
public long read(Buffer sink, long byteCount) throws IOException {
long bytesRead = super.read(sink, byteCount);
totalBytesRead += bytesRead != -1 ? bytesRead : 0;
if (null != listener) {
listener.state(totalBytesRead, responseBody.contentLength(), bytesRead == -1);
}
return bytesRead;
}
};
}
}
- 下载过程中得到的信息,我们实现一个监听,并在后面实现的过程中展示出来:
public interface DownloadListener {
void state(long bytesRead,long contentLength,boolean done);
}
- 接下来实现下载:
@Streaming
@GET
Observable downloadMapPlugin(@Url String url);
}
- 加载插件最好开启一个service服务,便于以后多插件的管理和更新.
public class PluginService extends Service {
private static final String TAG = "PluginService";
private String baseUrl = "http://127.0.0.1:8889/";//换成自己的局域网IP
private String apkUrl = "xx.apk";
private File outputFile;
private String path = "";
private Retrofit retrofit;
private DownloadListener listener;
OkHttpClient client;
@Nullable
@Override
public IBinder onBind(Intent intent) {
return null;
}
@Override
public void onDestroy() {
super.onDestroy();
stopSelf();
}
@Override
public void onStart(Intent intent, int startId) {
super.onStart(intent, startId);
Logger.v("onstart");
initFile();
initListener();
initNetModel();
downloadMapPlugin();
}
private void initListener() {
listener = new DownloadListener() {
@Override
public void state(long bytesRead, long contentLength, boolean done) {
String size = getDataSize(bytesRead) + "/" + getDataSize(contentLength);
Logger.v(size);
}
};
}
private void initNetModel() {
DownloadInterceptor interceptor = new DownloadInterceptor(listener);
client = new OkHttpClient.Builder()
.retryOnConnectionFailure(true)
.addInterceptor(interceptor)
.build();
retrofit = new Retrofit.Builder()
.baseUrl(baseUrl)
.client(client)
.addCallAdapterFactory(RxJavaCallAdapterFactory.create())
.build();
}
private void initFile() {
path = Environment.getExternalStorageDirectory().getAbsolutePath() + "/xx/" + getResources().getString(R.string.app_name);
Logger.v(path);
outputFile = new File(path, "pluginMap.apk");
}
private void downloadMapPlugin() {
if (outputFile.exists()) {
outputFile.delete();
}
PluginNet pluginNet = retrofit.create(PluginNet.class);
pluginNet.downloadMapPlugin(apkUrl)
.subscribeOn(Schedulers.io())
.unsubscribeOn(Schedulers.io())
.map(new Func1() {
@Override
public InputStream call(ResponseBody responseBody) {
return responseBody.byteStream();
}
})
.observeOn(Schedulers.computation())
.doOnNext(new Action1() {
@Override
public void call(InputStream inputStream) {
writeInputStreamFile(outputFile,inputStream);
}
})
.observeOn(AndroidSchedulers.mainThread())
.subscribe(new Subscriber() {
@Override
public void onCompleted() {
initPluginAPK();
}
@Override
public void onError(Throwable e) {
e.printStackTrace();
}
@Override
public void onNext(InputStream inputStream) {
}
});
}
public void writeInputStreamFile(File file,InputStream input){
FileOutputStream outputStream = null;
if (file != null && file.exists())
file.delete();
try {
outputStream = new FileOutputStream(file);
byte[] buffer = new byte[1024 * 4];
int temp=-1;
while ((temp = input.read(buffer))!=-1){
outputStream.write(buffer,0,temp);
}
outputStream.flush();
}catch (IOException e){
e.printStackTrace();
}finally {
try {
outputStream.close();
input.close();
} catch (IOException e) {
e.printStackTrace();
}
}
}
public void initPluginAPK(){
PluginManager pluginManager = PluginManager.getInstance(this);
File apk = outputFile;
if (apk.exists()) {
try {
pluginManager.loadPlugin(apk);
} catch (Exception e) {
e.printStackTrace();
}
}else {
Toast.makeText(this, "SDcard目录未检测到插件", Toast.LENGTH_SHORT).show();
}
}
public static String getDataSize(long var0) {
DecimalFormat var2 = new DecimalFormat("###.00");
return var0 < 1024L ? var0 + "bytes" : (var0 < 1048576L ? var2.format((double) ((float) var0 / 1024.0F))
+ "KB" : (var0 < 1073741824L ? var2.format((double) ((float) var0 / 1024.0F / 1024.0F))
+ "MB" : (var0 < 0L ? var2.format((double) ((float) var0 / 1024.0F / 1024.0F / 1024.0F))
+ "GB" : "error")));
}
}
这个service中我们做了几件事情:
- 初始化下载保存路径
initFile()(需要确认已经开启了读写权限) - 实例化我们的监听
initListener(),例中将下载进度和总大小打印出来了. - 初始化网络请求
initNetModel(),实现一个okhttp实例,加入拦截器和重连. - rxjava实现下载
downloadMapPlugin(),同时,将下载完成的APk包写入存储,并且利用VirtualAPK初始化插件包initPluginAPK():
PluginManager pluginManager = PluginManager.getInstance(this);
File apk = outputFile;
if (apk.exists()) {
try {
pluginManager.loadPlugin(apk);
} catch (Exception e) {
e.printStackTrace();
}
}else {
Toast.makeText(this, "SDcard目录未检测到插件", Toast.LENGTH_SHORT).show();
}
以上,宿主下载apk能力基本实现了.只需要在需要的地方调用这个service即可
本地服务
我是利用node简单搭建的一个服务,有需要可以在github上找到.
运行及常见问题
上面实现了基本功能以后,我们要开始编译.
首先要编译宿主工程,因为编译完成后会在build文件目录中生成versions.txt文件,这也是很多人先编译插件工程会报错的一个注意点
再编译插件工程,如果顺利,会在build/outputs/plugin/下生成一个插件apk包,我们将它放在服务文件目录下,再通过宿主工程下载预加载,一切搞定!
...
当然,不会这么顺利,VirtualAPK在github上列出了常见的一些编译问题,我也列出一些我遇到过的问题和解决方案:
- java.lang.ArrayIndexOutOfBoundsException: 2
遇到这个问题，先看看宿主项目中aar包的引用方式是不是合规。如果修改以后还会出现这个报错。先把插件工程中生成的'Version.txt'删掉再编译。
AppTheme 主题色定义和宿主不一样(名称)，会出现null array的问题
- Can't find /Users/../app/build/VAHost/versions.txt, please check up your host application
宿主集成后需要先编译一遍
Cannot expand ZIP '/Users/wangzhenxing/myProjectAbout/DaliMap/app/build/intermediates/res/resources-release.ap_' as it does not exist
最好virtualAPK改回 「0.9.0」版本org.gradle.api.tasks.TaskExecutionException: Execution failed for task ':app:transformClassesAndResourcesWithProguardForRelease'
将app.gradle中的 minifyEnabled true设置为false高德地图 ：FileNotFound：ap.data
jar包里面的地图资源没有复制到宿主里面,这个问题很纠结,现在我的解决方案是在宿主中同样将jar包依赖一份.
产生这个问题的可能是因为VirtualApk做编译的时候,没有将地图jar包中的assets中的资源打包,如果有人做过VirtualAPK地图开发的,有解决方案的希望不吝指教