一篇看懂Android與Flutter之間的通訊

大逗大人發表於2019-06-23
AndroidFlutter

在不得不看的Flutter與Android混合開發一文中講述了Android專案如何匯入flutter模組，但有一個問題，就是它們之間還不能互相通訊，但這又是非常必要的。所以本文就來講述一下Android如何與flutter進行通訊。

1、架構概述

訊息通過平臺通道在native(host)與flutter(client)之間傳遞，如下圖所示：

一篇看懂Android與Flutter之間的通訊

為了確保使用者介面能夠正確響應，訊息都是以非同步的方式進行傳遞。無論是native向flutter傳送訊息，還是flutter向native傳送訊息。

在flutter中，MethodChannel可以傳送與方法呼叫相對應的訊息。在native平臺上，MethodChannel在Android可以接收方法呼叫並返回結果。這些類可以幫助我們用很少的程式碼就能開發平臺外掛。

注意：本節內容來自flutter官網，讀者可自行查閱。

2、平臺通道資料型別支援和編解碼器

平臺通道可以使用提供的編解碼器對訊息進行編解碼，這些編解碼器支援簡單類似JSON的值的高效二進位制序列化，例如布林值，數字，字串，位元組緩衝區以及這些的列表和對映。當你傳送和接收值時，會自動對這些值進行序列化和反序列化。

下表顯示瞭如何在平臺端接收Dart值，反之亦然：

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:
int, if 64 bits not enough java.math.BigInteger FlutterStandardBigInteger
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

關於編解碼器，Android端提供了以下四種。

  • BinaryCodec：是最簡單的一種編解碼器，其返回值型別與入參的型別相同，均為二進位制格式（ByteBuffer）。由於BinaryCodec在編解碼過程中什麼都沒做，只是原封不動的將二進位制資料返回。所以傳遞的資料在編解碼時會免於拷貝，這種方式在傳遞的資料量比較大時很有用。比如從Android側傳入一張圖片到Flutter側顯示。
  • StandardMessageCodec：是BasicMessageChannel的預設編解碼器，支援基礎資料型別、列表及字典等。在編碼時會先將資料寫入到ByteArrayOutputStream流中，然後再將該流中的資料寫入到ByteBuffer中。在解碼時，直接從ByteBuffer中讀取資料。
  • StandardMethodCodec：是基於StandardMessageCodec的封裝。是MethodChannel與EventChannel的預設編解碼器。
  • StringCodec：是用於字串與二進位制資料之間的編解碼，其編碼格式為UTF-8。在編碼時會將String轉成byte陣列，然後再將該陣列寫入到ByteBuffer中。在解碼時，直接從ByteBuffer中讀取資料
  • JSONMessageCodec：內部呼叫StringCodec來實現編解碼。
  • JSONMethodCodec：基於JSONMessageCodec的封裝。可以在MethodChannel與EventChannel中使用。

ByteBuffer是Nio中的一個類，顧名思義——就是一塊儲存位元組的區域。它有兩個實現類——DirectByteBuffer與HeapByteBuffer，DirectByteBuffer是直接在記憶體中開闢了一塊區域來儲存資料，而HeapByteBuffer是在JVM堆中開闢一塊區域來儲存資料，所以要想資料在DirectByteBuffer中與HeapByteBuffer互通，就需要進行一次拷貝。關於ByteBuffer的更多內容可以去閱讀Java NIO 的前生今世 之三 NIO Buffer 詳解這篇文章。

3、通訊方式

前面講了Android與flutter通訊的一些基礎知識，下面就進入正題，來看Android如何與flutter進行通訊。

Android與Flutter之間的通訊共有四種實現方式。

  1. 由於在初始化flutter頁面時會傳遞一個字串——route，因此我們就可以拿route來做文章，傳遞自己想要傳遞的資料。該種方式僅支援單向資料傳遞且資料型別只能為字串，無返回值。
  2. 通過EventChannel來實現，EventChannel僅支援資料單向傳遞，無返回值。
  3. 通過MethodChannel來實現，MethodChannel支援資料雙向傳遞，有返回值。
  4. 通過BasicMessageChannel來實現，BasicMessageChannel支援資料雙向傳遞，有返回值。

