iOS 原生项目集成Flutter 之 编译产物收集

前言

在之前的开发过程中,我们一直采用的是Flutter官方推荐的方式集成到iOS原生项目中。这种方式的弊端很明显:对原生工程的侵入太大,并且每次在编译过程中都会重新生成Flutter的编译文件,在多人开发的项目中非常影响开发效率。所以现改为另一种方式集成:以编译产物的方式集成到原生项目。

目录

一、Flutter的module集成方式

  • 创建一个module工程
  • Flutter通过cocoapods集成到项目中
  • Xcode中添加Flutter Script脚本
  • 关闭Xcode中的bitcode选项

二、了解Flutter编译过程

  • 了解podhelper.rbruby文件
  • 了解xcode_backend.shshell文件
  • 总结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
Flutter Script
4、关闭Xcode中的bitcode选项
bitcode

至此,Flutter已集成完成,此处不涉及代码。

二、了解Flutter编译过程

在进行Flutter编译产物收集之前,我们需要了解Flutter在编译过程中进行了哪些步骤。

1、了解podhelper.rbruby文件

首先Flutter在Podfile中添加了一个podhelper.rb的ruby文件。

podhelper.rb

podhelper.rb文件与Podfile文件都为ruby语法。该文件主要是通过Flutter.podspec文件将Flutter.framework库以及FlutterPluginRegistrant插件注册类文件导入进来,并且获取每个Plugin模块中的xx.podspec文件将插件中的文件导入。各个插件模块以及路径均保存在module工程中的.flutter-plugins文件中。

执行完pod install之后,文件目录如下

pod文件目录

2、了解xcode_backend.shshell文件

xcode_backend文件中包含三个主要的方法:BuildAppThinAppFrameworksEmbedFlutterFrameworks

"$FLUTTER_ROOT/packages/flutter_tools/bin/xcode_backend.sh" build
"$FLUTTER_ROOT/packages/flutter_tools/bin/xcode_backend.sh" embed

Xcode中,首先传入了build参数

xcode_backend.sh

xcode_backend脚本先执行BuildApp方法,下面了解下BuildApp主要进行了哪些操作:

Flutter编译

方法开始进行了文件以及路径检测,确认完成后开始进行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方法。

EmbedFlutterFrameworks方法

该方法的主要目的是将App.frameworkFlutter.framework拷贝到项目的xx.app包中的Frameworks目录下。

ThinAppFrameworks 方式是移除不需要的framework架构。

3、总结Flutter集成过程

经过上面几个步骤,我们可以总结出Flutter集成的几个主要依赖关系:
1、Flutter框架层主要依赖于Flutter.frameworkApp.framework两个库,Flutter.frameworkFlutter框架的核心,App.framework则包含的是我们的dart源码二进制文件以及bundle资源文件。
2、Flutter的插件注册类FlutterPluginRegistrant以及Plugin模块的iOS原生插件代码。

三、使用sh脚本收集Flutter编译产物

1、找到对应文件位置

在对编译产物进行收集之前,我们需要了解Flutter编译产物所在的目标位置。

module工程目录

在对Flutter进行了build操作之后,module工程/.ios/Flutter目录下会生成的文件如上图。我们可以找到Flutter的两个依赖库Flutter.frameworkApp.framework

某个plugin目录

上图是其中一个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.podspeccocoapods的配置文件,用于将产物集成到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 PathsOther linker Flags中的文件引用。

② 保证module工程/.ios 项目能运行成功

运行不成功的原因有可能是你的Podfile文件中未添加Plugin工程中的三方库依赖。只有.ios工程中的项目能正常运行,Flutter产物收集脚本中的flutter build ios命令才能执行成功。

③ 每次的产物更新都需要在iOS工程中执行pod install,更新产物文件的引用。
module工程中的.ios文件夹中的内容被误删了如何恢复?

由于在写收集Flutter产物脚本时,我不小心有删除过.ios文件夹下的内容,在module工程中执行以下代码可以恢复:

flutter create  -i objc .

四、参考文章

如何写一个Flutter自动打包成iOS代码模块的脚本
Flutter创建工程命令

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,294评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,493评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,790评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,595评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,718评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,906评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,053评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,797评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,250评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,570评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,711评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,388评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,018评论 3 316
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,796评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,023评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,461评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,595评论 2 350