一種動態更新Flutter產物的方式實踐(Android版)

Flutter發佈已經算有些時間了,當在一個工程中嵌入Flutter模塊的時候,很明顯就會發現給apk帶來了不少M的包大小,而這些帶來大小的除了flutter sdk引入的源碼外,還有以下這些肉眼可見的"產物"。



所以,如果這些產物能夠動態下發不僅可以減少包大小也能給自己的業務代碼熱更新的能力,有種一舉兩得的效果。
因爲:
libfutter.so:運行Flutter依賴so文件
libapp.so: 這裏就是dart代碼編譯後的產物
flutter_asserts: 這裏存放的項目中用到資源

這裏,我們直接把這些產物按自己喜歡的目錄方式整理打成一個zip包,然後上傳服務器;最後只需要在自己的工程中增加一個邏輯進行下載這個zip包即可,建議最好是下載到data/data路徑下去因爲有可能sd卡權限被關閉了。

以下的邏輯都是基於zip包下載成功後的實現方式:

動態替換so文件
要想知道如何替換so文件,還得從源碼中尋找:在flutter提供的sdk中加載libfutter.so以及libapp.so都是在FlutterLoader這個文件中處理,下面把相關的源碼摳出來解釋一下:

FlutterLoader.java
// 只截取關鍵代碼 其他的代碼省略...

//  聲明的兩個常量  看名字即可知道對應於哪個so文件
private static final String DEFAULT_AOT_SHARED_LIBRARY_NAME = "libapp.so";
private static final String DEFAULT_LIBRARY = "libflutter.so";

// 初始化libflutter.so的入口
public void startInitialization(@NonNull Context applicationContext, @NonNull Settings settings) {
    ...
    System.loadLibrary("flutter");
    ...
}

// 初始化libapp.so的入口
public void ensureInitializationComplete(@NonNull Context applicationContext, @Nullable String[] args) {
    ...
    try {
        String kernelPath = null;
        if (BuildConfig.DEBUG || BuildConfig.JIT_RELEASE) {
            ...
        } else {
            // 這裏的   aotSharedLibraryName = "libapp.so";
            shellArgs.add("--" + AOT_SHARED_LIBRARY_NAME + "=" + aotSharedLibraryName);
            // 這裏的 applicationInfo.nativeLibraryDir + File.separator + aotSharedLibraryName
            // 指的就是我們的so路徑下的/libapp.so
            shellArgs.add("--" + AOT_SHARED_LIBRARY_NAME + "=" + applicationInfo.nativeLibraryDir + File.separator + aotSharedLibraryName);
        }
        ...
        initialized = true;
    } catch (Exception e) {
        throw new RuntimeException(e);
    }
}

根據源碼我們知道要想動態替換掉對應的so文件就是在這裏入手了,然後看一眼FlutterLoader.java的聲明方式:

    public static FlutterLoader getInstance() {
        if (instance == null) {
            instance = new FlutterLoader();
        }
        return instance;
    }

原來是個單例,那麼做起來只要修改一處就好了而且源碼也不多,所以我的做法就是自定義一個類實現FlutterLoader.java

// 這裏也只寫出關鍵代碼,其他省略
public class MFlutterLoader extends FlutterLoader {
    private static final String DEFAULT_AOT_SHARED_LIBRARY_NAME = "libapp.so";
    private static final String DEFAULT_VM_SNAPSHOT_DATA = "vm_snapshot_data";

    /**
     * libapp.so文件
     */
    private File aotSharedLibraryFile;
    /**
     * libflutter.so路徑
     */
    private String flutterSoStr;

    public void setAotSharedLibrarySo(File soFile) {
        aotSharedLibraryFile = soFile;
    }

    public void setFlutterSoStr(String soPath) {
        flutterSoStr = soPath;
    }

