开发: C++知识库 Java知识库 JavaScript Python PHP知识库人工智能区块链大数据移动开发嵌入式开发工具数据结构与算法开发测试游戏开发网络协议系统运维
教程: HTML教程 CSS教程 JavaScript教程 Go语言教程 JQuery教程 VUE教程 VUE3教程 Bootstrap教程 SQL数据库教程 C语言教程 C++教程 Java教程 Python教程 Python3教程 C#教程
数码: 电脑笔记本显卡显示器固态硬盘硬盘耳机手机 iphone vivo oppo 小米华为单反装机图拉丁

-> 移动开发 -> Flutter框架分析（八）-Platform Channel -> 正文阅读

[移动开发]Flutter框架分析（八）-Platform Channel

1. 前言

由于Flutter运行于其他平台之上，其不可避免的需要和宿主平台进行通信。那其Flutter和宿主平台是如何进行通信的呢？本文将详细介绍Flutter和宿主平台的通信方式，并从源码的角度剖析通信原理。

2. 架构概述

Flutter是通过Platform Channel同宿主平台进行通信的。其消息通道结构示意图如下：

为了保证界面能够响应及时，消息的传递是异步的。
Flutter定义了三种不同类型的Platform?Channel，它们分别是：

BasicMessageChannel：用于传递字符串和半结构化的信息。支持数据双向传递，有返回值。
MethodChannel：用于传递方法调用（method invocation）。支持数据双向传递，有返回值。
EventChannel: 用于数据流（event streams）的通信，仅支持数据单向传递，无返回值。

三种Channel之间互相独立，各有用途，但它们在设计上却非常相近。在宿主平台侧，其设计也非常类似。以下是Flutter在Android平台上的Platform Channel结构示意图。

消息的数据载体是ByteBuffer，在Android和Flutter侧都是通过BinaryMessager来发送和接收数据。接下来，会分别对Android端的三种Channel，以及Flutter端的三种Channel源码进行分析。

3. Android端结构

Android端Platform Channel结构示意图如下。

如图所示，BinaryMessager不会直接和Channel通信，而是通过Channel中的接口BinaryMessageHandler进行通信。在BinaryMessageHandler中，真正处理消息的是：BasicMessageChannel中的MessageHandler，MethodChannel中的MethodCallHandler，以及EventChannel中的StreamHandler。由于Android端无法之间使用二进制数据（ByteBuffer），因此在上述Handler在收发消息之前，会通过对应的Codec进行加解密，用于完成ByteBuffer和所需数据格式之间的转换。

当我们使用一个Channel时，我们需要初始化某个名字（Channel Name）的Channel，然后向该Channel注册一个处理消息的Handler。此时，系统会自动生成一个与之对应的BinaryMessageHandler，并以Channel Name为key，将其注册至BinaryMessager中。其源码如下：

class?DartMessenger?implements?BinaryMessenger,?PlatformMessageHandler?{
??//处理消息的handler
??@NonNull?private final?Map<String,?BinaryMessenger.BinaryMessageHandler>?messageHandlers;

??DartMessenger(@NonNull?FlutterJNI?flutterJNI) {
????this.messageHandlers?=?new?HashMap<>();
??}

??@Override
??public void?setMessageHandler(
??????@NonNull?String?channel,?@Nullable?BinaryMessenger.BinaryMessageHandler?handler) {
????if?(handler ==?null) {
??????Log.*v*(*TAG*,?"Removing handler for channel '"?+ channel +?"'");
??????messageHandlers.remove(channel);
????}?else?{
??????Log.*v*(*TAG*,?"Setting handler for channel '"?+ channel +?"'");
??????messageHandlers.put(channel, handler);
????}
??}
?}

可以看到，各个Channel对应的消息处理Handler均以Map的形式存储在BinaryMessager中，Map的key是Channel Name。

3.1 BasicMessageChannel

用于传递字符串和半结构化的信息。支持数据双向传递，有返回值。其对应的消息处理Handler是MessageHandler，对应的Codec是MessageCodec。MessageHandler的onMessage方法接收一个T类型的消息，并异步返回一个相同类型result。MessageCodec主要用于二进制格式数据（ByteBuffer）与基础数据之间的编解码。

其定义了两个方法：

encodeMessage：接收特定数据类型，并将其编码为二进制数据ByteBuffer。
decodeMessage：接收二进制数据ByteBuffer，并将其解码为特定数据类型。
MessageCodec有以下几种：

