一种动态更新Flutter产物的方式实践（Android版）
2021-04-13 本文已影响0人
左手木亽
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.json、AssetManifest.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.png
相比来讲加入这个动态下发可以给apk减少不小的包大小。
这里总结一下：
- 由于在libflutter.so 以及 libapp.so还未下载成功之前，直接进入Flutter初始化流程会报错，我们需要额外增加逻辑只有等它们下载成功后再进行初始化。
- 像libflutter.so一般来讲只有版本升级才会更新不需要每次更新一起下载，所以可以独立一个下载包分开下载 相对来个讲每次更新下载会更快点。
