相關(guān)閱讀
插件化知識(shí)梳理(1) - Small 框架之如何引入應(yīng)用插件
插件化知識(shí)梳理(2) - Small 框架之如何引入公共庫(kù)插件
插件化知識(shí)梳理(3) - Small 框架之宿主分身
插件化知識(shí)梳理(4) - Small 框架之如何實(shí)現(xiàn)插件更新
插件化知識(shí)梳理(5) - Small 框架之如何不將插件打包到宿主中
插件化知識(shí)梳理(6) - Small 源碼分析之 Hook 原理
插件化知識(shí)梳理(7) - 類的動(dòng)態(tài)加載入門(mén)
插件化知識(shí)梳理(8) - 類的動(dòng)態(tài)加載源碼分析
插件化知識(shí)梳理(9) - 資源的動(dòng)態(tài)加載示例及源碼分析
插件化知識(shí)梳理(10) - Service 插件化實(shí)現(xiàn)及原理
一、前言
通過(guò)前面三節(jié)：
插件化知識(shí)梳理(1) - Small 框架之如何引入應(yīng)用插件
插件化知識(shí)梳理(2) - Small 框架之如何引入公共庫(kù)插件
插件化知識(shí)梳理(3) - Small 框架之宿主分身
相信大家已經(jīng)對(duì)Small的使用有了一個(gè)基本的認(rèn)識(shí)，今天講解另一個(gè)比較重要的知識(shí)點(diǎn)，插件更新。
二、示例
原始的工程包括兩個(gè)部分：
- 宿主模塊 -
app - 應(yīng)用插件模塊 -
app.upgrade - 原始路由文件 -
bundle.json
如果要進(jìn)行插件更新，那么我們需要：
- 新的路由文件 -
bundle.json，通過(guò)該文件，我們獲取需要更新的插件的包名以及獲取插件的路徑。 - 新的插件文件
Github地址為：SmallUpdate
2.1 準(zhǔn)備原始的工程
這里的步驟和 插件化知識(shí)梳理(1) - Small 框架之如何引入應(yīng)用插件 相同，就是新建一個(gè)宿主模塊app和一個(gè)應(yīng)用插件模塊app.upgrade，從宿主模塊中可以跳轉(zhuǎn)到應(yīng)用插件模塊的Activity，該Activity的布局如下：
<?xml version="1.0" encoding="utf-8"?>
<LinearLayout
xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:tools="http://schemas.android.com/tools"
android:layout_width="match_parent"
android:layout_height="match_parent"
tools:context="com.demo.small.update.app.upgrade.UpgradeActivity">
<TextView
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:text="Version 0!"/>
</LinearLayout>
整個(gè)工程結(jié)構(gòu)如下：
2.2 準(zhǔn)備新的插件
(1) 新的路由文件
{
"version": "1.0.0",
"bundles": [
{
"uri": "upgrade",
"pkg": "com.demo.small.update.app.upgrade"
}
],
"updates": [
{
"pkg": "com.demo.small.update.app.upgrade",
"url": "libcom_demo_small_update_app_upgrade.so"
}
]
}
這里的區(qū)別就是增加了updates字段，用于標(biāo)志需要更新的插件包名以及新插件的路徑，之后，把這個(gè)文件push到手機(jī)根目錄下的Small文件夾中。
(2) 新的插件模塊
我們修改app.upgrade的build.gradle的版本號(hào)為2.0：
android {
defaultConfig {
//....
versionCode 2
versionName "2.0"
}
}
并修改Activity的布局文件，將顯示的字符串從Version 0!改為Version 2!：
<?xml version="1.0" encoding="utf-8"?>
<LinearLayout
xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:tools="http://schemas.android.com/tools"
android:layout_width="match_parent"
android:layout_height="match_parent"
tools:context="com.demo.small.update.app.upgrade.UpgradeActivity">
<TextView
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:text="Version 2!"/> <!-- 區(qū)別，舊的插件版本為 Version 0! -->
</LinearLayout>
用于驗(yàn)證我們的插件是否更新。之后，通過(guò)命令編譯出新的插件文件so，把它push到手機(jī)根目錄下的Small文件夾中。
最終，在sdcard/Small目錄保存了以上兩部分的更新信息：
2.3 插件更新
以上準(zhǔn)備工作做好之后，就開(kāi)始真正的更新步驟了，我們把更新的操作都封裝在SmallManager中，外部只需要調(diào)用requestUpgrade()方法，就可以實(shí)現(xiàn)插件的更新：
public class SmallManager {
private static final String TAG = "SmallManager";
private static final String PATCH_PATH = Environment.getExternalStorageDirectory().toString() + "/Small/bundle.json";
private Handler mWorkerHandler;
private Handler mUiHandler;
private SmallManager() {
HandlerThread workThread = new HandlerThread("workThread");
workThread.start();
mWorkerHandler = new MHandler(workThread.getLooper());
mUiHandler = new MHandler(Looper.getMainLooper());
}
public void requestUpgrade() {
mWorkerHandler.sendEmptyMessage(MHandler.MSG_REQ_UPGRADE);
}
private void onUpgraded(boolean success) {
Log.d(TAG, "onUpgraded, success=" + success);
}
private void upgrade() {
Log.d(TAG, "upgrade");
try {
//1.獲取插件更新信息。
UpgradeInfo upgradeInfo = getUpgradeInfo();
if (upgradeInfo != null) {
if (upgradeInfo.manifest != null) {
if (!Small.updateManifest(upgradeInfo.manifest, false)) {
mUiHandler.sendMessage(mUiHandler.obtainMessage(MHandler.MSG_UPGRADE_FINISHED, false));
return;
}
}
List<UpdateInfo> updates = upgradeInfo.updates;
for (UpdateInfo update : updates) {
//2.獲得對(duì)應(yīng)包名的Bundle
Bundle bundle = Small.getBundle(update.packageName);
//3.利用更新信息來(lái)更新對(duì)應(yīng)包名的Bundle。
boolean result = upgradeBundle(bundle, update);
Log.d(TAG, "pkg=" + update.packageName + ",result=" + result);
}
mUiHandler.sendMessage(mUiHandler.obtainMessage(MHandler.MSG_UPGRADE_FINISHED, true));
return;
}
} catch (Exception e) {
e.printStackTrace();
}
mUiHandler.sendMessage(mUiHandler.obtainMessage(MHandler.MSG_UPGRADE_FINISHED, false));
}
private UpgradeInfo getUpgradeInfo() {
try {
File patchFile = new File(PATCH_PATH);
//獲得新的bundle.json，這實(shí)際情況下可以通過(guò)訪問(wèn)網(wǎng)絡(luò)進(jìn)行下載的方式實(shí)現(xiàn)，這里我們用讀取外部存儲(chǔ)的方式代替，原理是一樣的。
FileInputStream fileInputStream = new FileInputStream(patchFile);
StringBuilder sb = new StringBuilder();
byte[] buffer = new byte[1024];
int length;
while ((length = fileInputStream.read(buffer)) != -1) {
sb.append(new String(buffer, 0, length));
}
JSONObject jo = new JSONObject(sb.toString());
//manifest部分的更新。
JSONObject mf = jo.has("manifest") ? jo.getJSONObject("manifest") : null;
//每個(gè)插件部分的更新，包含了包名以及新的插件so路徑。
JSONArray updateJson = jo.getJSONArray("updates");
int N = updateJson.length();
List<UpdateInfo> updates = new ArrayList<>(N);
for (int i = 0; i < N; i++) {
JSONObject o = updateJson.getJSONObject(i);
UpdateInfo info = new UpdateInfo();
info.packageName = o.getString("pkg");
info.soPath = o.getString("url");
updates.add(info);
}
//將更新的信息封裝起來(lái)，用于下一步的更新操作。
UpgradeInfo ui = new UpgradeInfo();
ui.manifest = mf;
ui.updates = updates;
return ui;
} catch (Exception e) {
e.printStackTrace();
}
return null;
}
private boolean upgradeBundle(Bundle origin, UpdateInfo updateInfo) {
try {
//獲得Bundle的PatchFile。
File file = origin.getPatchFile();
//獲取新的so，也就是新的插件，實(shí)際情況下可以通過(guò)訪問(wèn)網(wǎng)絡(luò)進(jìn)行下載的方式實(shí)現(xiàn)，這里我們用讀取外部存儲(chǔ)的方式代替，原理是一樣的。
File updateFile = new File(Environment.getExternalStorageDirectory().toString() + "/Small/" + updateInfo.soPath);
FileInputStream updateFileInput = new FileInputStream(updateFile);
OutputStream outputStream = new FileOutputStream(file);
byte[] buffer = new byte[1024];
int length;
//將更新的插件so，寫(xiě)入到Bundle的PatchFile。
while ((length = updateFileInput.read(buffer)) != -1) {
outputStream.write(buffer, 0, length);
}
outputStream.flush();
outputStream.close();
updateFileInput.close();
//調(diào)用Bundle的upgrade方法。
origin.upgrade();
return true;
} catch (Exception e) {
e.printStackTrace();
}
return false;
}
private static class UpdateInfo {
private String packageName;
private String soPath;
}
private static class UpgradeInfo {
private JSONObject manifest;
private List<UpdateInfo> updates;
}
private class MHandler extends Handler {
private static final int MSG_REQ_UPGRADE = 0;
private static final int MSG_UPGRADE_FINISHED = 1;
public MHandler(Looper looper) {
super(looper);
}
@Override
public void handleMessage(Message msg) {
super.handleMessage(msg);
switch (msg.what) {
case MSG_REQ_UPGRADE:
upgrade();
break;
case MSG_UPGRADE_FINISHED:
onUpgraded((boolean) msg.obj);
break;
default:
break;
}
}
}
public static SmallManager getInstance() {
return Holder.INSTANCE;
}
private static class Holder {
private static SmallManager INSTANCE = new SmallManager();
}
}
通過(guò)Handler + HandlerThread的方式，保證了耗時(shí)的更新操作upgrade()在子線程當(dāng)中執(zhí)行，整個(gè)更新操作分為以下幾步，簡(jiǎn)要地解釋一下：
(1) 獲取更新信息
通過(guò)getUpgradeInfo方法，我們把所有需要更新的信息保存在UpgradeInfo結(jié)構(gòu)中，這里我們從存儲(chǔ)中讀取了前面push到手機(jī)中的bundle.json文件，通過(guò)解析其中的updates階段，得到更新的信息，也就是包名以及新插件的路徑。
這里，我們是從存儲(chǔ)中讀取的，實(shí)際情況下，我們可以將這份文件放在服務(wù)器上，然后去下載。
(2) 更新插件
在(1)中，我們已經(jīng)知道了要更新的插件的包名，現(xiàn)在，我們通過(guò)Small提供的這個(gè)方法，獲得與該包名對(duì)應(yīng)的Bundle，而upgradeBundle則進(jìn)行真正的更新操作。
Bundle bundle = Small.getBundle(update.packageName);
在第(1)步中，我們獲取到了新的插件所處的位置，然后現(xiàn)在我們通過(guò)該字段來(lái)獲取插件，之后將該插件的內(nèi)容通過(guò)輸入輸出流，寫(xiě)入到Bundle的PatchFile當(dāng)中，寫(xiě)入完畢之后，再通過(guò)Bundle的upgrade方法進(jìn)行更新。
與上面類似，這里也是從本地讀取插件，實(shí)際情況下應(yīng)當(dāng)將該插件放在服務(wù)器上，需要更新的時(shí)候再去下載。
其實(shí)一路下來(lái)，最核心的部分就是先根據(jù)包名獲取到對(duì)應(yīng)的Bundle，然后將新的插件通過(guò)文件流的形式寫(xiě)入到Bundle的PatchFile中，最終調(diào)用該Bundle的upgrade()方法，至于內(nèi)部是如何更新的，Small已經(jīng)幫我們處理好了，我們完全不需要去操心。
2.4 演示效果
更多文章，歡迎訪問(wèn)我的 Android 知識(shí)梳理系列：
- Android 知識(shí)梳理目錄：http://www.itdecent.cn/p/fd82d18994ce
- 個(gè)人主頁(yè)：http://lizejun.cn
- 個(gè)人知識(shí)總結(jié)目錄：http://lizejun.cn/categories/
