Flutter - iOS通信开发

在做Flutter开发的时候通常离不了Flutter和Native之间的通信,比如:初始化Flutter时Native向Dart传递数据,Dart调用Native的相册选择图片,Dart调用Native的模块进行一些复杂的计算,Native将一些数据(GPS信息,陀螺仪,传感器等)主动传递给Dart等。

简述:

接下来我将分场景来介绍DartNative之间的通信。

几种通信场景:

  • 初始化Flutter时Native向Dart传递数据;
  • Native发送数据给Dart;
  • Dart发送数据给Native;
  • Dart发送数据给Native,然后Native回传数据给Dart;

在讲解 FlutterNative 之间是如何传递数据之前,我们先来了解下 FlutterNative 的通信机制,FlutterNative 的通信是通过Channel来完成的。

消息使用Channel(平台通道)在客户端(UI)和主机(平台)之间传递,如下图所示:

Flutter中消息的传递是完全异步的;

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

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

  • BasicMessageChannel:用于传递字符串和半结构化的信息,持续通信收到消息后可以回复此次消息,如:Native将遍历到的文件信息陆续传递到Dart,再比如:Flutter将从服务端陆陆续获取到信息交个Native加工,Native处理完返回等;
  • MethodChannel:用于传递方法调用(method invocation)一次性通信:如Flutter调用Native拍照;
  • EventChannel: 用于数据流(event streams)的通信,持续通信收到消息后无法回复此次消息;通过长用于Native向Dart的通信,如:手机电量变化,网络连接变化,陀螺仪,传感器等;

这三种类型的类型的Channel都是全双工通信,即A <=> B,Dart可以主动发送消息给platform端,并且platform接收到消息后可以做出回应,同样,platform端可以主动发送消息给Dart端,dart端接收数后返回给platform端。

BasicMessageChannel用法

Native端:

构造方法原型

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
+ (instancetype)messageChannelWithName:(NSString*)name  binaryMessenger:(NSObject<FlutterBinaryMessenger>*)messenger  codec:(NSObject<FlutterMessageCodec>*)codec;
```

* `NSString* name` - Channel的名字,也是其唯一标识符;
* `FlutterBinaryMessenger* messenger` - 消息信使,是消息的发送与接收的工具;
* `FlutterMessageCodec codec` - 消息的编解码器,它有几种不同类型的实现:
* `BinaryCodec` - 最为简单的一种Codec,因为其返回值类型和入参的类型相同,均为二进制格式(Android中为ByteBuffer,iOS中为NSData)。实际上,BinaryCodec在编解码过程中什么都没做,只是原封不动将二进制数据消息返回而已。或许你会因此觉得BinaryCodec没有意义,但是在某些情况下它非常有用,比如使用BinaryCodec可以使传递内存数据块时在编解码阶段免于内存拷贝;
* `FlutterStringCodec` - 用于字符串与二进制数据之间的编解码,其编码格式为UTF-8
* `FlutterJSONMessageCodec` - 用于基础数据与二进制数据之间的编解码,其支持基础数据类型以及列表、字典。其在iOS端使用了NSJSONSerialization作为序列化的工具,而在Android端则使用了其自定义的JSONUtil与StringCodec作为序列化工具;
* `FlutterBinaryCodec` - 是FlutterBinaryMessenger的默认编解码器,其支持基础数据类型、二进制数据、列表、字典;


**setMessageHandler方法原型**
``` objc
- (void)setMessageHandler:(FlutterMessageHandler _Nullable)handler;

  • FlutterMessageHandler handler - 消息处理器,配合BinaryMessenger完成消息的处理;

在创建好BasicMessageChannel后,如果要让其接收Dart发来的消息,则需要调用它的setMessageHandler方法为其设置一个消息处理器。

BasicMessageChannel.MessageHandler原型

1
typedef void (^FlutterMessageHandler)(id _Nullable message, FlutterReply callback);
  • ^(NSString* message, FlutterReply reply) - 用于接受消息,message是消息内容,reply是回复此消息的回调函数;

send方法原型

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

  • id message - 要传递给Dart的具体信息;
  • FlutterReply callback - 消息发出去后,收到Dart的回复的回调函数;

