背景
目前准备试水 Flutter，但是多数native开发是不了解Flutter，因此需要设计一种比较“舒服”的集成方式。
混编方案
方案考量
- 如果直接采用 Flutter 工程结构来作为日常开发，那这部分 Native 开发也需要配置Flutter环境, 相当程度的了解 Flutter 一些技术，成本比较大。
- 同时如果工程耦合，对于开发过程也是很难受的
基于以上两点思考，针对 Android iOS 有如下方案：
Android
先看下官方的集成方式：
# setting.gradle
setBinding(new Binding([gradle: this]))
evaluate(new File(
'../managementcenter/.android/include_flutter.groovy'
))
123456# build.gradle
dependencies {
implementation project(':flutter')
...........
}
12345这种方式使得工程强耦合，虽然便于开发调试，但是违背了第一点，大多数 native 同学都需要配置 Flutter 环境, 成本很大。
iOS
官方 iOS 混编方案简介
传送门
- 在native项目Podfile中通过 eval binding特性注入 podhelper.rb脚本，在pod install/update 时执行此脚本，脚本主要处理：Pod本地依赖Flutter引擎(Flutter.framework) 与Flutter插件注册表(FlutterPluginRegistrant)Flutter插件通过flutter packages get指令安装后生成的 .flutter-plugins文件解析，然后Pod本地依赖所有的插件在pod install执行完的钩子 post_install中，获取当前pod target工程对象，导入 Generated.xcconfig配置，其中都为环境变量的配置，主要为后续的xcode_backend.sh脚本执行做准备
- 在构建阶段Build Phases中注入构建是需要执行的xcode_backend.sh脚本，脚本主要完成Flutter产物的构建并将其添加到对应的native工程中去，后续会进一步介绍此脚本
优点
- 无缝开发，配置好后就可以只在 Flutter 工程内进行业务开发，无缝同步到 native 工程中
- 不需要单独拆分组件，免去管理组件的版本及发布成本
缺点
- 非常耦合，需要修改原有 native 工程配置，需要添加特定脚本去编译 Flutter
- 需要修改原有 pod 的 xcconfig 配置
- 所有团队开发成员都必须要配置 Flutter 开发环境才能编译成功
小结
基于以上思考，同时考虑到某个 Flutter 业务模块可能会引入到不同的 App 中，同时考虑到某个业务实现方式方面的解耦(某个业务可能用 native, flutter, weex 开发)，有以下方案（中间产物库每个 Flutter 业务模块都是独立的）：
Android：
iOS:
Flutter产物结构
Android
iOS
关于编译模式了解更多可参考查看 Flutter的编译模式。
Flutter产物收集
Android
在Android 端集成Flutter较为简单，只需要获取到上文所讲的Flutter产物即aar文件。但是由于插件文件散落每次获取比较麻烦所以目前简单用脚本收集。
脚本收集主要是依靠项目里 .flutter_plugins 文件，该文件会记录flutter项目中引用的插件名以及本地路径等，因此可以通过该路径抓取插件的 aar 文件。
from shutil import copyfile
import os
import requests
# 抓取文件类型
BuildRelease = True
aarType = "-release.aar" if BuildRelease else "-debug.aar"
pluginFilePath = '../.flutter-plugins'
# 当前项目的flutter.aar
currentFlutterPath = '../.android/Flutter/build/outputs/aar/'
# 输出地址
outputFilePath = os.path.abspath('flutter_aar.py').replace("flutter_aar.py", "aars/")
endPath = 'android/build/outputs/aar/'
def collect_aar(plugins):
all_collection_success = True
if os.path.exists(outputFilePath):
print('copy aar to: ' + outputFilePath)
else:
print('target path: ' + outputFilePath + ' not exist')
os.makedirs(outputFilePath)
print('create target path: ' + outputFilePath)
for key, value in plugins.items():
aar_path = value + key + aarType
try:
copyfile(aar_path, outputFilePath + key + aarType)
print('copy flutter aar success at path: ' + aar_path)
except IOError:
all_collection_success = False
print('copy flutter aar error at path: ' + aar_path)
pass
file_object = open(pluginFilePath, 'r')
try:
plugin_map = {}
for line in file_object:
array = line.split('=')
plugin_map[array[0]] = array[1].replace('\n', '') + endPath
plugin_map['flutter'] = currentFlutterPath
collect_aar(plugin_map)
finally:
file_object.close()
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748目前该python脚本只抓取 Release 的 aar 文件，如果需要获取 debug 的可以手动修改
BuildRelease = False
1执行抓取脚本 ./flutter_aar.sh
#!/usr/bin/env bash
cd ..
cd .android
echo "start clean"
./gradlew clean
echo "start assembleRelease"
./gradlew assembleRelease
cd ..
cd android-build
echo "clean old aar file"
rm -rf aars
echo "start copy aar file"
# 只抓取release
python flutter_aar.py
echo "copy aar file finish"
12345678910111213141516171819脚本执行完 Flutter 产物 aar 文件统一生成在根目录下 android-build 文件夹中。
iOS
通过查看 Flutter 编译脚本 xcode_backend.sh 和测试单独引入编译产物，发现其实 只要拥有Flutter的编译产物，宿主项目就可以接入Flutter的功能。
脚本简单分析
- engine/Flutter.framework Flutter 核心库拷贝 -> Flutter.framework
if [[ -e "${project_path}/.ios" ]]; then
RunCommand rm -rf -- "${derived_dir}/engine"
mkdir "${derived_dir}/engine"
RunCommand cp -r -- "${flutter_podspec}" "${derived_dir}/engine"
RunCommand cp -r -- "${flutter_framework}" "${derived_dir}/engine"
RunCommand find "${derived_dir}/engine/Flutter.framework" -type f -exec chmod a-w "{}" ;
else
RunCommand rm -rf -- "${derived_dir}/Flutter.framework"
RunCommand cp -r -- "${flutter_framework}" "${derived_dir}"
RunCommand find "${derived_dir}/Flutter.framework" -type f -exec chmod a-w "{}" ;
fi
1234567891011- debug 模式下 Dart 业务代码编译(JIT) -> App.framework
RunCommand eval "$(echo "static const int Moo = 88;" | xcrun clang -x c
${arch_flags}
-dynamiclib
-Xlinker -rpath -Xlinker '@executable_path/Frameworks'
-Xlinker -rpath -Xlinker '@loader_path/Frameworks'
-install_name '@rpath/App.framework/App'
-o "${derived_dir}/App.framework/App" -)"
1234567- 非 debug 模式下 Dart 业务代码编译(AOT) -> App.framework
RunCommand "${FLUTTER_ROOT}/bin/flutter" --suppress-analytics
${verbose_flag}
build aot
--output-dir="${build_dir}/aot"
--target-platform=ios
--target="${target_path}"
--${build_mode}
--ios-arch="${archs}"
${local_engine_flag}
${track_widget_creation_flag}
12345678910- 资源文件等打包 -> flutter_assets
StreamOutput " ├─Assembling Flutter resources..."
RunCommand "${FLUTTER_ROOT}/bin/flutter" --suppress-analytics
${verbose_flag}
build bundle
--target-platform=ios
--target="${target_path}"
--${build_mode}
--depfile="${build_dir}/snapshot_blob.bin.d"
--asset-dir="${derived_dir}/App.framework/flutter_assets"
${precompilation_flag}
${local_engine_flag}
${track_widget_creation_flag}
123456789101112方案分析
设计
- 插件统一编译成.a库，添加对应头文件
- App.framework 及 engine/Flutter.framework 添加
- 目前初期 demo 将上述生成的产物统一放入到私有库当中，然后 native 宿主工程 pod 依赖此库，只需要在使用 Flutter 代码的地方 import 对应的头文件即可正常使用
脚本编写
echo "===清理flutter历史编译==="
flutter clean
echo "===重新生成plugin索引==="
flutter packages get
echo "===生成App.framework和flutter_assets==="
flutter build ios --debug
echo "===获取所有plugin并找到头文件==="
while read -r line
do
if [[ ! "$line" =~ ^// ]]; then
array=(${line//=/ })
plugin_name=${array[0]}
cd .ios/Pods
echo "生成lib${plugin_name}.a..."
/usr/bin/env xcrun xcodebuild build -configuration Release ARCHS='arm64 armv7' -target ${plugin_name} BUILD_DIR=../../build/ios -sdk iphoneos -quiet
/usr/bin/env xcrun xcodebuild build -configuration Debug ARCHS='x86_64' -target ${plugin_name} BUILD_DIR=../../build/ios -sdk iphonesimulator -quiet
echo "合并lib${plugin_name}.a..."
lipo -create "../../build/ios/Debug-iphonesimulator/${plugin_name}/lib${plugin_name}.a" "../../build/ios/Release-iphoneos/${plugin_name}/lib${plugin_name}.a" -o "../../product/lib${plugin_name}.a"
echo "复制头文件"
classes=${array[1]}ios/Classes
for header in `find "$classes" -name *.h`; do
cp -f $header "../../product/"
done
else
echo "读取文件出错"
fi
done < .flutter-plugins
echo "===生成注册入口的二进制库文件==="
for reg_enter_name in "FlutterPluginRegistrant"
do
echo "生成libFlutterPluginRegistrant.a..."
/usr/bin/env xcrun xcodebuild build -configuration Release ARCHS='arm64 armv7' -target FlutterPluginRegistrant BUILD_DIR=../../build/ios -sdk iphoneos
/usr/bin/env xcrun xcodebuild build -configuration Debug ARCHS='x86_64' -target FlutterPluginRegistrant BUILD_DIR=../../build/ios -sdk iphonesimulator
echo "合并libFlutterPluginRegistrant.a..."
lipo -create "../../build/ios/Debug-iphonesimulator/FlutterPluginRegistrant/lib$FlutterPluginRegistrant.a" "../../build/ios/Release-iphoneos/FlutterPluginRegistrant/libFlutterPluginRegistrant.a" -o "../../product/libFlutterPluginRegistrant.a"
echo "复制头文件"
classes="../Flutter/FlutterPluginRegistrant/Classes"
for header in `find "$classes" -name *.h`; do
cp -f $header "../../product/"
done
done
123456789101112131415161718192021222324252627282930313233343536373839404142434445- 后续规划脚本优化，添加自动pod库检测及上传App.framework/Flutter.framework 体积太大，放到git仓库不太友好，考虑后续上传到CDN，然后在pod安装的时候预先执行脚本把两个产物拉下来
Flutter产物上传
Android
上面产物搜集完成后，需要上传 maven 仓库，方便集成以及版本控制
apply plugin: 'youzan.maven.upload'
zanMavenUpload {
version = '0.0.2'
childGroup = "flutter-apub"
}
uploadItems {
"fluttertoast" {
targetFile = file('../../android-build/aars/fluttertoast-release.aar')
}
"image_picker" {
targetFile = file('../../android-build/aars/image_picker-release.aar')
}
............
}
123456789101112131415161718因此引用链如下：
- Android
- iOS
总结
以上比较全面的描述了有赞的 Flutter 混编方案，目前有赞已经在内部使用的App上使用 Flutter 开发了一些页面作为试点。后续会考虑在线上 App 试点，目前正在进行 Flutter 基础库的搭建，之后会专门有文章分享。
