當前位置：首頁 > 运维知识 > Android >内容正文

Android

【Flutter】Flutter 混合开发 ( Flutter 与 Native 通信 | Android 端实现 BasicMessageChannel 通信 )

發布時間：2025/6/17 Android 18 豆豆

生活随笔收集整理的這篇文章主要介紹了【Flutter】Flutter 混合开发 ( Flutter 与 Native 通信 | Android 端实现 BasicMessageChannel 通信 ) 小編覺得挺不錯的,現在分享給大家,幫大家做個參考.

文章目錄

前言
一、Android 端 BasicMessageChannel 構造函數
二、Android 端 MessageCodec 子類實現
三、Android 端 setMessageHandler 方法
四、Android 端 send 方法
五、Android 端實現 BasicMessageChannel 通信步驟
六、相關資源

前言

本博客與【Flutter】Flutter 混合開發 ( Flutter 與 Native 通信 | 在 Flutter 端實現 BasicMessageChannel 通信 ) 博客相對應 , 該博客中開發 Flutter 的 Dart 端 ;

本博客中開發 Android 中的 Java 端 , 最終目標是二者可以進行信息交流 ;

一、Android 端 BasicMessageChannel 構造函數

Android 端 Java 中 , BasicMessageChannel 構造函數方法原型如下 :

public final class BasicMessageChannel<T> {@NonNull private final BinaryMessenger messenger;@NonNull private final String name;@NonNull private final MessageCodec<T> codec;/*** Creates a new channel associated with the specified {@link BinaryMessenger} and with the* specified name and {@link MessageCodec}.** @param messenger a {@link BinaryMessenger}.* @param name a channel name String.* @param codec a {@link MessageCodec}.*/public BasicMessageChannel(@NonNull BinaryMessenger messenger, @NonNull String name, @NonNull MessageCodec<T> codec) {if (BuildConfig.DEBUG) {if (messenger == null) {Log.e(TAG, "Parameter messenger must not be null.");}if (name == null) {Log.e(TAG, "Parameter name must not be null.");}if (codec == null) {Log.e(TAG, "Parameter codec must not be null.");}}this.messenger = messenger;this.name = name;this.codec = codec;} }

BasicMessageChannel 接收 $3$ 個參數 :

BinaryMessenger messenger : 用于發送 / 接收消息 ;
String name : Channel 消息通道的名稱 , 該名稱必須與 Dart 中的消息通道名稱相同 ;
MessageCodec<T> codec : 消息編解碼器 ;

二、Android 端 MessageCodec 子類實現

MessageCodec 消息編解碼器的子類實現 : 在 Android Studio 使用 Ctrl + H , 查看 MessageCodec 子類 , 有 $4$ 個子類 ;

BinaryCodec : 二進制編解碼器 , 返回值類型和入參類型都是二進制格式 , 即 Byte 數組 ; 編解碼器沒有做任何操作 , 原封不動的傳遞二進制數據 ; 支持二進制數據 ;
- 適用場景 : 傳遞大量的二進制數據 , 如圖片 , 音視頻等 , 可以直接傳遞內存塊 , 不用再進行編解碼 , 導致消耗不必要的性能 ;
StringCodec : 二進制 Byte 數組與字符串之間進行編解碼 , 字符串編碼格式 UTF-8 ; 發送的時候是 String 類型 , 經過 Channel 通道時編碼成二進制類型 , 接收時在解碼成 String 類型 ; 支持字符串數據 ;
JSONMessageCodec : 二進制數據與基礎數據之間進行編解碼 , 支持基礎數據類型 / 列表 / 字典 ;
StandardMessageCodec : BasicMessageChannel 消息通道的默認編碼器 ; 支持基礎數據類型 / 二進制數據 / 列表 / 字典

BinaryCodec 實現 :

Android : ByteBuffer ;
iOS : NSData ;
Flutter : Uint8List ;

StringCodec 實現 :

Android : java.lang.String ;
iOS : NSString ;
Flutter : String ;

JSONMessageCodec 實現 :

Android : SONUtil , StringCodec ;
iOS : NSJSONSerialization ;

三、Android 端 setMessageHandler 方法

創建了 BasicMessageChannel 實例對象后 , 需要設置信息監聽 , 如果要接收 Dart 端發送來的消息 , 需要設置消息處理器 ;

調用 setMessageHandler 方法 , 可以為 BasicMessageChannel 設置一個消息處理器 ;

BasicMessageChannel.setMessageHandler 函數原型如下 :

/*** Registers a message handler on this channel for receiving messages sent from the Flutter* application.** Overrides any existing handler registration for (the name of) this channel.** If no handler has been registered, any incoming message on this channel will be handled* silently by sending a null reply.** @param handler a {@link MessageHandler}, or null to deregister.*/@UiThreadpublic void setMessageHandler(@Nullable final MessageHandler<T> handler) {messenger.setMessageHandler(name, handler == null ? null : new IncomingMessageHandler(handler));}

設置的 MessageHandler<T> handler 參數 , 就是消息處理器 ;

在 MessageHandler 接口中 , 只有一個 onMessage 方法 , 該方法是用于接收 Dart 傳遞來的消息的 ;

onMessage 參數簡介 :

T message : Dart 端傳遞來的消息 ;
Reply<T> reply : 向 Dart 端回傳的數據 ;

MessageHandler 接口原型如下 :