在创建好BasicMessageChannel后,如果要向Dart发送消息,可以调用它的sendMessage方法向Dart传递数据。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
//用MessageChannel传递数据
- (void)initMessageChannel{
self.messageChannel = [FlutterBasicMessageChannel messageChannelWithName:@"BasicMessageChannelPlugin" binaryMessenger:self.flutterViewController codec:[FlutterStringCodec sharedInstance]];
MainViewController* __weak weakSelf = self;
//设置消息处理器,处理来自Dart的消息
[self.messageChannel setMessageHandler:^(NSString* message, FlutterReply reply) {
reply([NSString stringWithFormat:@"BasicMessageChannel收到:%@",message]);
[weakSelf sendShow:message];
}];
}
//用MessageChannel传递数据
[self.messageChannel sendMessage: mesage reply:^(id _Nullable reply) {
if (reply != nil) {
[self sendShow:reply];
}
}];

Dart端:

构造方法原型

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

  • String name - Channel的名字,要和Native端保持一致;
  • MessageCodec<T> codec - 消息的编解码器,要和Native端保持一致,有四种类型的实现具体可以参考Native端的介绍;

setMessageHandler方法原型

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
void setMessageHandler(Future<T> handler(T message))
```

* `Future<T> handler(T message)` - 消息处理器,配合`BinaryMessenger`完成消息的处理;

在创建好`BasicMessageChannel`后,如果要让其接收Native发来的消息,则需要调用它的`setMessageHandler`方法为其设置一个消息处理器。

**send方法原型**
``` dart
Future<T> send(T message)
```

* `T message` - 要传递给Native的具体信息;
* `Future<T>` - 消息发出去后,收到Native回复的回调函数;

在创建好`BasicMessageChannel`后,如果要向Native发送消息,可以调用它的`send`方法向Native传递数据。
``` dart
import 'package:flutter/services.dart';
...
static const BasicMessageChannel _basicMessageChannel =
const BasicMessageChannel('BasicMessageChannelPlugin', StringCodec());
...
//使用BasicMessageChannel接受来自Native的消息,并向Native回复
_basicMessageChannel
.setMessageHandler((String message) => Future<String>(() {
setState(() {
showMessage = message;
});
return "收到Native的消息:" + message;
}));
//使用BasicMessageChannel向Native发送消息,并接受Native的回复
String response;
try {
response = await _basicMessageChannel.send(value);
} on PlatformException catch (e) {
print(e);
}

实例源码下载

MethodChannel用法

Native端:

构造方法原型

1
2
3
4
5
6
7
//会构造一个FlutterStandardMethodCodec类型的MethodCodec
+ (instancetype)methodChannelWithName:(NSString*)name
binaryMessenger:(NSObject<FlutterBinaryMessenger>*)messenger;
//或
+ (instancetype)methodChannelWithName:(NSString*)name
binaryMessenger:(NSObject<FlutterBinaryMessenger>*)messenger
codec:(NSObject<FlutterMethodCodec>*)codec;
  • FlutterBinaryMessenger* messenger - 消息信使,是消息的发送与接收的工具;
  • NSString* name - Channel的名字,也是其唯一标识符;
  • FlutterMethodCodec codec - 用作MethodChannel的编解码器;

setMethodCallHandler方法原型

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

  • FlutterMethodCallHandler handler - 消息处理器,配合BinaryMessenger完成消息的处理;

在创建好MethodChannel后,需要调用它的setMessageHandler方法为其设置一个消息处理器,以便能加收来自Dart的消息。

FlutterMethodCallHandler原型

1
^(FlutterMethodCall * _Nonnull call, FlutterResult  _Nonnull result)

用于接受消息,call是消息内容,它有两个成员变量NSString类型的call.method表示调用的方法名,id 类型的call.arguments表示调用方法所传递的入参;FlutterResult result是回复此消息的回调函数;

1
2
3
4
5
6
7
8
9
10
- (void)initMethodChannel{
self.methodChannel = [FlutterMethodChannel methodChannelWithName:@"MethodChannelPlugin" binaryMessenger:self.flutterViewController];
MainViewController* __weak weakSelf = self;
[self.methodChannel setMethodCallHandler:^(FlutterMethodCall * _Nonnull call, FlutterResult _Nonnull result) {
if ([@"send" isEqualToString:call.method]) {
result([NSString stringWithFormat:@"MethodChannelPlugin收到:%@",call.arguments]);//返回结果给Dart);
[weakSelf sendShow:call.arguments];
}
}];
}

