iOS与Flutter相互通信

iOS项目加入Flutter

接着上一篇继续，在原有iOS项目中加入Flutter后，就需要考虑如何通过原生跳转到flutter，如何原生与flutter进行通信。

iOS原生跳转Flutter

在ViewController控制器中，添加一个按钮--‘flutter跳转’；当点击按钮的时候，跳转进flutter页面。

在跳转的地方，声明一个FlutterViewController对象，然后通过present的方法进入flutter页面。

具体代码如下：

#import "ViewController.h"
#import <Flutter/Flutter.h>

@implementation ViewController

- (void)viewDidLoad {
    [super viewDidLoad];
    // Do any additional setup after loading the view.
}
- (IBAction)gotoFlutter:(id)sender {
    FlutterViewController *flvc = [[FlutterViewController alloc] init];
    [self presentViewController:flvc animated:true completion:nil];
}
@end

运行演示：

goto_flutter.gif

到此最简单的原生跳转flutter就完成了。

Flutter返回到原生通信

跳转到Flutter之后，如何回到iOS原生页面呢？这个就涉及到Flutter向原生项目发送消息。

Flutter向原生通信就需要用到FlutterMethodChannel来实现，通过FlutterMethodChannel来为Flutter和原生之间构建一座Flutter向原生通信的单向桥梁。

要实现通信，必须要声明一个FlutterMethodChannel：

//单项通信管道，Flutter向原生发送消息
FlutterMethodChannel *messageChannel = [FlutterMethodChannel methodChannelWithName:@"com.flutterToNative" binaryMessenger:flvc];

然后还要实现它的回调函数，才能接收到Flutter给原生发送的消息：

[messageChannel setMethodCallHandler:^(FlutterMethodCall * _Nonnull call, FlutterResult  _Nonnull result) {
        //可以在这里实现flutter发给原生要实现的方法
    }];

这里只做一种简单的，就是flutter告诉原生，要回到原生页面。

在flutter里面，利用AppBar上面的leading属性，加上一个返回功能，

声明通信渠道：

//注意这里的com.flutterToNative一定要与原生的名称相同，不然没办法通信
static const methodChannel = MethodChannel('com.flutterToNative');

当点击Flutter里面的返回按钮时，通过methodChannel来发送‘backToNative’消息。

appBar: AppBar(
        // Here we take the value from the MyHomePage object that was created by
        // the App.build method, and use it to set our appbar title.
        title: Text('iOS与Flutter交互'),
        //点击返回按钮时，触发消息
        leading: IconButton(icon: Icon(Icons.arrow_back_ios), onPressed: ()=>methodChannel.invokeMethod('backToNative')),
      ),

iOS端只需要在setMethodCallHandler方法里面监听到有消息回调来处理就行，需要注意FlutterMethodCall里面的两个属性：

/**
 * The method name.方法名称
 */
@property(readonly, nonatomic) NSString* method;

/**
 * The arguments.参数
 */
@property(readonly, nonatomic, nullable) id arguments;

需要通过解析FlutterMethodCall里面的方法名称和参数作出相应的操作：

__weak typeof(self) weakSelf = self;
    [messageChannel setMethodCallHandler:^(FlutterMethodCall * _Nonnull call, FlutterResult  _Nonnull result) {
    //通过call.method来获取方法名称
        if ([@"backToNative" isEqualToString:call.method]) {
        //dismiss掉Flutter控制器，回到原生
            [weakSelf dismissViewControllerAnimated:true completion:nil];
        }
    }];

运行代码演示：

flutter_to_native.gif

原生发送消息到Flutter

在跳转到Flutter页面的时候，需要带一点参数给Flutter，或者原生需要跳转完Flutter之后，某些数据变化的时候需要给Flutter发送消息，这个时候就需要使用到FlutterEventChannel。

FlutterEventChannel也是一个单项管道，只能实现原生向Flutter传递消息。

由于原生向Flutter有可能不止一次消息，这里就需要声明一个FlutterEventSink属性

//单项管道，有可能使用多次
@property (nonatomic, copy) FlutterEventSink eventSink;

然后声明这个FlutterEventChannel，

//单项通信管道，原生向Flutter发送消息
    FlutterEventChannel *eventChannel = [FlutterEventChannel eventChannelWithName:@"com.nativeToFlutter" binaryMessenger:flvc];
    [eventChannel setStreamHandler:self];

在使用的过程中，需要给setStreamHandler设置代理，这里将self设置为FlutterEventChannel的代理。有代理就需要实现代理方法。

#pragma --mark FlutterStreamHandler代理
- (FlutterError* _Nullable)onListenWithArguments:(id _Nullable)arguments
                                       eventSink:(FlutterEventSink)events {
    if (events) {
        self.eventSink  = events;
        self.eventSink(@"从原生传递过来的消息。。。。。。。");
    }
    return nil;
}
// 不再需要向Flutter传递消息
- (FlutterError* _Nullable)onCancelWithArguments:(id _Nullable)arguments {
    return nil;
}

在Flutter端也同样的需要声明一个EventChannel,

//注意这里的com.nativeToFlutter一定要与原生的名称相同，不然没办法通信
static const eventChannel = EventChannel('com.nativeToFlutter');

接着在initState方法里面实现监听：

@override
  void initState() {
    // TODO: implement initState
    super.initState();
    //监听接收消息
    eventChannel.receiveBroadcastStream().listen(_getData,onError: _getError);
  }
  //获得到xiaoxi
  void _getData(dynamic data) {
    //更新状态
    setState(() {
      _privateString = data.toString();
    });
  }
  //获取到错误
  void _getError(Object err) {

  }

在iOS端的完整代码如下：

- (IBAction)gotoFlutter:(id)sender {
    FlutterViewController *flvc = [[FlutterViewController alloc] init];
    //单项通信管道，Flutter向原生发送消息
    FlutterMethodChannel *messageChannel = [FlutterMethodChannel methodChannelWithName:@"com.flutterToNative" binaryMessenger:flvc];
    __weak typeof(self) weakSelf = self;
    [messageChannel setMethodCallHandler:^(FlutterMethodCall * _Nonnull call, FlutterResult  _Nonnull result) {
        if ([@"backToNative" isEqualToString:call.method]) {
            [weakSelf dismissViewControllerAnimated:true completion:nil];
        }
    }];
    
    //单项通信管道，原生向Flutter发送消息
    FlutterEventChannel *eventChannel = [FlutterEventChannel eventChannelWithName:@"com.nativeToFlutter" binaryMessenger:flvc];
    [eventChannel setStreamHandler:self];
    
    [self presentViewController:flvc animated:true completion:nil];
}
#pragma --mark FlutterStreamHandler代理
- (FlutterError* _Nullable)onListenWithArguments:(id _Nullable)arguments
                                       eventSink:(FlutterEventSink)events {
    if (events) {
        self.eventSink  = events;
        self.eventSink(@"从原生传递过来的消息。。。。。。。");
    }
    return nil;
}
// 不再需要向Flutter传递消息
- (FlutterError* _Nullable)onCancelWithArguments:(id _Nullable)arguments {
    return nil;
}

运行结果演示如下：

native_to_flutter.gif