Platform Channel工作原理
Flutter定義了三種不同類型的Channel,它們分別是
- BasicMessageChannel:用于傳遞字符串和半結構化的信息。
- MethodChannel:用于傳遞方法調用(method invocation)。
- EventChannel: 用于數據流(event streams)的通信。
三種Channel之間互相獨立,各有用途,但它們在設計上卻非常相近。每種Channel均有三個重要成員變量:
- name: String類型,代表Channel的名字,也是其唯一標識符。
- messager:BinaryMessenger類型,代表消息信使,是消息的發送與接收的工具。
- codec: MessageCodec類型或MethodCodec類型,代表消息的編解碼器。
使用方法
BasicMessageChannel
Android端:
BasicMessageChannel mBasicMessageChannel = new BasicMessageChannel(getFlutterView(), "basic_channel", StringCodec.INSTANCE);
mBasicMessageChannel.setMessageHandler(new BasicMessageChannel.MessageHandler() {
//接受消息
@Override
public void onMessage(Object o, BasicMessageChannel.Reply reply) {
Log.e("basic_channel", "接收到來自flutter的消息:"+o.toString());
reply.reply("回饋消息");
}
});
//發送消息
mBasicMessageChannel.send("向flutter發送消息");
//發送消息并接受flutter的回饋
mBasicMessageChannel.send("向flutter發送消息", new BasicMessageChannel.Reply() {
@Override
public void reply(Object o) {
}
});
Flutter端:
const basicMessageChannel = const BasicMessageChannel('basic_channel', StringCodec());
//接受并回復消息
basicMessageChannel.setMessageHandler(
(String message) => Future<String>(() {
setState(() {
this.message = message;
});
return "回復native消息";
}),
);
//發送消息
basicMessageChannel.send("來自flutter的message");
//flutter并沒有發送并接受回復消息的`send(T message, BasicMessageChannel.Reply<T> callback)`方法
MethodChannel
Android端:
MethodChannel mMethodChannel = new MethodChannel(getFlutterView(), "method_channel");
mMethodChannel.setMethodCallHandler(new MethodChannel.MethodCallHandler() {
//響應flutter端的調用
@Override
public void onMethodCall(MethodCall methodCall, MethodChannel.Result result) {
if (methodCall.method.equals("noticeNative")) {
todo()
result.success("接受成功");
}
}
});
//原生調用flutter
mMethodChannel.invokeMethod("noticeFlutter", "argument", new MethodChannel.Result() {
@Override
public void success(Object o) {
//回調成功
}
@Override
public void error(String s,String s1, Object o) {
//回調失敗
}
@Override
public void notImplemented() {
}
});
Flutter端:
const methodChannel = const MethodChannel('method_channel');
Future<Null> getMessageFromNative() async {
//flutter調原生方法
try {
//回調成功
final String result = await methodChannel.invokeMethod('noticeNative');
setState(() {
method = result;
});
} on PlatformException catch (e) {
//回調失敗
}
}
methodChannel.setMethodCallHandler(
(MethodCall methodCall) => Future<String>(() {
//響應原生的調用
if(methodCall.method == "noticeFlutter"){
setState(() {
});
}
}),
);
EventChannel
Android端:
EventChannel eventChannel = new EventChannel(getFlutterView(),"event_channel");
eventChannel.setStreamHandler(new EventChannel.StreamHandler() {
@Override
public void onListen(Object o, EventChannel.EventSink eventSink) {
eventSink.success("成功");
//eventSink.error("失敗","失敗","失敗");
}
@Override
public void onCancel(Object o) {
//取消監聽時調用
}
});
Flutter端:
const eventChannel = const EventChannel('event_channel');
eventChannel.receiveBroadcastStream().listen(_onEvent,onError:_onError);
void _onEvent(Object event) {
//返回的內容
}
void _onError(Object error) {
//返回的回調
}
其中:Object args是傳遞的參數,EventChannel.EventSink eventSink是Native回調Dart時的會回調函數,eventSink提供success、error與endOfStream三個回調方法分別對應事件的不同狀態
源碼初探
Platform Channel基本結構
首先了解一下這三種Channel的代碼:
BasicMessageChannel
class BasicMessageChannel<T> {
const BasicMessageChannel(this.name, this.codec);
final String name;
final MessageCodec<T> codec;
Future<T> send(T message) async {
return codec.decodeMessage(await BinaryMessages.send(name, codec.encodeMessage(message)));
}
void setMessageHandler(Future<T> handler(T message)) {
if (handler == null) {
BinaryMessages.setMessageHandler(name, null);
} else {
BinaryMessages.setMessageHandler(name, (ByteData message) async {
return codec.encodeMessage(await handler(codec.decodeMessage(message)));
});
}
}
void setMockMessageHandler(Future<T> handler(T message)) {
if (handler == null) {
BinaryMessages.setMockMessageHandler(name, null);
} else {
BinaryMessages.setMockMessageHandler(name, (ByteData message) async {
return codec.encodeMessage(await handler(codec.decodeMessage(message)));
});
}
}
}
MethodChannel
class MethodChannel {
const MethodChannel(this.name, [this.codec = const StandardMethodCodec()]);
final String name;
final MethodCodec codec;
void setMethodCallHandler(Future<dynamic> handler(MethodCall call)) {
BinaryMessages.setMessageHandler(
name,
handler == null ? null : (ByteData message) => _handleAsMethodCall(message, handler),
);
}
void setMockMethodCallHandler(Future<dynamic> handler(MethodCall call)) {
BinaryMessages.setMockMessageHandler(
name,
handler == null ? null : (ByteData message) => _handleAsMethodCall(message, handler),
);
}
Future<ByteData> _handleAsMethodCall(ByteData message, Future<dynamic> handler(MethodCall call)) async {
final MethodCall call = codec.decodeMethodCall(message);
try {
return codec.encodeSuccessEnvelope(await handler(call));
} on PlatformException catch (e) {
returun ...
} on MissingPluginException {
return null;
} catch (e) {
return ...
}
}
Future<T> invokeMethod<T>(String method, [dynamic arguments]) async {
assert(method != null);
final ByteData result = await BinaryMessages.send(
name,
codec.encodeMethodCall(MethodCall(method, arguments)),
);
if (result == null) {
throw MissingPluginException('No implementation found for method $method on channel $name');
}
final T typedResult = codec.decodeEnvelope(result);
return typedResult;
}
}
EventChannel
class EventChannel {
const EventChannel(this.name, [this.codec = const StandardMethodCodec()]);
final String name;
final MethodCodec codec;
Stream<dynamic> receiveBroadcastStream([dynamic arguments]) {
final MethodChannel methodChannel = MethodChannel(name, codec);
StreamController<dynamic> controller;
controller = StreamController<dynamic>.broadcast(onListen: () async {
BinaryMessages.setMessageHandler(name, (ByteData reply) async {
...
});
try {
await methodChannel.invokeMethod<void>('listen', arguments);
} catch (exception, stack) {
...
}
}, onCancel: () async {
BinaryMessages.setMessageHandler(name, null);
try {
await methodChannel.invokeMethod<void>('cancel', arguments);
} catch (exception, stack) {
...
}
});
return controller.stream;
}
}
這三種Channel都有兩個成員變量:
- name:表示Channel名字,用于區分不同Platform Channel的唯一標志,每個Channel使用唯一的name作為其唯一標志
- codec: 表示消息的編解碼器,Flutter采用了二進制字節流作為數據傳輸協議:發送方需要把數據編碼成二進制數據,接受方再把數據解碼成原始數據.而負責編解碼操作的就是Codec。 每個Channel中都使用到了
BinaryMessages
,它起到了信使的作用,負責將信息進行跨平臺的搬運,是消息發送和接受的工具。
setMessageHandler
在創建好BasicMessageChannel
后,讓其接受來自另一平臺的消息,BinaryMessenger
調用它的setMessageHandler
方法為其設置一個消息處理器,配合BinaryMessenger
完成消息的處理以及回復;
send
在創建好BasicMessageChannel
后,可以調用它的send方法向另一個平臺傳遞數據。
setMethodCallHandler
設置用于在此MethodChannel
上接收方法調用的回調
receiveBroadcastStream
設置廣播流以接收此EventChannel
上的事件
Handler
Flutter使用Handler處理Codec解碼后的消息。三種Platform Channel相對應,Flutter中也定義了三種Handler:
- MessageHandler: 用于處理字符串或者半結構化消息,定義在BasicMessageChannel中.
- MethodCallHandler: 用于處理方法調用,定義在MethodChannel中.
- StreamHandler: 用于事件流通信,定義在EventChannel中
使用Platform Channel時,需要為其注冊一個對應BinaryMessageHandler為其設置對應的Handler。二進制數據會被BinaryMessageHanler進行處理,首先使用Codec進行解碼操作,然后再分發給具體Handler進行處理。
最后
在Flutter與Native混合開發的模式下,Platform Channel的應用場景非常多,理解Platform Channel的工作原理,有助于我們在從事這方面開發時能做到得心應手。
實戰混合式開發Flutter3.0手冊
跟完MethodChannel
的源碼,會發現整個通信機制還挺簡單的,先去不去理解Codec的話,等于就是將dart的變量,傳到dart Native,然后交到java Native, 再傳到java。然后相反的路徑,再從java到dart。
然后再去看BasicMessageChannel
就是沒有MethodCall
這個結構的,其他的也是走的BinaryMessages.send
方法。然后在Android端,沒有=IncomingMethodCallHandler
這個類,直接就是BinaryMessageHandler
。所以了解了MethodChannel
,BasicMessageChannel
原理自然就懂了。
同樣的EventChannel
則是基于MethodChannel
來實現的,只是兩端的handler會有一些特殊的處理方式。