下面就來看一下這幾種方式的使用。

3.1、初始化時傳值

主要是利用了建立flutter頁面傳遞的route來做文章，筆者認為該種方式屬於取巧，但還是可以用來傳遞資料。它的使用很簡單，程式碼如下。

首先來看Android程式碼。

//第三個引數可以換成我們想要字串。
FlutterView flutterView = Flutter.createView(this, getLifecycle(), "route");
複製程式碼

在flutter中，我們只需要通過下面程式碼來獲取值即可。

void main() => runApp(MyApp(
      initParams: window.defaultRouteName,
    ));

class MyApp extends StatelessWidget {
  final String initParams;//既是前面傳遞的值——route

  MyApp({Key key, @required this.initParams}) : super(key: key);

  @override
  Widget build(BuildContext context) {...}
}
複製程式碼

通過該種方式就可以在初始化flutter時，Android給flutter傳遞資料。由於runApp僅會呼叫一次，所以該種方式只能傳遞一次資料且資料只能是字串。

使用window的相關API需要匯入包dart:ui

3.2、EventChannel

EventChannel是一種native向flutter傳送資料的單向通訊方式，flutter無法返回任何資料給native。主要用於native向flutter傳送手機電量變化、網路連線變化、陀螺儀、感測器等。它的使用方式如下。

首先來看Android程式碼。

public class EventChannelPlugin implements EventChannel.StreamHandler {

    private static final String TAG = EventChannelPlugin.class.getSimpleName();
    private EventChannel.EventSink eventSink;
    private Activity activity;

    static EventChannelPlugin registerWith(FlutterView flutterView) {
        EventChannelPlugin plugin = new EventChannelPlugin(flutterView);
        new EventChannel(flutterView, "EventChannelPlugin").setStreamHandler(plugin);
        return plugin;

    }

    private EventChannelPlugin(FlutterView flutterView) {
        this.activity = (Activity) flutterView.getContext();
    }

    void send(Object params) {
        if (eventSink != null) {
            eventSink.success(params);
        }
    }

    void sendError(String str1, String str2, Object params) {
        if (eventSink != null) {
            eventSink.error(str1, str2, params);
        }
    }

    void cancel() {
        if (eventSink != null) {
            eventSink.endOfStream();
        }
    }
    //第一個引數為flutter初始化EventChannel時返回的值，僅此一次
    @Override
    public void onListen(Object o, EventChannel.EventSink eventSink) {
        this.eventSink = eventSink;
        Log.i(TAG, "eventSink：" + eventSink);
        Log.i(TAG, "Object：" + o.toString());
        Toast.makeText(activity, "onListen——obj：" + o, Toast.LENGTH_SHORT).show();
    }

    @Override
    public void onCancel(Object o) {
        Log.i(TAG, "onCancel：" + o.toString());
        Toast.makeText(activity, "onCancel——obj：" + o, Toast.LENGTH_SHORT).show();
        this.eventSink = null;
    }
}
複製程式碼

筆者對Android端程式碼做了一個簡單的封裝，還是很好理解的。下面就來看flutter程式碼實現。

class _MyHomePageState extends State<MyHomePage> {
  EventChannel _eventChannelPlugin = EventChannel("EventChannelPlugin");
  StreamSubscription _streamSubscription;
  @override
  void initState() {
    _streamSubscription = _eventChannelPlugin
         //["abc", 123, "你好"]對應著Android端onListen方法的第一個引數，可不傳值
        .receiveBroadcastStream(["abc", 123, "你好"])
        .listen(_onToDart, onError: _onToDartError, onDone: _onDone);
    super.initState();
  }

