Flutter与Native通信开发指南

​欢迎关注同名公众号：小武码码码

概述

在 Flutter 开发中,经常需要在 Flutter 和 Native 之间进行通信,比如:

• 初始化 Flutter 时 Native 向 Dart 传递数据
• Dart 调用 Native 的相册选择图片
• Dart 调用 Native 的模块进行复杂计算
• Native 将GPS、陀螺仪、传感器等数据主动传给 Dart

本文将介绍 Flutter 中 Dart 和 Native 之间几种通信方式,并分析其原理和使用技巧。

Flutter 与 Native 通信机制

Flutter 和 Native 的通信是通过 Channel 来完成的。消息使用 Channel(平台通道)在客户端(UI)和宿主(平台)之间传递,完全异步。

Channel 支持的数据类型

Dart	Android	iOS
null	null	nil (NSNull when nested)
bool	java.lang.Boolean	NSNumber numberWithBool:
int	java.lang.Integer	NSNumber numberWithInt:
int, if 32 bits not enough	java.lang.Long	NSNumber numberWithLong:
double	java.lang.Double	NSNumber numberWithDouble:
String	java.lang.String	NSString
Uint8List	byte[]	FlutterStandardTypedData typedDataWithBytes:
Int32List	int[]	FlutterStandardTypedData typedDataWithInt32:
Int64List	long[]	FlutterStandardTypedData typedDataWithInt64:
Float64List	double[]	FlutterStandardTypedData typedDataWithFloat64:
List	java.util.ArrayList	NSArray
Map	java.util.HashMap	NSDictionary

Channel 类型

Flutter 定义了三种不同类型的 Channel:

• BasicMessageChannel - 用于传递字符串和半结构化的信息,如JSON。持续通信,收到消息后可以回复此消息。
• MethodChannel - 用于传递方法调用(method invocation),一次性通信。
• EventChannel - 用于数据流(event streams)的通信。持续通信,收到消息后无法回复,通常用于Native向Dart的通信,如传感器事件等。

BasicMessageChannel 用法

Native端

构造方法原型:

+ (instancetype)messageChannelWithName:(NSString*)name
                       binaryMessenger:(NSObject<FlutterBinaryMessenger>*)messenger
                                 codec:(NSObject<FlutterMessageCodec>*)codec;

关键参数:

• name - Channel 的名字,也是唯一标识符,需与 Dart 端一致。
• messenger - 消息信使,用于收发消息。
• codec - 消息的编解码器。

codec 的类型:

• BinaryCodec - 最简单的Codec,输入输出都是二进制数据,BinaryCodec在编解码过程中不做任何转换。在传递内存数据块时非常有用。
• FlutterStringCodec - 用于字符串与二进制数据间的编解码,采用 UTF-8。
• FlutterJSONMessageCodec - 用于基础数据与二进制数据间的编解码,支持列表、字典。iOS 端使用 NSJSONSerialization,Android 端使用自定义的 JSONUtil 和 StringCodec。
• FlutterBinaryCodec - FlutterBinaryMessenger 的默认编解码器,支持基础数据类型、二进制数据、列表和字典。

设置消息处理器,接收来自 Dart 的消息:

- (void)setMessageHandler:(FlutterMessageHandler _Nullable)handler;

FlutterMessageHandler 是消息处理器,配合 BinaryMessenger 完成消息处理:

typedef void (^FlutterMessageHandler)(id _Nullable message, FlutterReply callback);

• message - 接收到的消息内容
• reply - 回复消息的回调函数

发送消息给 Dart 端:

- (void)sendMessage:(id _Nullable)message;
- (void)sendMessage:(id _Nullable)message reply:(FlutterReply _Nullable)callback;

• message - 具体的消息内容
• callback - 收到 Dart 回复的回调函数

Dart 端

构造方法:

const BasicMessageChannel(this.name, this.codec);

• name - Channel 名字,需要与 Native 端保持一致
• codec - 消息的编解码器,与 Native 端保持一致

设置消息处理器:

void setMessageHandler(Future<T> handler(T message));

发送消息给 Native 端:

Future<T> send(T message);

使用示例:

//接收 Native 消息,并回复
_basicMessageChannel.setMessageHandler((String message) => Future<String>(() {
          setState(() => showMessage = message);
          return "收到Native的消息: $message";
}));

//发送消息给 Native,并处理回复
String response = await _basicMessageChannel.send(value);

MethodChannel 用法

Native 端

构造方法:

+ (instancetype)methodChannelWithName:(NSString*)name binaryMessenger:(NSObject<FlutterBinaryMessenger>*)messenger;

+ (instancetype)methodChannelWithName:(NSString*)name binaryMessenger:(NSObject<FlutterBinaryMessenger>*)messenger codec:(NSObject<FlutterMethodCodec>*)codec;

设置 MethodCallHandler,处理来自 Dart 的调用:

- (void)setMethodCallHandler:(FlutterMethodCallHandler _Nullable)handler;

FlutterMethodCallHandler 原型为:

^(FlutterMethodCall * _Nonnull call, FlutterResult  _Nonnull result)

• call - 方法调用对象,call.method 为调用的方法名, call.arguments 为传入的参数
• result - 返回结果的回调

Dart 端

构造方法:

const MethodChannel(this.name, [this.codec = const StandardMethodCodec()]);

调用 Native 端方法:

Future<T> invokeMethod<T>(String method, [ dynamic arguments ]);

• method - 要调用的 Native 方法名
• arguments - 传给 Native 的参数,可选

EventChannel 用法

Native 端

构造方法与 MethodChannel 类似。

设置 FlutterStreamHandler 处理事件流:

- (void)setStreamHandler:(NSObject<FlutterStreamHandler>* _Nullable)handler;

FlutterStreamHandler 的两个回调方法:

- (FlutterError* _Nullable)onListenWithArguments:(id _Nullable)arguments 
                                       eventSink:(FlutterEventSink)eventSink;

- (FlutterError* _Nullable)onCancelWithArguments:(id _Nullable)arguments;

• onListenWithArguments - Dart 端开始监听事件时调用,arguments 是传入参数,eventSink 是给 Dart 发送事件的回调。
• onCancelWithArguments - Dart 端取消监听时调用,arguments 是传入参数。

Dart 端

构造方法:

const EventChannel(this.name, [this.codec = const StandardMethodCodec()]);

监听 Native 事件:

Stream<dynamic> receiveBroadcastStream([ dynamic arguments ]);

• 返回一个 Stream 对象,可以注册监听。
• arguments 是向 Native 传递的参数。

使用示例:

//开始监听
_streamSubscription = _eventChannelPlugin
        .receiveBroadcastStream()
        .listen(_onToDart, onError: _onToDartError);

//取消监听
_streamSubscription.cancel();

几种通信场景

1. 初始化 Flutter 时 Native 向 Dart 传递数据

这是最早的数据传递时机。在 Android 平台,可以通过向 FlutterView 传入 initialRoute 参数实现。尽管该参数看起来是用作路由名,但实际上可以传入任意字符串。

然后在 Dart 中通过如下方式获取:

import 'dart:ui';
String initParams = window.defaultRouteName;
//然后可以反序列化参数,恢复数据

2. Native 主动发送数据给 Dart

可以通过 BasicMessageChannel 或 EventChannel 实现。

3. Dart 主动发送数据给 Native

可以通过 BasicMessageChannel 或 MethodChannel 实现。关于原生模块的实现,可以参考 Flutter 官方文档。

总结

本文全面介绍了 Flutter 和 Native 之间通信的原理和使用方法。通过灵活运用不同类型的 Channel,可以实现各种通信场景。深入理解 Channel 机制,是开发高质量 Flutter 混合应用的基础。

后续还可以进一步探讨如何使用 MethodChannel 封装 Native 模块,以及 Plugin 机制的原理等高级话题。欢迎大家交流讨论。

参考链接:

• 官方文档: Platform channel
• 深入理解Flutter Platform Channel