如何在现有的iOS工程中接入Flutter

如何在现有的iOS工程中接入Flutter(详见原文

  1. 本文是参考 官方文档,加上自己的爬坑经验,总结出的,供大家参考~
  2. 关于Flutter的环境安装IDE配置,请参看Flutter中文网

开发环境

Flutter

  • Dart:v2.0.0
  • Flutter:Flutter Release Preview 2
    engine.version = 38a646e14cc25f5a56a989c6a5787bf74e0ea386
  • IDE:Android Studio

iOS

  • Objective-C/Swift:Objective-C
  • Xcode:Version 9.4.1 (9F2000)

一、创建Flutter模块

假设你有一个iOS工程,路径为 ~/Work/Projects/HybridNativeAppWithFlutter(如下图)

假设你有一个iOS工程

在该工程路径下,创建Flutter模块:

cd ~/Work/Projects
flutter create -t module flutter_module

注1: Flutter模块的创建路径 务必xxx.xcodeproj工程文件的上一级目录
例:当前工程文件路径为~/Work/Projects/HybridNativeAppWithFlutter/HybridNativeAppWithFlutter.xcodeproj
则Flutter模块的创建路径必须是~/Work/Projects/HybridNativeAppWithFlutter


注2: 当前笔者是通过 Android Studio 开发Flutter,无法直接创建iOS的Flutter模块(如下图,后续可能会支持),所以建议用官方的方式,通过如上命令来创建

Android Studio 无法直接创建iOS的Flutter模块

二、创建依赖

等待片刻后,终端会输出图左内容,工程目录下会变成图右样子:

完成flutter_module的创建

1. 在Podfile文件中添加Flutter app

Flutter framework 需要通过CocoaPods来管理依赖,假设当前项目已经使用了CocoaPods,则直接在 iOS 工程的Podfile文件中加上如下两句话:

flutter_application_path = '../flutter_module'
eval(File.read(File.join(flutter_application_path, '.ios', 'Flutter', 'podhelper.rb')), binding)

注1:如果当前项目没有使用CocoaPods,请先参考CocoaPods官网《CocoaPods安装方法》进行安装;


注2:完整的Podfile文件如下:

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '9.0'
inhibit_all_warnings!

target 'HybridNativeAppWithFlutter' do
end

flutter_application_path = '../flutter_module'
eval(File.read(File.join(flutter_application_path, '.ios', 'Flutter', 'podhelper.rb')), binding)

然后:

pod install

注: 务必确保工程所有Target的 Enable BitcodeNO(如下图)

设置工程所有Target的 `Enable Bitcode`为`NO`

2.在Xcode工程中添加Dart代码的build phase

如下图,在Xcode工程中,选择TARGET -> Build Phases -> +号 -> New Run Script Phase,然后将如下命令粘贴到文本框中,最后通过快捷键⌘B编译:

"$FLUTTER_ROOT/packages/flutter_tools/bin/xcode_backend.sh" build
在Xcode工程中添加Dart代码的build phase

注:务必保证Run ScriptTarget Dependencies phase后面

三、在iOS项目中,通过FlutterViewController跳转至Flutter页面

参考如下代码,修改你的工程文件:

AppDelegate.h/m

  • AppDelegate.h

    #import <UIKit/UIKit.h>
    #import <Flutter/Flutter.h>
    
    @interface AppDelegate : FlutterAppDelegate
    
    @end
    
  • AppDelegate.m

    #import "AppDelegate.h"
    #import <FlutterPluginRegistrant/GeneratedPluginRegistrant.h> // Only if you have Flutter Plugins
    
    @interface AppDelegate () @end
    
    @implementation AppDelegate
    
    - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
        [GeneratedPluginRegistrant registerWithRegistry:self];
        return [super application:application didFinishLaunchingWithOptions:launchOptions];
    }
    
    @end
    

