Flutter中与原生的通信方式详解

Flutter与Native是通过Platform Channels进行通信的，Flutter中定义了三种不同的channel

image.png

• MethodChannel：用于方法的传递，允许有返回值，适用于一次通信
• BasicMessageChannel：用于传递字符串或是半结构化的消息，可持续通信
  EventChannel：用于事件流的发送，可持续通信 但是不可回复

BasicMessageChannel

iOS

channel = FlutterBasicMessageChannel(name: studyChannelName, binaryMessenger: controller.binaryMessenger)
channel.setMessageHandler { (message, reply) in
  print("===========收到了\(String(describing: message))")
}

// 发送
channel.sendMessage(["type":"4","adver":adver])

Flutter

  basicMessageChannel = BasicMessageChannel(ChannelName, StringCodec());
  basicMessageChannel.setMessageHandler((message) {
    print('消息：$message');
    return Future.value('收到了');
  });
/// 发送
String replyString =  await basicMessageChannel?.send("Flutter端！");

MethodChannel

iOS

// 注册测试插件方法
func testPlugin(message: FlutterBinaryMessenger) {
    let channel = FlutterMethodChannel(name: "IOS_method_channel", binaryMessenger: message)
    channel.setMethodCallHandler {
        (call: FlutterMethodCall, result: @escaping FlutterResult) in
        if (call.method == "one") {
            result(["result": "success", "code": 200] as [String : Any])
        }
        if (call.method == "two") {
            result(["result": "success", "code": 404] as [String : Any])
        }
    }
}

在 AppDelegate 中调用：

 let messager : FlutterBinaryMessenger = window?.rootViewController as!FlutterBinaryMessenger
testPlugin(message: messager);

Flutter

  // 调用 apple_one 方法
  Future<void> appleOne() async {
    MethodChannel _channel = const MethodChannel("IOS_method_channel");
    final result = await _channel.invokeMethod("one");
    Map map = result as LinkedHashMap<Object?, Object?>;
    print("result: ${map["result"]}");
    print("code: ${map["code"]}");
  }

  // 调用 apple_two 方法
  Future<void> appleTwo() async {
    MethodChannel _channel = const MethodChannel("IOS_method_channel");
    final result = await _channel.invokeMethod("two");
    Map map = result as LinkedHashMap<Object?, Object?>;
    print("result: ${map["result"]}");
    print("code: ${map["code"]}");
  }

EventChannel

IOS

@property (nonatomic, strong) FlutterEventChannel *eventChannel;
@property (nonatomic, strong) FlutterEventSink eventSink;
 
 self.eventChannel = [FlutterEventChannel eventChannelWithName:@"App/Event/Channel" binaryMessenger:self.flutterVC];
 [self.eventChannel setStreamHandler:self];


// 这个onListen是Flutter端开始监听这个channel时的回调，第二个参数 EventSink是用来传数据的载体。
- (FlutterError* _Nullable)onListenWithArguments:(id _Nullable)arguments
                                       eventSink:(FlutterEventSink)events {
    self.eventSink = events;
    return nil;
}
/// 不再接收
- (FlutterError* _Nullable)onCancelWithArguments:(id _Nullable)arguments {
    return nil;
}

/// 发送
NSMutableDictionary *dic = [[NSMutableDictionary alloc] init];
[dic setSafeValue:@"YES" forKey:@"logout"];
self.eventSink(dic);

Flutter

class _testPageState extends State {
  static const EventChannel eventChannel =
      const EventChannel('App/Event/Channel');//App/Event/Channel和iOS的一致
 
  @override
  void initState() {
    super.initState();
    //开始监听
    eventChannel
        .receiveBroadcastStream("init")
        .listen(_onEvent, onError: _onError);
  }
 
// 数据接收
  void _onEvent(Object value) {
    print('onEvent+$value');
  }
 
// 错误处理
  void _onError(dynamic) {}
}

底层原理

• 三种channel均有三个重要的成员
  name - channel的名称 也是channel的唯一标识
  messager - BinaryMessager，消息发送和接收的具体操作者
  codec - 信息传递过程中的编码方式 messagerCodec 和 methodCodec

• BinaryMessager

  
  Binary的分类

通信使用的格式为二进制格式，我们初始化一个channel，并向channel注册消息处理的时候 实际是生成了一个与之对应的binaryMessagerhandler，以Key（channel name）- value（binaryMessagerHandle）注册到 BinaryMessager，收到消息时，Binarymessager会根据channel找到 handler，处理消息
BinaryMessager在安卓是一个接口 具体实现是FlutterNativeView，在IOS是一个协议FlutterBinaryMesager，FlutterviewController实现了这个协议，这也是上文中使用rootviewcontroller强转后的属性binarymessager的原因

编解码器

编解码器分类

MessageCodec有多种不同的实现：

• BinaryCodec
  BinaryCodec是最为简单的一种Codec，因为其返回值类型和入参的类型相同，均为二进制格式（Android中为ByteBuffer，iOS中为NSData）。实际上，BinaryCodec在编解码过程中什么都没做，只是原封不动将二进制数据消息返回而已。使用BinaryCodec可以使传递内存数据块时在编解码阶段免于内存拷贝。
• StringCodec
  StringCodec用于字符串与二进制数据之间的编解码，其编码格式为UTF-8
• JSONMessageCodec
  JSONMessageCodec用于基础数据与二进制数据之间的编解码，其支持基础数据类型以及列表、字典。其在iOS端使用了NSJSONSerialization作为序列化的工具
• StandardMessageCodec
  StandardMessageCodec是BasicMessageChannel的默认编解码器，其支持基础数据类型、二进制数据、列表、字典

MethodCodec

与MessageCodec不同的是，MethodCodec用于MethodCall对象的编解码，一个MethodCall对象代表一次从Flutter端发起的方法调用。MethodCall有2个成员变量：String类型的method代表需要调用的方法名称，通用类型(Android中为Object，iOS中为id)的arguments代表需要调用的方法入参
由于处理的是方法调用，故相比于MessageCodec，MethodCodec多了对调用结果的处理。当方法调用成功时，使用encodeSuccessEnvelope将result编码为二进制数据，而当方法调用失败时，则使用encodeErrorEnvelope将error的code、message、detail编码为二进制数据
MethodCodec有两种实现：

• JSONMethodCodec
  JSONMethodCodec的编解码依赖于JSONMessageCodec，当其在编码MethodCall时，会先将MethodCall转化为字典{"method":method,"args":args}。其在编码调用结果时，会将其转化为一个数组，调用成功为[result]，调用失败为[code,message,detail]。再使用JSONMessageCodec将字典或数组转化为二进制数据
• StandardMethodCodec
  MethodCodec的默认实现，StandardMethodCodec的编解码依赖于StandardMessageCodec，当其编码MethodCall时，会将method和args依次使用StandardMessageCodec编码，写入二进制数据容器。其在编码方法的调用结果时，若调用成功，会先向二进制数据容器写入数值0（代表调用成功），再写入StandardMessageCodec编码后的result。而调用失败，则先向容器写入数据1（代表调用失败），再依次写入StandardMessageCodec编码后的code，message和detail。