/** A handler of incoming messages. */public interface MessageHandler<T> {/*** Handles the specified message received from Flutter.** Handler implementations must reply to all incoming messages, by submitting a single reply* message to the given {@link Reply}. Failure to do so will result in lingering Flutter reply* handlers. The reply may be submitted asynchronously.** Any uncaught exception thrown by this method, or the preceding message decoding, will be* caught by the channel implementation and logged, and a null reply message will be sent back* to Flutter.** Any uncaught exception thrown during encoding a reply message submitted to the {@link* Reply} is treated similarly: the exception is logged, and a null reply is sent to Flutter.** @param message the message, possibly null.* @param reply a {@link Reply} for sending a single message reply back to Flutter.*/void onMessage(@Nullable T message, @NonNull Reply<T> reply);}

四、Android 端 send 方法

BasicMessageChannel 通道向 Dart 發送數據有兩個重載的方法 ;

void send(@Nullable T message) 方法 : 單純的向 Dart 端發送數據 , 不接受返回的數據 ;
void send(@Nullable T message, @Nullable final Reply<T> callback) 方法 : 向 Dart 端發送數據 , 并接收 Dart 端返回的數據 ;

send 方法參數說明 :

T message 參數 : 要發送給 Dart 端的數據 ;
final Reply<T> callback 參數 : 消息發送到 Dart 端后 , 如果 Dart 端返回消息 , 會觸發該回調接口 ;

send 函數原型 :

public final class BasicMessageChannel<T> {/*** Sends the specified message to the Flutter application on this channel.** @param message the message, possibly null.*/public void send(@Nullable T message) {send(message, null);}/*** Sends the specified message to the Flutter application, optionally expecting a reply.** Any uncaught exception thrown by the reply callback will be caught and logged.** @param message the message, possibly null.* @param callback a {@link Reply} callback, possibly null.*/@UiThreadpublic void send(@Nullable T message, @Nullable final Reply<T> callback) {messenger.send(name,codec.encodeMessage(message),callback == null ? null : new IncomingReplyHandler(callback));} }

五、Android 端實現 BasicMessageChannel 通信步驟

Android 端實現 BasicMessageChannel 通信步驟 :

首先 , 獲取 FlutterEngine 實例對象 , 需要從該實例對象中獲取 BinaryMessenger ; 這里從 FlutterFragment 中獲取 , 從 FlutterActivity 中也可以獲取 ;

FlutterFragment mFlutterFragment = FlutterFragment.withNewEngine().initialRoute("嵌入 FlutterFragment").build();mFlutterFragment.getFlutterEngine();

然后 , 構建 BasicMessageChannel 對象 , 傳入如下參數 :

// 初始化 BasicMessageChannel mBasicMessageChannel = new BasicMessageChannel(mFlutterFragment.getFlutterEngine().getDartExecutor(),"BasicMessageChannel",StringCodec.INSTANCE);

在后 , 設置消息接收監聽 , 監聽從 Dart 端傳遞來的消息 , 如果有消息傳來 , 會自動回調 MessageHandler 中的 onMessage 方法 ;

// 設置消息接收監聽 mBasicMessageChannel.setMessageHandler(new BasicMessageChannel.MessageHandler<String>() {@Overridepublic void onMessage(@Nullable String message, @NonNull BasicMessageChannel.Reply reply) {show_message.setText("Dart 通過 BasicMessageChannel 通道向 Native 發送 " + message + " 信息");} });

最后 , 設置發送消息 , 點擊按鈕后 , 即可向 Dart 端發送消息 , 同時設置 Reply 參數 , 如果 Dart 端有回送反饋 , 則自動回調 BasicMessageChannel.Reply 接口中的 void reply(@Nullable Object reply) 方法 ;

// 點擊按鈕發送消息 , 并設置 Reply 接收 Dart 返回的消息 findViewById(R.id.channel1).setOnClickListener(new View.OnClickListener() {@Overridepublic void onClick(View v) {mBasicMessageChannel.send("Native 通過 BasicMessageChannel 通道發送消息 Hello !",new BasicMessageChannel.Reply() {@Overridepublic void reply(@Nullable Object reply) {show_message.setText("Native 通過 BasicMessageChannel 通道發送消息 Hello 后 , Dart 反饋的信息 ");}});} });

六、相關資源

參考資料 :

Flutter 官網 : https://flutter.dev/
Flutter 插件下載地址 : https://pub.dev/packages
Flutter 開發文檔 : https://flutter.cn/docs ( 強烈推薦 )
官方 GitHub 地址 : https://github.com/flutter
Flutter 中文社區 : https://flutter.cn/
Flutter 實用教程 : https://flutter.cn/docs/cookbook
Flutter CodeLab : https://codelabs.flutter-io.cn/
Dart 中文文檔 : https://dart.cn/
Dart 開發者官網 : https://api.dart.dev/
Flutter 中文網 : https://flutterchina.club/ , http://flutter.axuer.com/docs/
Flutter 相關問題 : https://flutterchina.club/faq/ ( 入門階段推薦看一遍 )
GitHub 上的 Flutter 開源示例 : https://download.csdn.net/download/han1202012/15989510
Flutter 實戰電子書 : https://book.flutterchina.club/chapter1/
Dart 語言練習網站 : https://dartpad.dartlang.org/

重要的專題 :

Flutter 動畫參考文檔 : https://flutterchina.club/animations/

博客源碼下載 :

GitHub 地址 : ( 隨博客進度一直更新 , 有可能沒有本博客的源碼 )
- Flutter Module 工程 : https://github.com/han1202012/flutter_module
- Android 應用 : https://github.com/han1202012/flutter_native
- 注意 : 上面兩個工程要放在同一個目錄中 , 否則編譯不通過 ;
博客源碼快照 : https://download.csdn.net/download/han1202012/21670919 ( 本篇博客的源碼快照 , 可以找到本博客的源碼 )