    // 初始化libflutter.so入口修改
    public void startInitialization(@NonNull Context applicationContext, @NonNull Settings settings) {
       ...
       // 如果有傳入libflutter.so的路徑值,那麼就加載這個so文件
        if (!TextUtils.isEmpty(flutterSoStr)) {
            System.load(flutterSoStr);
        } 
        ...
    }

// 初始化libapp.so入口修改
public void ensureInitializationComplete(@NonNull Context applicationContext, @Nullable String[] args) {
        ...
        try {
            ...

            // 如果傳入的libapp.so文件存在
            // 把原先的讀取so路徑/libapp.so替換成我們傳入的路徑
            if (null != aotSharedLibraryFile
                    && aotSharedLibraryFile.exists()
                    && aotSharedLibraryFile.isFile()
                    && aotSharedLibraryFile.canRead()
                    && aotSharedLibraryFile.length() > 0) {
                shellArgs.add("--" + AOT_SHARED_LIBRARY_NAME + "=" + aotSharedLibraryFile.getName());
                shellArgs.add("--" + AOT_SHARED_LIBRARY_NAME + "=" + aotSharedLibraryFile.getAbsolutePath());
            }
        } catch (Exception e) {
            throw new RuntimeException(e);
        }

    /**
     * 將FlutterLoader替換成我們自定義的MFlutterLoader
     */
    public void hookFlutterLoaderIfNecessary() {
        try {
            if (!flutterLoaderHookedSuccess()) {
                MFlutterLoader instance = MFlutterLoader.getInstance();
                writeStaticField(FlutterLoader.class, "instance", instance);
            }
        } catch (Throwable error) {
            ...
        }
    }

    private static void writeStaticField(final Class<?> cls, final String fieldName, final Object value) throws Exception {
        final Field field = cls.getDeclaredField(fieldName);
        field.setAccessible(true);
        field.set(null, value);
    }
}

由此可見第一步替換so文件還是比較方便的,只是具體使用的時候需要注意下反射以及如果替換失敗的邏輯即可。

動態替換資源
在flutter中我們會把圖片資源放在一個images目錄下並註冊聲明完後,通常的使用方式:

AssetImage("images/icon.png")

通過查看源碼可以找到最終是走到AssetBundle類中去,最終是由它的子類比如PlatformAssetBundle進行加載,而這個AssetBundle我們可以自己指定是要系統默認的還是自己實現的,所以這裏可以通過自定義AssetBundle從而實現加載我們下載目錄下images中的相關圖片資源。

這裏把我自定義的AssetBundle貼出來:

class HotAssetBundle extends CachingAssetBundle {

  HotAssetBundle() {
    /// 這裏是自己下載成功的圖片資源路徑
    dataPath = ""
    LogUtil.d("-------------- HotAssetBundle資源存放地址 = $dataPath");
  }

  /// 路徑拼接前綴 Android = /data/data/xxx.xxx.xxx/cache
  String dataPath = "";

  @override
  Future<ByteData> load(String key) async {
    LogUtil.d("======== HotAssetBundle start load = $key");
    if (key == "AssetManifest.json") {
      LogUtil.d("======== HotAssetBundle  start AssetManifest load =====");

      /// key = AssetManifest.json
      File jsonFile = File("$dataPath/AssetManifest.json");
      Uint8List bytes = await jsonFile.readAsBytes();
      ByteData jsonByteData = bytes.buffer.asByteData();
      return jsonByteData;
    }
    if (key == "FontManifest.json") {
      LogUtil.d("======== HotAssetBundle  start FontManifest load =====");

      /// key = FontManifest.json
      File jsonFile = File("$dataPath/FontManifest.json");
      Uint8List bytes = await jsonFile.readAsBytes();
      ByteData jsonByteData = bytes.buffer.asByteData();
      return jsonByteData;
    }

    String dir = "$dataPath/";

    /// key = packages/xxx/images/icon.png
    LogUtil.d("======== HotAssetBundle  key = $key");
    File file = File("$dir$key");
    LogUtil.d("======== HotAssetBundle  file = ${file.path}");
    Uint8List bytes = await file.readAsBytes();
    ByteData byteData = bytes.buffer.asByteData();
    return byteData;
  }
}

中間主要處理就是根據傳入的key然後加載對應的文件,需要注意的是有兩個特殊的key:FontManifest.jsonAssetManifest.json,看原來主要是進行解析從而獲取對應的key-value格式的數據。

最後一步就是把這個我們自定義的AssetBundle配置使用,替換默認的PlatformAssetBundle,具體使用如下:

runApp(
      Container(
        child: DefaultAssetBundle(
          bundle: HotAssetBundle(),
          child: MaterialApp(
              ...
          )) 
      )
  );

當然工程目錄下需要配置把so文件以及flutter_assert移除掉,這樣子才能真正的減少apk大小,在自己的build.gradle進行配置:

        // 移除Flutter相關的so文件 採用動態下發
        exclude 'lib/xxxx/libapp.so'
        exclude 'lib/xxxx/libflutter.so'

        variant.mergeAssets.doLast {
            //刪除assets文件夾下的flutter_assets 採用動態下發
            delete(fileTree(dir: variant.mergeAssets.outputDir, includes: ['flutter_assets', 'flutter_assets/**']))
        }

最後
[圖片上傳失敗...(image-25e27c-1618322272840)]
相比來講加入這個動態下發可以給apk減少不小的包大小。

這裏總結一下:

  1. 由於在libflutter.so 以及 libapp.so還未下載成功之前,直接進入Flutter初始化流程會報錯,我們需要額外增加邏輯只有等它們下載成功後再進行初始化。
  2. 像libflutter.so一般來講只有版本升級纔會更新不需要每次更新一起下載,所以可以獨立一個下載包分開下載 相對來個講每次更新下載會更快點。
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章