前言
在之前的开发过程中,我们一直采用的是Flutter官方推荐的方式集成到iOS原生项目中。这种方式的弊端很明显:对原生工程的侵入太大,并且每次在编译过程中都会重新生成Flutter的编译文件,在多人开发的项目中非常影响开发效率。所以现改为另一种方式集成:以编译产物的方式集成到原生项目。
目录
一、Flutter的module集成方式
- 创建一个
module
工程 - 将
Flutter
通过cocoapods
集成到项目中 - 在
Xcode
中添加Flutter Script
脚本 - 关闭
Xcode
中的bitcode
选项
二、了解Flutter编译过程
- 了解
podhelper.rb
ruby文件 - 了解
xcode_backend.sh
shell文件 - 总结
Flutter
集成过程
三、使用sh脚本收集Flutter编译产物
- 找到对应文件位置
- 编写sh脚本文件
- 为编译产物配置
podspec
文件 -
iOS
原生项目集成Flutter
产物 - 注意事项
四、参考文章
一、Flutter的module集成方式
前面已经提到我们之前采用的是Flutter官方推荐的方式集成到iOS原生项目中,所以Flutter模块是一个module
工程。即:
1、创建一个module工程
$ cd some/path/
$ flutter create -t module my_flutter
2、将Flutter通过cocoapods集成到项目中
//将以下代码添加到Podfle文件中,并执行pod install
flutter_application_path = 'path/to/my_flutter/'
load File.join(flutter_application_path, '.ios', 'Flutter', 'podhelper.rb')
3、在Xcode中添加Flutter Script脚本
"$FLUTTER_ROOT/packages/flutter_tools/bin/xcode_backend.sh" build
"$FLUTTER_ROOT/packages/flutter_tools/bin/xcode_backend.sh" embed
4、关闭Xcode中的bitcode选项
至此,Flutter已集成完成,此处不涉及代码。
二、了解Flutter编译过程
在进行Flutter编译产物收集之前,我们需要了解Flutter在编译过程中进行了哪些步骤。
1、了解podhelper.rb
ruby文件
首先Flutter在Podfile
中添加了一个podhelper.rb
的ruby文件。
podhelper.rb
文件与Podfile文件都为ruby语法。该文件主要是通过Flutter.podspec
文件将Flutter.framework
库以及FlutterPluginRegistrant
插件注册类文件导入进来,并且获取每个Plugin模块中的xx.podspec
文件将插件中的文件导入。各个插件模块以及路径均保存在module
工程中的.flutter-plugins
文件中。
执行完pod install
之后,文件目录如下
2、了解xcode_backend.sh
shell文件
xcode_backend
文件中包含三个主要的方法:BuildApp
、ThinAppFrameworks
、EmbedFlutterFrameworks
。
"$FLUTTER_ROOT/packages/flutter_tools/bin/xcode_backend.sh" build
"$FLUTTER_ROOT/packages/flutter_tools/bin/xcode_backend.sh" embed
在Xcode
中,首先传入了build参数
xcode_backend
脚本先执行BuildApp
方法,下面了解下BuildApp
主要进行了哪些操作:
方法开始进行了文件以及路径检测,确认完成后开始进行Flutter aot(Ahead Of Time)
模式编译。并将编译后的module工程/build/aot
文件夹下的App.framework
拷贝到module工程/.ios/Flutter
目录下。
接着build bundle
进行资源文件打包,存放路径在App.framework/flutter_assets
中。
BuildApp
方法执行完成后,开始执行
"$FLUTTER_ROOT/packages/flutter_tools/bin/xcode_backend.sh" embed
传入embed
参数, 执行EmbedFlutterFrameworks
方法。
该方法的主要目的是将
App.framework
和Flutter.framework
拷贝到项目的xx.app
包中的Frameworks
目录下。
ThinAppFrameworks
方式是移除不需要的framework架构。
3、总结Flutter集成过程
经过上面几个步骤,我们可以总结出Flutter集成的几个主要依赖关系:
1、Flutter
框架层主要依赖于Flutter.framework
和App.framework
两个库,Flutter.framework
是Flutter
框架的核心,App.framework
则包含的是我们的dart
源码二进制文件以及bundle
资源文件。
2、Flutter
的插件注册类FlutterPluginRegistrant
以及Plugin
模块的iOS原生插件代码。
三、使用sh脚本收集Flutter编译产物
1、找到对应文件位置
在对编译产物进行收集之前,我们需要了解Flutter
编译产物所在的目标位置。
在对Flutter
进行了build操作之后,module工程/.ios/Flutter
目录下会生成的文件如上图。我们可以找到Flutter
的两个依赖库Flutter.framework
和App.framework
。
上图是其中一个Plugin
仓库的文件目录结构,我们主要收集的内容即为Classes目录及以下的全部文件。
2、编写sh脚本文件
需要修改脚本文件中的framework_dir
文件位置
#! /bin/bash
echo "=== 正在进行编译 ==="
flutter build ios --release
framework_dir="保存编译产物的位置/build_framework"
echo "===清理文件==="
rm -rf "$framework_dir/App.framework"
rm -rf "$framework_dir/Flutter.framework"
echo "===正在拷贝 App.framework和Flutter.framework==="
cp -r "./.ios/Flutter/App.framework" $framework_dir
cp -r "./.ios/Flutter/engine/Flutter.framework" $framework_dir
echo "===拷贝资源文件==="
resourcesDestPath=${framework_dir}/resources
resourcesOriginPath=${framework_dir}/App.framework/flutter_assets
rm -rf $resourcesDestPath
mkdir -p $resourcesDestPath
cp -af $resourcesOriginPath $resourcesDestPath
echo "===拷贝注册器类:FlutterPluginRegistrant==="
regist_dir="./.ios/Flutter/FlutterPluginRegistrant/Classes/"
model_class=${framework_dir}/flutter/FlutterPluginRegistrant
mkdir -p $model_class
cp -r $regist_dir $model_class
temp_dir="${framework_dir}/temp"
mkdir -p ${temp_dir}
current_path="$PWD"
# 遍历.flutter-plugins文件
cd /Users/apple/Desktop/HealthBuddy/hb_flutter_module
cat .flutter-plugins | while read line
do
array=(${line//=/ })
plugin_name=${array[0]}
echo "===修改注册器(修正引用)==="
perl -pi -e "s|\<${plugin_name}\/|\"|g" ${model_class}/GeneratedPluginRegistrant.m
perl -pi -e "s|.h\>|.h\"|g" ${model_class}/GeneratedPluginRegistrant.m
temp_library=${temp_dir}/lib${plugin_name}.a
cd $current_path
echo "===拷贝 ${plugin_name} 文件==="
plugin=${framework_dir}/${plugin_name}
rm -rf $plugin
classes=${array[1]}ios/Classes
class=$framework_dir/Classes/flutter/${plugin_name}
rm -rf $class
mkdir -p $class
cp -af $classes $class
done
echo "===拷贝 注册器类 FlutterPluginRegistrant==="
registrantFilePath=$framework_dir/Classes/flutter
cp -r ${framework_dir}/flutter/FlutterPluginRegistrant $registrantFilePath
echo "===移除临时文件夹==="
rm -rf ${temp_dir}
将上述脚本文件放到module工程
中并执行。执行完成后,会生成如图以下产物:
3、为编译产物配置podspec
文件
flutter_module.podspec
为cocoapods
的配置文件,用于将产物集成到iOS项目中,配置如下:
Pod::Spec.new do |spec|
spec.name = "flutter_module"
spec.version = "0.0.1"
spec.summary = "A short description of flutter_module."
spec.homepage = "http://EXAMPLE/flutter_module"
spec.license = "MIT"
# spec.license = { :type => "MIT", :file => "FILE_LICENSE" }
spec.author = { "author" => "xxx@163.com" }
spec.platform = :ios
spec.platform = :ios, "8.0"
spec.source = { :git => "~/Documents/code/mycode/ManageLocalCode" }
# { :git => "http://EXAMPLE/flutter_module.git", :tag => "#{spec.version}" }
spec.source_files = "Classes", "Classes/flutter/**/*.{h,m}"
spec.resources = "resources/**"
spec.frameworks = "UIKit", "Foundation"
spec.ios.vendored_frameworks = "App.framework", "Flutter.framework"
spec.requires_arc = true
#如果插件中有依赖三方库,需要配置在这里,多个库可以添加多个spec.dependency
# spec.dependency "xxx", "~> 0.1.3"
end
4、iOS原生项目集成Flutter产物
在iOS工程中的Podfile
文件中添加以下代码:
pod 'flutter_module', :path => "编译产物路径"
上述方式是采用本地路径保存编译产物,如有需要可以上传到远程github
或者自定义云仓库。
5、注意事项
现在项目已经集成好了Flutter运行的所有编译文件以及代码文件。但是在执行过程中依然有几个需要注意的点:
① 如果是由原来官方的集成方式改为产物集成方式时,需要删除原Build Phases
中的以下脚本
"$FLUTTER_ROOT/packages/flutter_tools/bin/xcode_backend.sh" build
"$FLUTTER_ROOT/packages/flutter_tools/bin/xcode_backend.sh" embed
以及原Plugin
文件在Header Search Paths
和Other linker Flags
中的文件引用。
② 保证module工程/.ios
项目能运行成功
运行不成功的原因有可能是你的Podfile
文件中未添加Plugin
工程中的三方库依赖。只有.ios
工程中的项目能正常运行,Flutter
产物收集脚本中的flutter build ios
命令才能执行成功。
③ 每次的产物更新都需要在iOS工程中执行pod install
,更新产物文件的引用。
④ module工程
中的.ios
文件夹中的内容被误删了如何恢复?
由于在写收集Flutter产物脚本时,我不小心有删除过.ios
文件夹下的内容,在module
工程中执行以下代码可以恢复:
flutter create -i objc .