為什么Virtual APK
早在去年就已經(jīng)想要做一些插件化開發(fā)的嘗試,或者準確點說,想做功能插件化及熱修復的實踐;
在7,8月的時候正好看見VirtualAPk開源的相關信息,比較了以后選擇Virtual APk,下面這張圖可能會比較清晰:
如果想要對github上VirtualAPk的demo嘗試,這篇文章VirtualAPK插件框架介紹（一）----框架接入推薦一讀.
配置
我認為還是有必要再再再寫一遍配置流程,現(xiàn)有的VirtualAPk版本是0.9.1,但是推薦使用0.9.0的版本.畢竟現(xiàn)在還不算是正式版本,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'
}
做了混淆的添加混淆規(guī)則:
-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();
}
以上宿主的初始化部分基本完成,如果想要加載已經(jīng)下載的插件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
前者要保證環(huán)境中的gradle是2.14.1版本,后者要保證項目中的gradle是2.14.1版本;
接下來我們實現(xiàn)一個功能模塊來踩坑.
功能實踐
我們假設要實現(xiàn)一個地圖功能開發(fā),地圖SDK選擇高德地圖,現(xiàn)在需要實現(xiàn)的是:
- 插件地圖功能的開發(fā)
- 宿主下載插件apk的能力
- 本地(或者云)服務提供下載地址
插件功能
高德地圖的集成可以詳見官網(wǎng).值得注意的是,注冊的地圖SDK的key,需要填寫宿主工程的SHA1和包名,填寫插件工程的包名,打包編譯以后的地圖功能是無法無法使用的.
同時,VirtualAPk對于插件的編譯都是release包,沒有debug包,所以建議debug的時候也加上簽名信息.
宿主下載插件的能力
我們使用rxjava+retrofit實現(xiàn)一個下載apk的功能,同時,為了便于觀察下載進度,我們做一個下載進度的攔截和顯示.
- 實現(xiàn)一個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的實現(xiàn):
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;
}
};
}
}
- 下載過程中得到的信息,我們實現(xiàn)一個監(jiān)聽,并在后面實現(xiàn)的過程中展示出來:
public interface DownloadListener {
void state(long bytesRead,long contentLength,boolean done);
}
- 接下來實現(xiàn)下載:
@Streaming
@GET
Observable<ResponseBody> 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/";//換成自己的局域網(wǎng)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<ResponseBody, InputStream>() {
@Override
public InputStream call(ResponseBody responseBody) {
return responseBody.byteStream();
}
})
.observeOn(Schedulers.computation())
.doOnNext(new Action1<InputStream>() {
@Override
public void call(InputStream inputStream) {
writeInputStreamFile(outputFile,inputStream);
}
})
.observeOn(AndroidSchedulers.mainThread())
.subscribe(new Subscriber<InputStream>() {
@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()(需要確認已經(jīng)開啟了讀寫權限) - 實例化我們的監(jiān)聽
initListener(),例中將下載進度和總大小打印出來了. - 初始化網(wǎng)絡請求
initNetModel(),實現(xiàn)一個okhttp實例,加入攔截器和重連. - rxjava實現(xiàn)下載
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能力基本實現(xiàn)了.只需要在需要的地方調(diào)用這個service即可
本地服務
我是利用node簡單搭建的一個服務,有需要可以在github上找到.
運行及常見問題
上面實現(xiàn)了基本功能以后,我們要開始編譯.
首先要編譯宿主工程,因為編譯完成后會在build文件目錄中生成versions.txt文件,這也是很多人先編譯插件工程會報錯的一個注意點
再編譯插件工程,如果順利,會在build/outputs/plugin/下生成一個插件apk包,我們將它放在服務文件目錄下,再通過宿主工程下載預加載,一切搞定!
...
當然,不會這么順利,VirtualAPK在github上列出了常見的一些編譯問題,我也列出一些我遇到過的問題和解決方案:
- java.lang.ArrayIndexOutOfBoundsException: 2
遇到這個問題，先看看宿主項目中aar包的引用方式是不是合規(guī)警没。如果修改以后還會出現(xiàn)這個報錯头镊。先把插件工程中生成的'Version.txt'刪掉再編譯胁艰。
AppTheme 主題色定義和宿主不一樣(名稱)漾岳，會出現(xiàn)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包里面的地圖資源沒有復制到宿主里面,這個問題很糾結,現(xiàn)在我的解決方案是在宿主中同樣將jar包依賴一份.
產(chǎn)生這個問題的可能是因為VirtualApk做編譯的時候,沒有將地圖jar包中的assets中的資源打包,如果有人做過VirtualAPK地圖開發(fā)的,有解決方案的希望不吝指教
