一、前言
通過前面三節：
外掛化知識梳理(1) - Small 框架之如何引入應用外掛 外掛化知識梳理(2) - Small 框架之如何引入公共庫外掛 外掛化知識梳理(3) - Small 框架之宿主分身
相信大家已經對Small的使用有了一個基本的認識，今天講解另一個比較重要的知識點，外掛更新。
二、示例
原始的工程包括兩個部分：
- 宿主模組 -
app - 應用外掛模組 -
app.upgrade - 原始路由檔案 -
bundle.json
如果要進行外掛更新，那麼我們需要：
- 新的路由檔案 -
bundle.json，通過該檔案，我們獲取需要更新的外掛的包名以及獲取外掛的路徑。 - 新的外掛檔案
Github地址為：SmallUpdate
2.1 準備原始的工程
這裡的步驟和 外掛化知識梳理(1) - Small 框架之如何引入應用外掛 相同，就是新建一個宿主模組app和一個應用外掛模組app.upgrade，從宿主模組中可以跳轉到應用外掛模組的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>
複製程式碼整個工程結構如下：
2.2 準備新的外掛
(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"
}
]
}
複製程式碼這裡的區別就是增加了updates欄位，用於標誌需要更新的外掛包名以及新外掛的路徑，之後，把這個檔案push到手機根目錄下的Small資料夾中。
(2) 新的外掛模組
我們修改app.upgrade的build.gradle的版本號為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!"/> <!-- 區別，舊的外掛版本為 Version 0! -->
</LinearLayout>
複製程式碼用於驗證我們的外掛是否更新。之後，通過命令編譯出新的外掛檔案so，把它push到手機根目錄下的Small資料夾中。
最終，在sdcard/Small目錄儲存了以上兩部分的更新資訊：
2.3 外掛更新
以上準備工作做好之後，就開始真正的更新步驟了，我們把更新的操作都封裝在SmallManager中，外部只需要呼叫requestUpgrade()方法，就可以實現外掛的更新：
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.獲得對應包名的Bundle
Bundle bundle = Small.getBundle(update.packageName);
//3.利用更新資訊來更新對應包名的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，這實際情況下可以通過訪問網路進行下載的方式實現，這裡我們用讀取外部儲存的方式代替，原理是一樣的。
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;
//每個外掛部分的更新，包含了包名以及新的外掛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);
}
//將更新的資訊封裝起來，用於下一步的更新操作。
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，也就是新的外掛，實際情況下可以通過訪問網路進行下載的方式實現，這裡我們用讀取外部儲存的方式代替，原理是一樣的。
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，寫入到Bundle的PatchFile。
while ((length = updateFileInput.read(buffer)) != -1) {
outputStream.write(buffer, 0, length);
}
outputStream.flush();
outputStream.close();
updateFileInput.close();
//呼叫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();
}
}
複製程式碼通過Handler + HandlerThread的方式，保證了耗時的更新操作upgrade()在子執行緒當中執行，整個更新操作分為以下幾步，簡要地解釋一下：
(1) 獲取更新資訊
通過getUpgradeInfo方法，我們把所有需要更新的資訊儲存在UpgradeInfo結構中，這裡我們從儲存中讀取了前面push到手機中的bundle.json檔案，通過解析其中的updates階段，得到更新的資訊，也就是包名以及新外掛的路徑。
這裡，我們是從儲存中讀取的，實際情況下，我們可以將這份檔案放在伺服器上，然後去下載。
(2) 更新外掛
在(1)中，我們已經知道了要更新的外掛的包名，現在，我們通過Small提供的這個方法，獲得與該包名對應的Bundle，而upgradeBundle則進行真正的更新操作。
Bundle bundle = Small.getBundle(update.packageName);
複製程式碼在第(1)步中，我們獲取到了新的外掛所處的位置，然後現在我們通過該欄位來獲取外掛，之後將該外掛的內容通過輸入輸出流，寫入到Bundle的PatchFile當中，寫入完畢之後，再通過Bundle的upgrade方法進行更新。
與上面類似，這裡也是從本地讀取外掛，實際情況下應當將該外掛放在伺服器上，需要更新的時候再去下載。
其實一路下來，最核心的部分就是先根據包名獲取到對應的Bundle，然後將新的外掛通過檔案流的形式寫入到Bundle的PatchFile中，最終呼叫該Bundle的upgrade()方法，至於內部是如何更新的，Small已經幫我們處理好了，我們完全不需要去操心。
2.4 演示效果
更多文章，歡迎訪問我的 Android 知識梳理系列：
- Android 知識梳理目錄：www.jianshu.com/p/fd82d1899…
- 個人主頁：lizejun.cn
- 個人知識總結目錄：lizejun.cn/categories/