  @override
  void dispose() {
    if (_streamSubscription != null) {
      _streamSubscription.cancel();
      _streamSubscription = null;
    }
    super.dispose();
  }
  //native端傳送正常資料
  void _onToDart(message) {
    print(message);
  }
  //當native出錯時，傳送的資料
  void _onToDartError(error) {
    print(error);
  }
  //當native傳送資料完成時呼叫的方法，每一次傳送完成就會呼叫
  void _onDone() {
    print("訊息傳遞完畢");
  }

  @override
  Widget build(BuildContext context) {...}
}
複製程式碼

上面就是通過EventChannel來進行通訊的程式碼實現，呼叫EventChannelPlugin的send方法就能給flutter傳送資料。

3.3、MethodChannel

MethodChannel是一種native與flutter之間互相傳送資料的通訊方式，顧名思義，通過MethodChannel就能呼叫native與flutter中相對應的方法，該種方式有返回值。它的使用方式如下。

首先來看Android端的程式碼實現。

public class MethodChannelPlugin implements MethodChannel.MethodCallHandler {

    private Activity activity;
    private MethodChannel channel;

    public static MethodChannelPlugin registerWith(FlutterView flutterView) {
        MethodChannel channel = new MethodChannel(flutterView, "MethodChannelPlugin");
        MethodChannelPlugin methodChannelPlugin = new MethodChannelPlugin((Activity) flutterView.getContext(), channel);
        channel.setMethodCallHandler(methodChannelPlugin);
        return methodChannelPlugin;
    }

    private MethodChannelPlugin(Activity activity, MethodChannel channel) {
        this.activity = activity;
        this.channel = channel;

    }
    //呼叫flutter端方法，無返回值
    public void invokeMethod(String method, Object o) {
        channel.invokeMethod(method, o);
    }
    //呼叫flutter端方法，有返回值
    public void invokeMethod(String method, Object o, MethodChannel.Result result) {
        channel.invokeMethod(method, o, result);
    }

    @Override
    public void onMethodCall(MethodCall methodCall, MethodChannel.Result result) {
        switch (methodCall.method) {
            case "send"://返回的方法名
                //給flutter端的返回值
                result.success("MethodChannelPlugin收到：" + methodCall.arguments);
                Toast.makeText(activity, methodCall.arguments + "", Toast.LENGTH_SHORT).show();
                if (activity instanceof FlutterAppActivity) {
                    ((FlutterAppActivity) activity).showContent(methodCall.arguments);
                }
                break;
            default:
                result.notImplemented();
                break;
        }
    }
}

複製程式碼

筆者對Android端程式碼做了一個簡單的封裝，還是很好理解的。下面就來看flutter程式碼實現。

class _MyHomePageState extends State<MyHomePage> {
  MethodChannel _methodChannel = MethodChannel("MethodChannelPlugin");
  @override
  void initState() {
    _methodChannel.setMethodCallHandler((handler) => Future<String>(() {
          print("_methodChannel：${handler}");
          //監聽native傳送的方法名及引數
          switch (handler.method) {
            case "send":
              _send(handler.arguments);//handler.arguments表示native傳遞的方法引數
              break;
          }
        }));
    super.initState();
  }
  //native呼叫的flutter方法
  void _send(arg) {
    setState(() {
      _content = arg;
    });
  }
  String _resultContent = "";
  
  //flutter呼叫native的相應方法
  void _sendToNative() {
      Future<String> future =
          _methodChannel.invokeMethod("send", _controller.text);
      future.then((message) {
        setState(() {
           //message是native返回的資料
          _resultContent = "返回值：" + message;
        });
      });
  }

  @override
  Widget build(BuildContext context) {...}
}
複製程式碼

上面就是通過MethodChannel來進行通訊的程式碼實現。還是比較簡單的。在Android端使用只需要呼叫MethodChannelPlugin的invokeMethod方法即可。在flutter端使用只需要參考_sendToNative方法的實現即可。

3.4、BasicMessageChannel