ViewController.h/m

  • ViewController.h

    #import <UIKit/UIKit.h>
    
    @interface ViewController : UIViewController
    
    @end
    
    
  • ViewController.m

    #import "ViewController.h"
    #import <Flutter/Flutter.h>
    
    @interface ViewController ()
    
    @end
    
    @implementation ViewController
    
    - (void)viewDidLoad {
        [super viewDidLoad];
        self.view.backgroundColor = [UIColor lightGrayColor];
        UIButton *button = [UIButton buttonWithType:UIButtonTypeCustom];
        [button addTarget:self action:@selector(handleButtonAction)
         forControlEvents:UIControlEventTouchUpInside];
        [button setTitle:@"Press me" forState:UIControlStateNormal];
        [button setBackgroundColor:[UIColor blueColor]];
        button.frame = CGRectMake(80.0, 210.0, 160.0, 40.0);
        [self.view addSubview:button];
    }
    
    - (void)handleButtonAction {
        FlutterViewController *flutterViewController = [[FlutterViewController alloc] init];
        flutterViewController.view.backgroundColor = [UIColor cyanColor];
        [flutterViewController setInitialRoute:@"route1"];
        [self presentViewController:flutterViewController animated:YES completion:nil];
    }
    
    @end
    

此时,如果直接运行、点击按钮后,会看到控制台的报错,并且页面也没有任何内容显示:


修改你的项目代码,运行后会报错

其中,重要的两行提示:

2018-10-23 22:48:48.990075+0800 HybridNativeAppWithFlutter[37728:5932375] Failed to find assets path for "flutter_assets"
2018-10-23 22:48:49.057530+0800 HybridNativeAppWithFlutter[37728:5932574] [VERBOSE-2:engine.cc(114)] Engine run configuration was invalid.

所以,我们要把flutter_assets Flutter.framework 给加入项目中:

把 flutter_assets 加入项目中

注意:flutter_assets不能使用 Create groups 的方式添加,只能使用 Creat folder references 的方式添加进Xcode项目内,否则跳转flutter会页面渲染失败(页面空白)

使用 Creat folder references 的方式添加 flutter_assets 进Xcode项目内

至此,就已经完成了 在现有的iOS工程中接入Flutter 的所有流程~~

运行后的画面 点击按钮,跳转至Flutter页面
运行后的画面
点击按钮,跳转至Flutter页面

四、热启动/热加载 与 Dart代码调试

连接真机或是启动模拟器,可以通过如下命令连通Flutter&iOS项目,实现 热启动/热加载

cd ~/Work/Projects/flutter_module 
flutter attach

此时输入r可热加载,q退出,执行效果如下图:

热启动/热加载

五、下载代码

该示例工程下载地址:https://github.com/AndyM129/HybridNativeAppWithFlutter

【友情提示】

在拉取代码后,若直接运行iOS工程,可能会报错误

在拉取代码后,若直接运行iOS工程,可能会报如上错误。

原因:~/Work/HybridNativeAppWithFlutterDemo/flutter_module/.ios/Flutter/Generated.xcconfig路径下的相关配置中 路径错了(如下图)

相关配置中 路径错了

解决方法是:先运行下 Flutter项目,然后就可以了

六、常见问题

1. 修改了Dart代码,但iOS工程运行时未正确的同步、显示

通常,flutter模块代码做了稍大的修改(如增删的文件)后,flutter与iOS主工程的同步死后就有问题了,后者无法正确显示这些修改。

解决该问题,可以再次将 ~/Work/Projects/flutter_module/.ios/Flutter/flutter_assets目录通过拖拽的方式加入项目中(如下图),再次运行应该就好了~

将 `~/Work/Projects/flutter_module/.ios/Flutter/flutter_assets`目录通过拖拽的方式加入项目中

参考文档

后话

本文原文地址(建议浏览,会及时更新)://www.greatytc.com/p/af085d4420fd

如果你有好的 idea 或 疑问,请随时提 issue 或 request。

如果你在开发过程中遇到什么问题,或对iOS开发有着自己独到的见解,再或是你与我一样同为菜鸟,都可以关注或私信我的微博。

“Stay hungry. Stay foolish.”

共勉~

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

推荐阅读更多精彩内容