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。
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念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

推荐阅读更多精彩内容