BasicMessageChannel是一種能夠在native與flutter之間互相傳送訊息的通訊方式，它支援資料型別最多，使用範圍最廣。EventChannel與MethodChannel的應用場景可以使用BasicMessageChannel來實現，但BasicMessageChannel的應用場景就不一定能夠使用EventChannel與MethodChannel來實現。該方式有返回值。它的使用方式如下。

首先來看Android程式碼的實現。

//這裡支援的資料型別為String。
public class BasicMessageChannelPlugin implements BasicMessageChannel.MessageHandler<String> {

    private Activity activity;

    private BasicMessageChannel<String> messageChannel;

    static BasicMessageChannelPlugin registerWith(FlutterView flutterView) {
        return new BasicMessageChannelPlugin(flutterView);
    }

    private BasicMessageChannelPlugin(FlutterView flutterView) {
        this.activity = (Activity) flutterView.getContext();
        this.messageChannel = new BasicMessageChannel<String>(flutterView, "BasicMessageChannelPlugin", StringCodec.INSTANCE);
        messageChannel.setMessageHandler(this);
    }


    @Override
    public void onMessage(String s, BasicMessageChannel.Reply<String> reply) {
        reply.reply("BasicMessageChannelPlugin收到：" + s);
        if (activity instanceof FlutterAppActivity) {
            ((FlutterAppActivity) activity).showContent(s);
        }
    }

    void send(String str, BasicMessageChannel.Reply<String> reply) {
        messageChannel.send(str, reply);
    }
}
複製程式碼

筆者對Android端程式碼做了一個簡單的封裝，還是很好理解的。下面就來看flutter程式碼實現。

class _MyHomePageState extends State<MyHomePage> {
  //StringCodec()為編碼格式
  BasicMessageChannel<String> _basicMessageChannel =
      BasicMessageChannel("BasicMessageChannelPlugin", StringCodec());


  @override
  void initState() {
    _basicMessageChannel.setMessageHandler((message) => Future<String>(() {
          print(message);
          //message為native傳遞的資料
          setState(() {
            _content = message;
          });
          //給Android端的返回值
          return "收到Native訊息：" + message;
        }));
    _controller = TextEditingController();
    super.initState();
  }

  //向native傳送訊息
  void _sendToNative() {
      Future<String> future = _basicMessageChannel.send(_controller.text);
      future.then((message) {
        _resultContent = "返回值：" + message;
      });
  }

  @override
  Widget build(BuildContext context) {...}
}
複製程式碼

上面就是通過BasicMessageChannel來進行通訊的程式碼實現。在Android端只需要呼叫BasicMessageChannelPlugin的send方法就可以向flutter傳送資料，BasicMessageChannel.Reply<String>是返回值的回撥方法。在flutter端使用只需要參考_sendToNative方法的實現即可。

4、通訊原理

從分析Android與Flutter通訊的原始碼來看，實現還是比較簡單的，都是以ByteBuffer為資料載體，然後通過BinaryMessenger來傳送與接收資料。整體設計如下。

一篇看懂Android與Flutter之間的通訊

從圖中可以看出，Android側與flutter側採用了相同的設計。前面說過通訊時是非同步進行的，那麼執行緒切換在哪？其實是在系統底層實現的。在Android與Flutter通訊中，系統底層遮蔽了執行緒切換、資料拷貝等大量複雜操作。使得Android側與flutter側能方便的來進行通訊。

在Android側，BinaryMessenger是一個介面，在FlutterView中實現了該介面，在BinaryMessenger的方法中通過JNI來與系統底層溝通。在Flutter側，BinaryMessenger是一個類，該類的作用就是與類window溝通，而類window才真正與系統底層溝通。

關於通訊的底層實現可以去閱讀閒魚的技術文章——深入理解Flutter Platform Channel，這篇文章很好的講述了Flutter與Native通訊的系統底層原理。

5、總結

在Android與Flutter混合開發模式下，相互之間通訊的場景肯定不會少。瞭解Android與Flutter之間通訊的各種方式及使用，有助於選用合理的方式來實現。

相關文章