Dart端:

构造方法原型

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

  • String name - Channel的名字,要和Native端保持一致;
  • MethodCodec codec - 消息的编解码器,默认是StandardMethodCodec,要和Native端保持一致;

invokeMethod方法原型

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

  • String method:要调用Native的方法名;
  • [ dynamic arguments ]:调用Native方法传递的参数,可不传;
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
import 'package:flutter/services.dart';
...
static const MethodChannel _methodChannelPlugin =
const MethodChannel('MethodChannelPlugin');
...
String response;
try {
response = await _methodChannelPlugin.invokeMethod('send', value);
} on PlatformException catch (e) {
print(e);
}
...
```
[实例源码下载](https://git.imooc.com/coding-321/flutter_trip)

### EventChannel用法

#### Native端:

**构造方法原型**
``` objc
//会构造一个FlutterStandardMethodCodec类型的MethodCodec
+ (instancetype)eventChannelWithName:(NSString*)name
binaryMessenger:(NSObject<FlutterBinaryMessenger>*)messenger;
//或
+ (instancetype)eventChannelWithName:(NSString*)name
binaryMessenger:(NSObject<FlutterBinaryMessenger>*)messenger
codec:(NSObject<FlutterMethodCodec>*)codec;
  • FlutterBinaryMessenger* messenger - 消息信使,是消息的发送与接收的工具;
  • NSString* name - Channel的名字,也是其唯一标识符;
  • FlutterMethodCodec codec - 用作EventChannel的编解码器;

setStreamHandler方法原型

1
2
3
4
5
6
7
8
9
10
11
- (void)setStreamHandler:(NSObject<FlutterStreamHandler>* _Nullable)handler;
```

`FlutterStreamHandler handler` - 消息处理器,配合BinaryMessenger完成消息的处理;
在创建好EventChannel后,如果要让其接收Dart发来的消息,则需要调用它的`setStreamHandler`方法为其设置一个消息处理器。

**FlutterStreamHandler**
``` objc
@protocol FlutterStreamHandler
- (FlutterError* _Nullable)onListenWithArguments:(id _Nullable)arguments eventSink:(FlutterEventSink)eventSink;
- (FlutterError* _Nullable)onCancelWithArguments:(id _Nullable)arguments;

  • (FlutterError* _Nullable)onListenWithArguments:(id _Nullable)arguments eventSink:(FlutterEventSink)eventSink - Flutter Native监听事件时调用,Object args是传递的参数,EventChannel.EventSink eventSink是Native回调Dart时的会回调函数,eventSink提供successerrorendOfStream三个回调方法分别对应事件的不同状态;
  • (FlutterError* _Nullable)onCancelWithArguments:(id _Nullable)arguments - Flutter取消监听时调用;
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
#import <Foundation/Foundation.h>
#import "MainViewController.h"
@interface MainViewController ()<FlutterStreamHandler>
@property (nonatomic) FlutterViewController* flutterViewController;
@property (nonatomic) FlutterEventChannel* eventChannel;
@property (nonatomic) FlutterEventSink eventSink;
@end
@implementation MainViewController
#pragma mark - sendMessage
- (void)sendMessage:(NSNotification*)notification{
NSString* mesage = [notification.object valueForKey:@"message"];
//用EventChannel传递数据
if (self.eventSink != nil) {
self.eventSink(mesage);
}
}
#pragma mark - naviagor
- (void)prepareForSegue:(UIStoryboardSegue*)segue sender:(id)sender {

if ([segue.destinationViewController isKindOfClass:[FlutterViewController class]]) {
self.flutterViewController = segue.destinationViewController;
[self.flutterViewController setInitialRoute:self.inputParams];
[self initChannel];
}
}
#pragma mark - init Channel
- (void)initChannel{
[self initEventChannel];
}
- (void)initEventChannel{
self.eventChannel = [FlutterEventChannel eventChannelWithName:@"EventChannelPlugin" binaryMessenger:self.flutterViewController];

//设置消息处理器,处理来自Dart的消息
[self.eventChannel setStreamHandler:self];
}

