【Flutter 混合开发】添加 Flutter 到 iOS

柔光的暖阳◎ 2022-11-22 00:05 377阅读 0赞

![20201102223359317.png][]

> Flutter 混合开发系列 包含如下：
> 
>  *  嵌入原生View-Android
>  *  嵌入原生View-iOS
>  *  与原生通信-MethodChannel
>  *  与原生通信-BasicMessageChannel
>  *  与原生通信-EventChannel
>  *  添加 Flutter 到 Android Activity
>  *  添加 Flutter 到 Android Fragment
>  *  **添加 Flutter 到 iOS**
> 
> 每个工作日分享一篇，欢迎关注、点赞及转发。

Flutter 可以作为 frameworks 添加到 iOS 项目，iOS项目引入Flutter module需要安装Xcode，另外Flutter支持iOS8及以上。

### 创建 Flutter module ###

由于 Xcode 无法像 Android Studio 一样安装插件，因此只能通过命令创建 Flutter module，打开终端，输入如下：

cd ios 项目根目录
    flutter create --template module my_flutter

![20201102223401784.png][]

执行完毕后，Flutter module将会创建在 ios项目/my\_flutter目录下，目录结构如图：

![20201102223403236.png][]

.ios 是隐藏目录，可以单独运行Flutter module，测试此模块的功能，iOS代码添加到现有应用程序的项目或插件中，而不是添加到模块的.ios /目录中。

由于.ios /目录是自动生成的，因此请勿对其进行源代码控制。在新机器上构建模块之前，请先在my\_flutter目录中运行flutter pub get来重新生成.ios /目录，然后再使用Flutter模块构建iOS项目。

### 将Flutter模块嵌入到现有应用程序中 ###

将Flutter模块嵌入到现有iOS应用程序中有两种方式：

*  使用CocoaPods和已安装的Flutter SDK（**推荐**）。
 *  为Flutter引擎，已编译的Dart代码和所有Flutter插件创建 frameworks。手动嵌入 frameworks，并在Xcode中更新现有应用程序的构建设置。

> 应用程序无法在 Release 模式下的模拟器上运行，因为Flutter尚不支持为Dart代码提前输出x86 / x86\_64二进制（AOT）二进制文件。在模拟器或真实设备上以调试模式运行，而在真实设备上以Release模式运行。
> 
> 下面的两种方式是将 Release frameworks 添加到 iOS 应用程序，因此**编译**的时候设备不能选择模拟器，否则编译失败。

编译成功：

![20201102223404429.png][]

选择模拟器编译失败：

![20201102223404744.png][]

#### 使用CocoaPods和已安装的Flutter SDK ####

此方法需要所有的相关开发的人员安装 Flutter 环境。

假设现有应用程序和Flutter模块位于同级目录中。如果您使用其他目录结构，则可能需要调整相对路径，目录如下：

![20201102223405545.png][]

修改iOS应用程序中 **Podfile** 文件，如果没有则手动创建，内容如下：

flutter_application_path = '../my_flutter'
    load File.join(flutter_application_path, '.ios', 'Flutter', 'podhelper.rb')
    
    target 'My App' do
     install_all_flutter_pods(flutter_application_path)
    end

![20201102223406229.png][]

CocoaPods 相关请[参考官网][Link 1]。

执行 **pod install** 命令：

![2020110222340864.png][]

> 当在my\_flutter / pubspec.yaml中更改Flutter插件的依赖性或者第一次运行时，请在Flutter模块目录中运行flutter pub get来刷新podhelper.rb脚本读取的插件列表。然后，从应用程序目录再次运行pod install。
> 
> podhelper.rb脚本将插件Flutter.framework和App.framework嵌入到项目中。

用 **Xcode 打开 My App.xcworkspace**，如果已经打开则需要关闭重新打开，使用 **⌘B** 编译项目，编译成功。

#### 在Xcode中嵌入 Flutter Frameworks ####

通过命令生成必要的 Frameworks，并通过手动编辑现有的Xcode项目将它们嵌入到应用程序中。如果团队成员无法在本地安装Flutter SDK和CocoaPods，或者您不想在现有应用程序中将CocoaPods用作依赖项管理器，则可以使用此方式。每次在Flutter模块中进行代码更改时，都必须运行 **flutter build ios** 。

运行如下命令生成 Frameworks：

flutter build ios-framework --output=./Flutter/

![20201102223408879.png][]

执行完毕后在对应的目录下生成相关编译产物：

![20201102223409330.png][]

frameworks 已经生成，将 frameworks 链接到 iOS 应用程序有很多中方法，下面介绍一种， 打开 Xcode，

将 **App.framework** 和 **Flutter.framework** 拖入**Build Settings > Build Phases > Link Binary With Libraries**： ![20201102223410564.png][]

