一、关于 Flutter 的 Channel
Flutter 提供了 3 种 Channel 用于 Flutter 与 原生代码做交互,分别是:
类型 |
用途 |
MethodChannel |
用于 Flutter 与 原生平台之间函数的互相调用 |
BasicMessageChannel |
它传递的是字节数组,使用时自定义编解码器 |
EventChannel |
用于 Flutter 与 原生平台之间事件的通信 |
我们可以借助 MethodChannel 实现 Flutter 与原生代码的相互调用。
二、如何在 Flutter 中调用原生代码
在 Flutter 中调用原生代码,需要在原生代码中创建一个 MethodChannel
,并对这个 channel 对象设置 MethodCallHandler
即可。
每个 channel 都可以处理多个方法的调用,在 handler 对象中根据方法名做分发即可。
1. 在 Android 端的实现 MethodChannel
Android 端需要在恰当的时机获取到 FlutterEngine
对象,例如在 FlutterActivity
的 configureFlutterEngine
方法中获取。
接着再创建 MethodChannel 通道实例,最后对通道设置 MethodCallHandler 即可:
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
| import io.flutter.embedding.android.FlutterActivity import io.flutter.embedding.engine.FlutterEngine import io.flutter.plugin.common.MethodChannel
class MainActivity: FlutterActivity() {
override fun configureFlutterEngine(flutterEngine: FlutterEngine) { super.configureFlutterEngine(flutterEngine)
val messenger = flutterEngine.dartExecutor.binaryMessenger
val channel = MethodChannel(messenger, "your_channel_name")
channel.setMethodCallHandler { call, res -> when(call.method) {
"your_method_name" -> { val msg = call.argument<String>("msg") Log.i("ZHP", "正在执行原生方法,传入的参数是:「$msg」") res.success("这是执行的结果") }
else -> { res.error("error_code", "error_message", null) } } } }
}
|
2. 在 iOS 端的实现 MethodChannel
iOS 端创建 MethodChannel 的方式和 Android 类似。 不过在 MethodCallHandler 中获取传入的参数和 Android 有差别,并且 FlutterResult 不支持像 Android 那样标记为 success/error :
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
| class MainViewController: FlutterViewController {
override func viewDidLoad() { super.viewDidLoad()
let channel = FlutterMethodChannel(name: "your_channel_name", binaryMessenger: self.binaryMessenger) channel.setMethodCallHandler { (call, res) in switch(call.method) { case "your_method_name": yourMethodName(call, res) default: res(nil) } } } private func yourMethodName(call: FlutterMethodCall, result: FlutterResult ) { let params = call.arguments as? NSDictionary var msg = "" if (params != nil) { msg = params!["msg"] as? String ?? "" } print("正在执行原生方法,传入的参数是:" + msg) result(nil) } }
|
3. Dart 端的调用
最后我们在 Dart 中调用原生代码中的函数,通过建立一个名称相同的 channel,调用 channel 的 invokeMethod 即可:
1 2 3 4 5 6 7 8 9 10 11 12 13
| const channel = const MethodChannel("your_channel_name");
void callNativeMethod(String msg) { try { Future future = channel.invokeMethod("your_method_name", {"msg": msg} ); print(future.toString()); } on PlatformException catch(e) { print(e.toString()); } }
|
三、如何在原生代码中调用 Flutter 中的方法
有些时候,例如原生组件需要回调到 Flutter 中,需要在原生代码中调用 Flutter 的函数。方法还是通过建立 Channel 对象,为 channel 设置 MethodCallHandler,再在原生代码中通过同名 channel 的 invokeMethod 调用即可。
1. 在 Flutter 中创建 channel 并实现 MethodCallHandler
1 2 3 4 5 6 7 8 9 10 11 12 13 14
| void _initChannel() { var channel = MethodChannel("your_channel_name"); channel.setMethodCallHandler((call) { switch(call.method) { case "your_method_name": { String msg = call.arguments["msg"]; print("Native 调用 Flutter 成功,参数是:$msg"); return "成功"; } } return null; }); }
|
2. 在 Android 和 iOS 端调用 Flutter 的方法
通过创建同名 channel,并执行 invokeMethod 方法,即可在原生代码中调用 Flutter 的方法了:
Android:
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
| import io.flutter.embedding.android.FlutterActivity import io.flutter.embedding.engine.FlutterEngine import io.flutter.plugin.common.MethodChannel
class MainActivity: FlutterActivity() {
override fun configureFlutterEngine(flutterEngine: FlutterEngine) { super.configureFlutterEngine(flutterEngine)
val messenger = flutterEngine.dartExecutor.binaryMessenger
val channel = MethodChannel(messenger, "your_channel_name")
val params = mapOf( "msg" to "这是来自 Android 端的参数" ) channel.invokeMethod("your_method_name", params) }
}
|
iOS:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
| class MainViewController: FlutterViewController {
override func viewDidLoad() { super.viewDidLoad()
let channel = FlutterMethodChannel(name: "your_channel_name", binaryMessenger: self.binaryMessenger) var params: Dictionary<String, String> = ["msg": "这是来自 iOS 端的参数"] channel.invokeMethod("your_method_name", arguments: params) } }
|
好了,这就是 Flutter 与原生 Android、iOS 互相调用函数的方式啦。