#pragma mark - <FlutterStreamHandler>
//这个onListen是Flutter端开始监听这个channel时的回调,第二个参数 EventSink是用来传数据的载体
- (FlutterError* _Nullable)onListenWithArguments:(id _Nullable)arguments eventSink:(FlutterEventSink)eventSink {
// arguments flutter给native的参数
// 回调给flutter, 建议使用实例指向,因为该block可以使用多次
self.eventSink = eventSink;
return nil;
}

/// flutter不再接收
- (FlutterError* _Nullable)onCancelWithArguments:(id _Nullable)arguments {
// arguments flutter给native的参数
self.eventSink = nil;
return nil;
}
@end

Dart端:

构造方法原型

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

  • String name - Channel的名字,要和Native端保持一致;
  • MethodCodec codec - 消息的编解码器,默认是StandardMethodCodec,要和Native端保持一致;

receiveBroadcastStream方法原型

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
Stream<dynamic> receiveBroadcastStream([ dynamic arguments ]) 
```

* `dynamic arguments` - 监听事件时向Native传递的数据;

初始化一个广播流用于从channel中接收数据,它返回一个Stream接下来需要调用Stream的`listen`方法来完成注册,另外需要在页面销毁时调用Stream的`cancel`方法来取消监听;

``` dart
import 'package:flutter/services.dart';
...
static const EventChannel _eventChannelPlugin =
EventChannel('EventChannelPlugin');
StreamSubscription _streamSubscription;
@override
void initState() {
_streamSubscription=_eventChannelPlugin
.receiveBroadcastStream()
.listen(_onToDart, onError: _onToDartError);
super.initState();
}
@override
void dispose() {
if (_streamSubscription != null) {
_streamSubscription.cancel();
_streamSubscription = null;
}
super.dispose();
}
void _onToDart(message) {
setState(() {
showMessage = message;
});
}
void _onToDartError(error) {
print(error);
}
...

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

在Flutter的API中提供了Native在初始化Dart页面时传递数据给Dart的方式,这种传递数据的方式比下文中所讲的其他几种传递数据的方式发生的时机都早。

因为很少有资料介绍这种方式,所以可能有很多同学还不知道这种方式,不过不要紧,接下来我就向大家介绍如何使用这种方式来传递数据给Dart。

Android向Flutter传递初始化数据initialRoute

Flutter允许我们在初始化Flutter页面时向Flutter传递一个String类型的initialRoute参数,从参数名字它是用作路由名的,但是既然Flutter给我们开了这个口子,那我们是不是可以搞点事情啊,传递点我们想传的其他参数呢,比如:

1
2
3
4
5
6
7
8
9
10
11
12
13
FragmentTransaction tx = getSupportFragmentManager().beginTransaction();
tx.replace(R.id.someContainer, Flutter.createFragment("{name:'devio',dataList:['aa','bb',''cc]}"));
tx.commit();
//or
View flutterView = Flutter.createView(
MainActivity.this,
getLifecycle(),
"route1"
);
FrameLayout.LayoutParams layout = new FrameLayout.LayoutParams(600, 800);
layout.leftMargin = 100;
layout.topMargin = 200;
addContentView(flutterView, layout);

然后在Flutter module通过如下方式获取:

import 'dart:ui';//要使用window对象必须引入

String initParams=window.defaultRouteName;
//序列化成Dart obj 敢你想干的
...

通过上述方案的讲解是不是给大家分享了一个新的思路呢。
接下来,我们先来看一下如何在Android上来传递这些初始化数据。

2. Native到Dart的通信(Native发送数据给Dart)

在Flutter 中Native向Dart传递消息可以通过BasicMessageChannelEventChannel都可以实现:

通过BasicMessageChannel的方式

如何实现?

通过EventChannel的方式

如何实现?

以上就是使用不同Channel实现Native到Dart通信的原理及方式,接下来我们来看一下实现Dart到Native之间通信的原理及方式。

3. Dart到Native的通信(Dart发送数据给Native)

在Flutter 中Dart向Native传递消息可以通过BasicMessageChannelMethodChannel都可以实现:

通过BasicMessageChannel的方式

通过MethodChannel的方式