有赞Flutter混编方案

林府二掌柜

文 | 张玉柱 on?电商移动一、背景目前准备试水 Flutter，但是多数 native 开发是不了解 Flutter，因此需要设计一种比较“舒服”的集成方式。二、混编方案2.1 方案考量如果直接采用 Flutter 工程结构来作为日常开发，那这部分 Native 开发也需要配置Flutter环境, 相当程度的了解 Flutter 一些技术，成本比较大；同时如果工程耦合，对于开发过程也是很难受的。基于以上两点思考，针对 Android iOS 有如下方案：2.2 Android先看下官方的集成方式：# setting.gradlesetBinding(new Binding([gradle: this]))evaluate(new File( '../managementcenter/.android/include_flutter.groovy'))# build.gradledependencies { implementation project(':flutter') ...........}这种方式使得工程强耦合，虽然便于开发调试，但是违背了第一点，大多数 native 同学都需要配置 Flutter 环境, 成本很大。2.3 iOS2.3.1 官方 iOS 混编方案简介在native项目?Podfile中通过 eval binding特性注入?podhelper.rb脚本，在?pod install/update?时执行此脚本，脚本主要处理：Pod本地依赖Flutter引擎(Flutter.framework) 与Flutter插件注册表(FlutterPluginRegistrant)Flutter插件通过?flutter packagesget指令安装后生成的?.flutter-plugins文件解析，然后Pod本地依赖所有的插件在pod install执行完的钩子?post_install中，获取当前pod target工程对象，导入?Generated.xcconfig配置，其中都为环境变量的配置，主要为后续的?xcode_backend.sh脚本执行做准备在构建阶段?BuildPhases中注入构建是需要执行的?xcode_backend.sh脚本，脚本主要完成Flutter产物的构建并将其添加到对应的native工程中去，后续会进一步介绍此脚本2.3.2 优点无缝开发，配置好后就可以只在 Flutter 工程内进行业务开发，无缝同步到 native 工程中不需要单独拆分组件，免去管理组件的版本及发布成本2.3.3 缺点非常耦合，需要修改原有 native 工程配置，需要添加特定脚本去编译 Flutter需要修改原有 pod 的 xcconfig 配置所有团队开发成员都必须要配置 Flutter 开发环境才能编译成功2.4 小结基于以上思考，同时考虑到某个 Flutter 业务模块可能会引入到不同的 App 中，同时考虑到某个业务实现方式方面的解耦(某个业务可能用 native, flutter, weex 开发)，有以下方案（中间产物库每个 Flutter 业务模块都是独立的）：Android：iOS:三、Flutter产物结构3.1 Android3.2 iOS关于编译模式了解更多可参考查看 Flutter 的编译模式。四、Flutter 产物收集4.1 Android在 Android 端集成 Flutter 较为简单，只需要获取到上文所讲的 Flutter 产物即 aar 文件。但是由于插件文件散落每次获取比较麻烦所以目前简单用脚本收集。脚本收集主要是依靠项目里 .flutter_plugins 文件，该文件会记录 flutter 项目中引用的插件名以及本地路径等，因此可以通过该路径抓取插件的 aar 文件。from shutil import copyfileimport osimport requests# 抓取文件类型BuildRelease = TrueaarType = "-release.aar" if BuildRelease else "-debug.aar"pluginFilePath = '../.flutter-plugins'# 当前项目的flutter.aarcurrentFlutterPath = '../.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) passfile_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()目前该python脚本只抓取 Release 的 aar 文件，如果需要获取 debug 的可以手动修改：BuildRelease = False执行抓取脚本 ./flutter_aar.sh#!/usr/bin/env bashcd ..cd .androidecho "start clean"./gradlew cleanecho "start assembleRelease"./gradlew assembleReleasecd ..cd android-buildecho "clean old aar file"rm -rf aarsecho "start copy aar file"# 只抓取releasepython flutter_aar.pyecho "copy aar file finish"脚本执行完 Flutter 产物 aar 文件统一生成在根目录下 android-build 文件夹中。4.2 iOS通过查看 Flutter 编译脚本 xcode_backend.sh 和测试单独引入编译产物，发现其实 只要拥有Flutter的编译产物，宿主项目就可以接入Flutter的功能。4.2.1 脚本简单分析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 "{}" ; fidebug 模式下 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" -)"非 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}资源文件等打包 ->?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}4.2.2 方案分析设计插件统一编译成.a库，添加对应头文件App.framework 及 engine/Flutter.framework 添加目前初期 demo 将上述生成的产物统一放入到私有库当中，然后 native 宿主工程 pod 依赖此库，只需要在使用 Flutter 代码的地方 import 对应的头文件即可正常使用脚本编写 echo "==b清理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