美文网首页
Flutter - 在iOS项目中嵌入Flutter模块

Flutter - 在iOS项目中嵌入Flutter模块

作者: 寒桥 | 来源:发表于2021-04-09 14:54 被阅读0次

    目前在已有的原生APP中嵌入Flutter页面主要有两种方案,一种是将原生工程作为Flutter工程的子工程,由Flutter进行统一管理,这种模式称为统一管理模式。一种是将Flutter工程作为原生工程的子模块,维持原有的原生工程管理方式不变,这种模式称为三端分离模式。


    图片.png

    三端代码分离模式的原理是把Flutter模块作为原生工程的子模块,从而快速地接入Flutter模块,降低原生工程的改造成本。

    原生iOS集成Flutter
    环境要求:
    Flutter支持iOS 8.0之后的版本
    CocoaPods版本要求在1.10之后

    一、创建Flutter模块

    进入原生工程目录,执行如下命令:

    cd path/
    flutter create --template module my_flutter
    

    Flutter子工程将会创建在path/my_flutter目录下,在这个目录下你可以使用flutter的所有命令进行操作,如flutter run --debug或者flutter build ios等。这个子工程包含一个单页面示例,可以单独测试该模块。
    目录结构大致如下:

    图片.png

    之后就可以在path/my_flutter/lib/编写Dart代码了
    path/my_flutter/pubspec.yaml文件中添加Flutter依赖包或者插件
    .ios目录是一个隐藏子文件夹,包含模块可以独立运行的内容,其中podhelper.rb这个脚本文件可以帮助使用CocoaPods将依赖的Framework或者嵌入的模块引入到已有原生工程中。

    注意:原生代码还在原生的结构目录中进行编写,不要写在隐藏目录.ios目录之下,如果写在该目录下有可能被Flutter重写掉。隐藏目录.ios不需要进行源码管理,该隐藏文件夹是自动生成的。在新机器中运行只需要在path/my_flutter/中执行flutter pub get就又可以自动生成了。
    shift + Commond + ,这个快捷键可以快速切换隐藏文件的显隐

    二、将Flutter模块嵌入到原生工程中

    有两种方式:
    方式一:使用Cocoapods依赖安装Flutter SDK(推荐使用)

    开放式可以使开发人员有一个本地安装的Flutter SDK版本,只需要在Xcode中构建应用程序,自动运行的脚本会嵌入Dart和插件代码。
    如果原生工程没有Podfile,先为工程添加一下。如果已有Podfile
    (1)添加如下内容到Podfile文件中:

    flutter_application_path = 'my_flutter'
    load File.join(flutter_application_path, '.ios', 'Flutter', 'podhelper.rb')
    
    图片.png

    (2)在每个Podfile 的target中嵌入Flutter

    target 'xxxx' do
      install_all_flutter_pods(flutter_application_path)
    end
    
    图片.png

    (3)运行pod install

    图片.png

    看到如下内容则嵌入完成,剩下的就是编写代码了

    podhelper.rb文件将你的插件、Flutter.framework和App.framework嵌入到你的项目中。应用程序的Debug和Release构建配置也会分别嵌入Flutter的Debug和Release构建模式下。Flutter.framework是Flutter的引擎相关bundle,App.framework是项目的编译的Dart代码。

    注意:当改变Flutter中pubspec.yaml中依赖的插件后,执行flutter pub get刷新插件列表,也会通过podhelp.rb脚本,在原生工程中需要重新执行以下pod install操作

    方式二:将Flutter引擎、编译的Dart代码和插件打包成Framework,然后引入工程
    该方式可以具体查看官方文档

    三、增加一个Flutter页面

    1、开启FlutterEngine和FlutterViewController
    FlutterEngine充当Dart VM和Flutter运行时的宿主,FlutterViewController连接到一个FlutterEngine,将UIKit输入时间传递到Flutter,并显示由FlutterEngine渲染的帧。

    FlutterEngine和FlutterViewController可能有着相同的生命周期,或者比FlutterViewController的生命周期更长。

    注意:通常建议为应用程序预热一个更长生命周期的FlutterEngine,这是因为:
    (1)当展示一个FlutterViewController的时候,第一帧出现的比较快
    (2)Flutter和Dart的状态要比FlutterViewController生命更长一些
    (3)在显示UI之前,您的应用程序和插件可以与Flutter和Dart有一些逻辑交互。

    2、创建FlutterEngine
    在APP的合适位置创建FlutterEngine,下边以APP启动在AppDelete中以暴露属性的方式进行创建:
    在AppDelegate.swift文件中

    import UIKit
    import Flutter
    // Used to connect plugins (only if you have plugins with iOS platform code).
    import FlutterPluginRegistrant
    
    @UIApplicationMain
    class AppDelegate: FlutterAppDelegate { // More on the FlutterAppDelegate.
      lazy var flutterEngine = FlutterEngine(name: "my flutter engine")
    
      override func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
        // Runs the default Dart entrypoint with a default Flutter route.
        flutterEngine.run();
        // Used to connect plugins (only if you have plugins with iOS platform code).
        GeneratedPluginRegistrant.register(with: self.flutterEngine);
        return super.application(application, didFinishLaunchingWithOptions: launchOptions);
      }
    }
    

    在事件或者调用的时候跳转至FlutterViewController,FlutterViewController使用在AppDelegate中创建的FlutterEngine实例。

    /// 按钮点击
    @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)
    }
    

    到此,已经在iOS应用中嵌入了Flutter页面,这时候当调用FlutterEngine中的run方法就能够调到Dart中的main()函数了

    3、另外一种选择,使用隐式FlutterEngine的方式创建FlutterViewController

    可以让FlutterViewController隐式的创建自己的FlutterEngine,不需要提前预热,这种方式通常并不推荐,因为按需创建FlutterEngine可能会在FlutterViewController呈现和渲染其第一帧的时候有明显的延迟。这种方式适合用在很少使用Flutter的页面或者无法确定在何时应该启动Dart VM的时候。
    要让FlutterViewController在没有现有FlutterEngine的情况下出现,忽略FlutterEngine的构造,并创建没有引擎的FlutterViewController,可以如下使用:

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

    4、使用FlutterAppDelegate

    建议使用应用的UIApplicationDelegate子类FlutterAppDelegate,但不是必需的。

    FlutterAppDelegate执行的函数如下:

    • 转发应用程序回调函数,如openURL到插件,如local_auth。
    • 转发状态栏轻按(只能在AppDelegate中检测到)来触发滚动到顶部的行为。

    如果你的应用代理不能直接使FlutterAppDelegate成为一个子类,可以让你的应用代理实现FlutterAppLifeCycleProvider协议,以确保插件接收到必要的回调。否则,依赖于这些事件的插件可能有未定义的行为。

    相关文章

      网友评论

          本文标题:Flutter - 在iOS项目中嵌入Flutter模块

          本文链接:https://www.haomeiwen.com/subject/cggikltx.html