codec类	特点
StandardMessageCodec（默认编码器）	支持基础数据类型、二进制数据、列表、字典。
BinaryCodec	1. 无编解码，返回值和入参类型都是二进制格式。2. 可使传递内存数据库时在编解码阶段免于内存拷贝。
StringCodec	字符串与二进制数据之间的编解码。
JSONMessageCodec	1. 基础数据与二进制数据之间的编解码。2. 支持基础数据类型、列表、字典。

3.2 MethodChannel

MethodChannel用于传递方法调用（method invocation）。支持数据双向传递，有返回值。其对应的消息处理Handler是MethodCallHandler，对应的Codec是MethodCodec。MethodCallHandler的onMessage方法接收一个MethodCall类型消息，并根据MethodCall的成员变量method去调用对应的API，当处理完成后，根据方法调用成功或失败，返回对应的结果。MethodCodec用于二进制数据与方法调用(MethodCall)和返回结果之间的编解码。其定义了五个方法：

encodeMethodCall：将方法调用消息加密为二进制数据。
decodeMethodCall：将二进制数据解密为方法调用。
encodeSuccessEnvelope：将成功的方法调用结果加密为二进制数据。
encodeErrorEnvelope：将失败的方法调用结果加密为二进制数据。
decodeEnvelope：将二进制数据解密为方法调用结果。

MethodCodec有以下两类：

codec类

特点

StandardMethodCodec（默认编码器）

依赖于StandardMessageCodec，当其编码MethodCall时，会将method和args依次使用StandardMessageCodec编码，写入二进制数据容器。在编码方法的调用结果时：如果调用成功，会先向二进制数据容器写入数值0（代表调用成功），再写入StandardMessageCodec编码后的result。如果调用失败，会先向二进制数据容器写入数值1（代表调用失败），再写入StandardMessageCodec编码后的code，message和detail。

JSONMethodCodec

依赖于JSONMessageCodec. 编码MethodCall时，会将其转化为JSON串{“method”:method, “args”:args}。在编码调用结果时，会将其转化为一个数组：调用成功为[result], 调用失败为[code, message, detail]。再使用JSONMessageCodec将JSON串或数组转化为二进制数据。

3.3 EventChannel

EventChannel用于数据流（event streams）的通信，仅支持数据单向传递（从Platform到Flutter），无返回值。其对应的消息处理Handler是StreamHandler，对应的Codec也是MethodCodec。StreamHandler与前两者稍显不同，用于事件流的通信，最为常见的用途就是Platform端向Flutter端发送事件消息。当我们实现一个StreamHandler时，需要实现其onListen和onCancel方法。而在onListen方法的入参中，有一个EventSink（其在Android是一个对象，iOS端则是一个block）。我们持有EventSink后，即可通过EventSink向Flutter端发送事件消息。其流程图如下：

StreamHandler工作原理并不复杂。在使用StreamHandler时，首先我们需要在Android端使用一个channel name初始化一个的EventChannel，然后再设置该EventChannel的StreamHandler，在设置该StreamHandler的时候，会以channel name为key将包含该StreamHandler的BinaryMessageHandler注册到BinaryMessager中，这样BinaryMessager在收发消息的时候，就可以通过channel name找到对应的StreamHandler，然后进行处理。

然后在Flutter端，我们需要使用同一个channel name初始化一个EventChannel，然后注册其监听。在注册监听后，Flutter会发送一个二进制消息到Platform端。Platform端用MethodCodec将该消息解码为MethodCall，如果MethodCall的method的值为"listen"，则调用StreamHandler的onListen方法，传递给StreamHandler一个EventSink。而通过EventSink向Flutter端发送消息时，实际上就是通过BinaryMessager的send方法将消息传递过去。

EventChannel使用的Codec也是MethodCodec，此处就不再重复了。

4. Flutter端结构

Flutter端Platform Channel结构示意图如下。

和Android端类似，BinaryMessager不会直接和Channel通信，而是通过Channel中的接口MessageHandler进行通信。在MessageHandler中，真正处理消息的是我们重写的handler函数。由于Flutter端无法之间使用二进制数据（ByteBuffer），因此在上述Handler在收发消息之前，会通过对应的Codec进行加解密，用于完成ByteBuffer和所需数据格式之间的转换。

当我们使用一个Channel时，我们需要初始化某个名字（Channel Name）的Channel，然后向该Channel注册一个处理消息的handler。此时，系统会自动生成一个与之对应的MessageHandler，并以Channel Name为key，将其注册至BinaryMessager中。其源码如下：

class?_DefaultBinaryMessenger?extends?BinaryMessenger?{
   static final?Map<String,?MessageHandler>? _handlers =
??????<String,?MessageHandler>{};

?

