Flutter Method Channel（方法通道）

什么是Method Channel

Method Channel是Flutter与原生平台通信的桥梁。它允许Flutter代码调用原生代码的方法，反之亦然。通过Method Channel，可以：

• 从Flutter调用原生方法（Method Calls）
• 从原生调用Flutter方法（Method Callbacks）
• 在两者之间传递数据

为什么需要Method Channel

虽然Flutter提供了丰富的UI组件和库，但某些平台特定的功能只能通过原生代码实现。例如：

• 访问设备传感器
• 使用特定的系统API
• 集成原生的第三方库

在这些情况下，Method Channel是连接Flutter和原生代码的关键。

Method Channel的结构

Flutter定义了4种Channel：

1. BasicMessageChannel: 最基础的通道，需要指定编解码器codec
2. MethodChannel: 适合单次调用方法
3. EventChannel: 适合监听持续事件（如传感器数据）。
4. OptionalMethodChannel: 是MethodChannel的扩展，当平台代码未实现时，不会抛出异常，而是返回null。

平台通道，通道由3个部分组成：

1. name: 名称，通道的唯一标识符，此参数必传。
2. codec: 编解码器，除了BasicMessageChannel无默认编解码器，其它Channel都有默认的编解码器StandardMethodCodec
3. binaryMessenger: 消息收发器，默认是ServicesBinding.defaultBinaryMessenger

使用

在Flutter中实现Method Channel

首先，在Flutter代码中创建一个Method Channel，并实现方法调用。

import 'package:flutter/services.dart';

class BatteryLevel {
  static const platform = MethodChannel('com.example/battery');

  Future<int> getBatteryLevel() async {
    int batteryLevel;
    try {
      final int result = await platform.invokeMethod('getBatteryLevel');
      batteryLevel = result;
    } on PlatformException catch (e) {
      batteryLevel = -1;
    }
    return batteryLevel;
  }
}

解释：

• 创建Method Channel：使用通道名称'com.example/battery'。
• 调用原生方法：invokeMethod('getBatteryLevel')。
• 处理异常：捕获PlatformException。

在Android平台上实现Method Channel

在MainActivity中处理来自Flutter的Method Call。

import io.flutter.embedding.android.FlutterActivity
import io.flutter.embedding.engine.FlutterEngine
import io.flutter.plugin.common.MethodChannel
import android.os.BatteryManager
import android.content.Context

class MainActivity: FlutterActivity() {
    private val CHANNEL = "com.example/battery"

    override fun configureFlutterEngine(flutterEngine: FlutterEngine) {
        super.configureFlutterEngine(flutterEngine)
        MethodChannel(flutterEngine.dartExecutor.binaryMessenger, CHANNEL)
            .setMethodCallHandler { call, result ->
                if (call.method == "getBatteryLevel") {
                    val batteryLevel = getBatteryLevel()

                    if (batteryLevel != -1) {
                        result.success(batteryLevel)
                    } else {
                        result.error("UNAVAILABLE", "无法获取电池电量", null)
                    }
                } else {
                    result.notImplemented()
                }
            }
    }

    private fun getBatteryLevel(): Int {
        val batteryManager = getSystemService(Context.BATTERY_SERVICE) as BatteryManager
        return batteryManager.getIntProperty(BatteryManager.BATTERY_PROPERTY_CAPACITY)
    }
}

解释：

• 配置Method Channel：使用相同的通道名称'com.example/battery'。
• 处理方法调用：检查方法名称并执行对应操作。
• 获取电池电量：使用Android的BatteryManager。

在iOS平台上实现Method Channel

在AppDelegate中处理来自Flutter的Method Call。

import UIKit
import Flutter

@UIApplicationMain
@objc class AppDelegate: FlutterAppDelegate {
    private let CHANNEL = "com.example/battery"

    override func application(
        _ application: UIApplication,
        didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
    ) -> Bool {
        let controller = window?.rootViewController as! FlutterViewController
        let batteryChannel = FlutterMethodChannel(name: CHANNEL, binaryMessenger: controller.binaryMessenger)

        batteryChannel.setMethodCallHandler { (call, result) in
            if call.method == "getBatteryLevel" {
                self.receiveBatteryLevel(result: result)
            } else {
                result(FlutterMethodNotImplemented)
            }
        }

        return super.application(application, didFinishLaunchingWithOptions: launchOptions)
    }

    private func receiveBatteryLevel(result: FlutterResult) {
        let device = UIDevice.current
        device.isBatteryMonitoringEnabled = true

        if device.batteryState == UIDevice.BatteryState.unknown {
            result(FlutterError(code: "UNAVAILABLE", message: "无法获取电池电量", details: nil))
        } else {
            result(Int(device.batteryLevel * 100))
        }
    }
}

解释：

• 配置Method Channel：使用相同的通道名称'com.example/battery'。
• 处理方法调用：检查方法名称并执行对应操作。
• 获取电池电量：使用iOS的UIDevice。

Flutter界面代码

import 'package:flutter/material.dart';
import 'package:flutter/services.dart';

void main() => runApp(BatteryApp());

class BatteryApp extends StatefulWidget {
  @override
  _BatteryAppState createState() => _BatteryAppState();
}

class _BatteryAppState extends State<BatteryApp> {
  String _batteryLevel = '未知';

  Future<void> _getBatteryLevel() async {
    String batteryLevel;
    try {
      final int result = await BatteryLevel.platform.invokeMethod('getBatteryLevel');
      batteryLevel = '$result%';
    } on PlatformException {
      batteryLevel = '无法获取电池电量';
    }

    setState(() {
      _batteryLevel = batteryLevel;
    });
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: Text('电池电量示例')),
        body: Center(
          child: Column(
            mainAxisAlignment: MainAxisAlignment.center,
            children: [
              Text('电池电量：$_batteryLevel'),
              ElevatedButton(
                onPressed: _getBatteryLevel,
                child: Text('获取电池电量'),
              ),
            ],
          ),
        ),
      ),
    );
  }
}

运行效果

点击按钮后，应用将显示当前设备的电池电量。

类型安全问题

Flutter端与平台端，收发数据的类型必须匹配，否则会抛出异常，

如果是简单的使用场景，手写MethodChannel或EventChannel，问题不大。

如果数据比较复杂时，这个问题不容忽视。可以依赖代码生成技术，来保证类型安全，Flutter官方推荐使用pigeon库。

关于pigeon的使用，见使用 pigeon 实现 Flutter 与原生通信。