前言
记得去年9月份的时候谷歌在上海有一次开发者大会,去参加的时候关注到了flutter,随后没过多久就发布了1.0版本。18年底的时候用flutter做了个小项目,发现flutter确实挺好用的。于是尝试在公司找个小项目上马,进行混合开发试试。
方案选择
目前主流的混合开发方案有两种集成方式:
- 源码集成
也就是谷歌官方提供的方案,项目地址如下所示:https://github.com/flutter/flutter/wiki/Add-Flutter-to-existing-apps
- 产物集成
Flutter项目单独开发,开发完成后发布成aar包或者iOS的framework形式,原生项目依赖flutter输出的制品即可。具体可以参考闲鱼的文章。
两种方式各有优劣,其实产物集成更好一些,不过即使是进行产物集成,也需要弄懂源码集成的方式,因为当有很多和原生交互的功能进行开发的时候,源码集成的方式可以直接调试会方便很多。
根据目前我们的情况:
- 参与人员都要进行flutter开发
- 持续发布和构建我可以修改控制
我们现在这个项目选择了源码集成的方式。
为原生项目集成flutter
整个的集成方案是参考谷歌方法,但是有一些不一样,我是创建了一个flutter项目后,在原生的项目中使用git submodule的形式进行管理的。
- 创建flutter module project
把我们的flutter的channel切换到master(master分支下是flutter的preview版本)
创建flutter模块的项目
我这里创建一个flutter的模块项目叫flutter_module
创建成功后我们可以看一下目录结构
在flutter的模块项目中包含有一个隐藏的.android和.ios目录这个目录下是可运行的Android和iOS项目,我们的flutter代码还是在lib下编写,注意在.android和.ios目录下都有一个Flutter目录,这个是我们flutter的库项目了。也就是Android用来生成aar,iOS用来生产framework的库。如果我们用flutter create xxx 生成的纯flutter项目是没有这个Flutter目录的。把该项目使用git管理起来,稍后我们要在native项目中以子模块的形式添加进去。
初始化git仓库后我们先编辑一下项目下的.gitignore
文件,当前这个文件是把项目下的.ios
和.android
忽略掉的。这个两个项目我们需要跟踪一下,大家可以去github上找一下iOS和Android的gitignore模版文件,然后添加到这个两个目录中,然后把顶层目录的文件作出如下修改,删除.android和.ios
添加.ios/Flutter/Generated.xcconfig。
.gitignore文件:
提交你的flutter模块项目到你的git服务器(我提交到github上了,大家可以参考)
- 给iOS项目集成flutter
进入我们原生的iOS项目根目录中,为它添加一个git submodule,把我们的flutter项目拉取下来
在项目的Podfile文件中添加下面的代码,在每次执行pod install会运行podhelper.rb
打开Xcode关闭bitcode配置Build Settings->Build Options->Enable Bitcode
添加编译脚本,打开Xcode在 Build Phases中添加New Run Script Phase在里面填入如下脚本
项目的配置完成现在需要生成一些配置文件
- 进入原生项目的flutter模块目录中执行flutter packages get命令
- 回到原生项目根目录执行pod install
到此为止我们的原生项目就已经集成好了flutter项目了。
在原生项目中使用flutter,下面以swift项目为例
修改AppDelegate.swift:注意AppDelegate是集成自FlutterAppDelegate
修改Controller代码
RUN….
- iOS项目集成过程梳理
整个的集成过程其实总得来说是如下三个步骤:
- 将flutter项目放入原生项目的文件夹下
- 在podfile中添加podhelper.rb配置
- 在Xcode的build phases添加"$FLUTTER_ROOT/packages/flutter_tools/bin/xcode_backend.sh"iOS编译脚本
其中podhelper.rb文件位于我们flutter模块项目的.ios/Flutter/podhelper.rb下,大家查看它的源码可以发现,它有下面几个作用:
- 把Flutter(flutterEngine)和FlutterPluginRegistrant两个库用pod给原生项目导入进入
- 如果flutter项目有用到flutter plugin插件,把插件用pod导入
- 导入Generated.xcconfig的相关配置信息,在podhelper.rb同级别的目录下还有一个Generated.xcconfig文件,这个文件在使用flutter create xx、flutter run xxx、flutter packages get命令的时候如果该文件不存在则会生成这个文件。这个文件内容如下:
他记录了当前flutter sdk的目录位置,以及版本号,还有项目模块的目录位置。这个文件的内容在执行pod install
的时候会被写入到xcode build setting中,在执行完pod install之后,可以在原生项目根目录使用xcodebuild -showBuildSettings|grep flutter
查看相关的信息。
最后一步就是运行程序,运行程序的时候在Build phase添加了xcode_backend.sh该脚本会使用到上面pod install给xcode build setting设置的那些环境变量,然后找到项目目录生成AppFramework。
- 给原生Android项目集成Flutter
在原生Android项目中添加子模块,将上面创建的flutter module项目拉取到原生安卓项目中
在根目录的settings.gradle中添加如下配置
在原生项目的app目录下的build.gradle文件中添加Flutter库的依赖
在原生代码中集成flutter跳转到flutter页面
我使用了一个新的Activity进行跳转。具体可以参看源码
Android从原生跳到Flutter模块的黑屏问题,在网上看到很多说设置透明主题的但是没有用,后来看到一种先隐藏显示,等待渲染好第一帧后才显示flutter页面的方法。这里要注意一点要在布局中先把flutter的Container布局设置为InVisible状态,不要使用Gone,用gone的话是不显示也不渲染,用InVisible不显示但是会渲染界面占位置,等待渲染完成后再设置为Visible即可。
- flutter的版本管理
使用说明
- 在你的项目根目录中执行命令下载脚本
curl -O https://raw.githubusercontent.com/zakiso/flutterw/master/flutterw && chmod 755 flutterw - 下载好脚本后在根目录中使用
./flutterw init
该命令会收集你当前系统中的flutter版本,并将相关信息写入flutter_wrapper.properties文件中,团队中所有成员都会以该版本号做为该项目的标准版本 - 将flutterw文件和flutter_wrapper.properties文件添加到git中提交到仓库里
- 其他成员拉取代码后在项目中使用flutter命令的地方使用./flutterw代替,如果使用ide请选择home目录下对应版本的sdk包
flutterw做了什么?
- 使用flutterw的时候会获取当前目录下的flutter_wrapper.properties文件中的版本号
- 去用户的${HOME}/flutter_wrapper/{版本号}/ 目录下查找是否有该版本sdk
- 如果没有该版本sdk会下载下来,然后使用该目录下的sdk执行命令
注意事项
如果flutter版本是preview的版本是直接使用master的最新代码来管理的。大家可以查看源码很简单,根据自己的需要定制。
项目demo我已经传到github中:有遇到问题的可以参考项目源码https://github.com/zakiso
总结
我们整个项目都是使用git进行管理的,虽然每个开发者都需要安装flutter环境,但是对于小团队来说成本并不高,加上flutter_wrapper也保证了版本的一致性。iOS开发者可以在原来的iOS项目中开发flutter的项目,Android开发者可以在原android项目中开发flutter,flutter开发者也可以自己单独开发flutter项目,这种方式其实对于开发者来说也是很方便的。