   @override
   void?setMessageHandler(String?channel,?MessageHandler?handler) {
??    if?(handler ==?null)
????     _handlers.remove(channel);
??    else
????     _handlers[channel] = handler;
??  ui.channelBuffers.drain(channel(ByteData?data,?ui.PlatformMessageResponseCall back?callback)?async?{
????await?handlePlatformMessage(channel, data, callback);
??    });
   }
}

可以看到，和Android端一样，各个Channel对应的消息处理Handler均以Map的形式存储在BinaryMessager中，Map的key是Channel Name。

4.1 BasicMessageChannel

BasicMessageChannel用于传递字符串和半结构化的信息，对应Android端的BasicMessageChannel。其对应的Codec是MessageCodec。MessageCodec主要用于二进制格式数据（ByteData）与基础数据之间的编解码。其实现子类及该子类支持的数据格式同Android端MessageCodec一一对应。

4.2 MethodChannel

MethodChannel用于传递方法调用（method invocation），对应Android端的MethodChannel。其对应的Codec是MethodCodec。MethodCodec主要用于二进制格式数据（ByteData）与消息调用及结果之间的编解码。其实现子类及该子类支持的数据格式同Android端MethodCodec一一对应。

4.3 EventChannel

EventChannel用于数据流（event streams）的通信，对应Android端的EventChannel。其对应的Codec也是MethodCodec。

5. 消息传递流程

接下来，以一次MethodChannel为例，我们通过源码来理解消息的传递过程。

5.1 Dart层

当我们在Flutter端使用MethodChannel的invokeMethod方法发起一次方法调用时，就开始了我们的消息传递之旅。首先，invokeMethod方法会将message和arguments封装成一个MethodCall对象，然后通过MethodCodec的encodeMethodCall函数将其编码成二进制数据（ByteData），最后通过BinaryMessages将其发送至Engine中的native层。

负责将调用传递给native层的方法是_sendPlatformMessage，该方法是一个native方法，其有三个参数：

name，String类型，值为channel name
callback，PlatformMessageResponseCallback类型，值为回调函数
data，ByteData类型，即二进制类型，即编码过的二进制数据

5.2 native层

_sendPlatformMessage在native层中对应的函数是platform_configuration.cc文件中的_sendPlatformMessage函数。此对应关系是在Dart虚拟机创建时建立的，函数调用流程图如下：

其实很好理解，该函数映射表作为dart层和native层之间的通信通道，属于Flutter Engine的基础，必须在初始阶段创建，和Java中jni的函数映射表类似。

_sendPlatformMessage函数接收了来自dart层的参数，并对其进行了封装：

callback被封装成native的回调PlatformMessageResponse类型的response；data被转化为uint8_t*类型的buffer；然后根据name，data，和buffer生成PlatformMessage类型的消息，并传递给RuntimeController的HandlePlatformMessage进行处理。

RuntimeController会将消息交给其代理RuntimeDelegate处理。RuntimeDelegate的实现类是Engine，Engine在处理消息时，会交由其代理Engine::Delegate处理，而该代理的实际实现为Shell，其OnEngineHandlePlatformMessage接收到消息后，会向PlatformTaskRunner添加一个Task，该Task会调用PlatformView的HandlePlatformMessage方法。

platform_view_android是Platformview的子类，也是其在Android端的具体实现。当platform_view_android接收到PlatformMessage类型的消息时，如果消息中有response（类型为PlatformMessageResponse），则生成一个自增长的response_id,并以response_id为key，response为value存入字典pending_responses_中。接着，将channel和data均转化为Java可识别的数据，通过jni向Java层发起调用，将response_id、channel和data传递过去。

其流程图如下。

5.3 Java层

Java和native的接口类是FlutterJNI，Android和Flutter Engine所有交互的jni接口均在该类中定义。在FlutterJNI中，负责接收PlatformMessage类型的消息的函数是handlePlatformMessage，该函数会将接收到的PlatformMessage交给BinaryMessager处理。在BinaryMessager中，由上文可知保存着以channel为key的BinaryMessageHandler。因此可以根据native传递过来的channel找到对应的BinaryMessageHandler，然后将data转化为二进制数据并交由该BinaryMessageHandler处理。

BinaryMessageHandler处理完成后，FlutterJNI会通过jni调用native的方法，将responseId和message传递到native层。native层，platform_view_android的InvokePlatformMessageResponseCallback接收到了responseId和message。其先将message转化为二进制结果，并根据responseId，从panding_responses_中找到对应的PlatformMessageResponse对象，调用其Complete方法将二进制结果返回。PlatformMessageResponse的Complete方法向UI Task Runner添加了一个新的Task，这个Task的作用是将二进制结果从native的二进制数据类型转化为Dart的二进制数据类型response，并调用dart的callback将response传递到Dart层。