此时在项目的左侧增加 **Frameworks** 目录：

![20201102223411504.png][]

在 **Build Settings -> Search Paths -> Framework Search Paths** 中添加 **$\{PODS\_ROOT\}/../my\_flutter/Flutter/Release**

![20201102223412508.png][]

使用 **⌘B** 编译项目，编译成功。

### 创建 FlutterEngine 和 FlutterViewController ###

将 Flutter 页面嵌入 iOS 应用程序需要创建 FlutterEngine（Flutter 引擎） 和 FlutterViewController，FlutterEngine 是Dart VM和Flutter运行时的 host，FlutterViewController 附着于 FlutterEngine，作用是通信和显示 Flutter UI。

创建 FlutterEngine：

import UIKit
    import Flutter
    
    @UIApplicationMain
    class AppDelegate: FlutterAppDelegate {
      lazy var flutterEngine = FlutterEngine(name: "my flutter engine")
    
      override func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
    
        flutterEngine.run();
    
        return super.application(application, didFinishLaunchingWithOptions: launchOptions);
      }
    }

添加一个按钮，跳转到 Flutter 页面：

import UIKit
    import Flutter
    
    class ViewController: UIViewController {
    
        override func viewDidLoad() {
            super.viewDidLoad()
            let button = UIButton(type:UIButton.ButtonType.custom)
            button.addTarget(self, action: #selector(showFlutter), for: .touchUpInside)
            button.setTitle("显示 Flutter", for: UIControl.State.normal)
            button.frame = CGRect(x: 80.0, y: 210.0, width: 160.0, height: 40.0)
            button.backgroundColor = UIColor.blue
            self.view.addSubview(button)
        }
    
        @objc func showFlutter() {
          let flutterEngine = (UIApplication.shared.delegate as! AppDelegate).flutterEngine
          let flutterViewController =
              FlutterViewController(engine: flutterEngine, nibName: nil, bundle: nil)
          present(flutterViewController, animated: true, completion: nil)
        }
    
    
    }

![20201102223413452.png][]

上面的代码使用了缓存 FlutterEngine，当然这也是推荐的一种方式。

还有一种方式是是使用隐含的FlutterEngine，使用隐含的FlutterEngine会明显增加显示Flutter UI的时间，通常不建议这样做，如果很少显示 Flutter 屏幕，没有好的方法来确定何时启动Dart VM以及何时Flutter不需要在视图控制器之间保持状态，则这可能很有用。

func showFlutter() {
      let flutterViewController = FlutterViewController(project: nil, nibName: nil, bundle: nil)
      present(flutterViewController, animated: true, completion: nil)
    }

### 指定入口点 ###

默认情况下 FlutterEngine 加载 **lib/main.dart 文件中的 main() 方法**，也可以指定其他文件的方法：

flutterEngine.run(withEntrypoint: "newEntrypoint", libraryURI: "main.dart")

### 初始化路由 ###

从Flutter 1.22版开始，可以指定路由

let flutterEngine = FlutterEngine()
    flutterEngine.run(
      withEntrypoint: FlutterDefaultDartEntrypoint, initialRoute: "/one_page")

## 交流 ##

老孟Flutter博客（330个控件用法+实战入门系列文章）：[http://laomengit.com][http_laomengit.com]

欢迎加入Flutter交流群（微信：laomengit）、关注公众号【老孟Flutter】：

[20201102223359317.png]: /images/20221120/a3564293a8b9499598d563e363a33cd5.png
[20201102223401784.png]: /images/20221120/9e94b96d6c9449089c5cebe155d0a772.png
[20201102223403236.png]: https://img-blog.csdnimg.cn/20201102223403236.png
[20201102223404429.png]: https://img-blog.csdnimg.cn/20201102223404429.png
[20201102223404744.png]: https://img-blog.csdnimg.cn/20201102223404744.png
[20201102223405545.png]: https://img-blog.csdnimg.cn/20201102223405545.png
[20201102223406229.png]: https://img-blog.csdnimg.cn/20201102223406229.png
[Link 1]: https://cocoapods.org
[2020110222340864.png]: https://img-blog.csdnimg.cn/2020110222340864.png
[20201102223408879.png]: https://img-blog.csdnimg.cn/20201102223408879.png
[20201102223409330.png]: https://img-blog.csdnimg.cn/20201102223409330.png
[20201102223410564.png]: https://img-blog.csdnimg.cn/20201102223410564.png
[20201102223411504.png]: https://img-blog.csdnimg.cn/20201102223411504.png
[20201102223412508.png]: https://img-blog.csdnimg.cn/20201102223412508.png
[20201102223413452.png]: https://img-blog.csdnimg.cn/20201102223413452.png
[http_laomengit.com]: http://laomengit.com