一箭双雕 —— Flutter Channel 双通道调用实战

人形打码机
409 阅读5分钟

一、EventChannel 与 MethodChannel 差异对比

Dart 层与原生层之间既有 “点对点” 的方法调用（MethodChannel），也有 “流式推送” 的事件订阅（EventChannel）。两者在使用场景、调用方式和数据流向上存在明显差异，本文将梳理二者差异及对应适用场景。

特性MethodChannelEventChannel
通信模式同步／异步请求-响应单向持续推送
典型场景主动查询（如获取当前电量）、命令下发被动监听（如电池状态变化事件）
调用方式invokeMethod(…) → Future<T>receiveBroadcastStream() → Stream<T>
原生实现调用 MethodChannel.setMethodCallHandler调用 EventChannel.setStreamHandler
性能特点每次请求都会附带方法名和参数，适用于低频交互建立一次通道后可推送大量事件，适用于高频／实时数据
错误处理通过 PlatformException（try/catch）捕获通过 Stream.listen(onError: …) 处理流中错误
生命周期管理每次调用独立，Dart 侧发起后即完成通道打开后需手动取消订阅：subscription.cancel()

示例对比

1. MethodChannel 用于一次性查询

//Flutter 层

Future<int?> getBatteryLevel() async {
  try {
    final int level = await _methodChannel.invokeMethod('getBatteryLevel');
    return level;
  } on PlatformException catch (e) {
    debugPrint('MethodChannel 错误：${e.message}');
    return null;
  }
}

// Android 原生

class FlutterBatteryPlugin : FlutterPlugin {
  override fun onMethodCall(call: MethodCall, result: MethodChannel.Result) {
    when (call.method) {
      "getBatteryLevel" -> {
        val level = batteryMonitor.currentLevel()
        result.success(level)
      }
      else -> result.notImplemented()
    }
  }
}

调用流程：

  1. Dart 调用 invokeMethod("getBatteryLevel")；
  2. 平台通道将方法名传给原生；
  3. 原生执行并通过 result.success(level) 回传；
  4. Dart Future 完成并拿到值。
graph TD
  subgraph MethodChannel
    A1["Flutter: invokeMethod('method')"] --> B1["编码为 MethodCall"]
    B1 --> C1["Native: onMethodCall 处理"]
    C1 --> D1["Native: result.success(data)"]
    D1 --> E1["Flutter: Future 接收结果"]
  end



  style MethodChannel fill:#f9999,stroke:#333
2. EventChannel 用于持续监听

// Flutter 层

StreamSubscription<Map<String, dynamic>>? _batterySub;

void startBatteryMonitoring() {
  _batterySub = _eventChannel
    .receiveBroadcastStream()
    .cast<Map<String, dynamic>>()
    .listen(
      (data) => debugPrint('电池数据：$data'),
      onError: (e) => debugPrint('EventChannel 错误：$e'),
    );
}

void stopBatteryMonitoring() {
  _batterySub?.cancel();
}

// Android 原生

class FlutterBatteryStreamHandler : EventChannel.StreamHandler {
  private var eventSink: EventChannel.EventSink? = null

  override fun onListen(args: Any?, sink: EventChannel.EventSink) {
    eventSink = sink
    batteryMonitor.setOnBatteryLevelChangeCallback { level ->
      eventSink?.success(mapOf("batteryLevel" to level))
    }
  }

  override fun onCancel(args: Any?) {
    batteryMonitor.clearCallback()
    eventSink = null
  }
}

调用流程：

  1. Dart 调用 receiveBroadcastStream() 并监听；
  2. 原生 onListen 注册后向 Dart 推送事件流；
  3. 每当电量变化，原生调用 eventSink.success(data)；
  4. Dart 的 Stream 收到并分发给回调。
graph TD
  subgraph EventChannel
    A2["Flutter: receiveBroadcastStream().listen()"] --> B2["Native: onListen 注册 EventSink"]
    B2 --> C2["Native: eventSink.success(data) 多次推送"]
    C2 --> D2["Flutter: Stream 持续监听事件"]
    D2 --> E2["Native: eventSink.endOfStream() 终止"]
  end

  style EventChannel fill:#9f9,stroke:#333

二、使用 EventChannel 与 MethodChannel 封装实现一个电池检测插件

应用开发中，获取电池信息和监控电池状态通常需要编写原生代码并通过平台通道(Platform Channel)与Flutter 通信。下文将深入解析flutter_battery Android 电池检测插件，对比实现主动读取及监听推送功能对于 channel 的使用场景；

az_recorder_20250518_091407.gif

一、插件架构概述

flutter_battery插件采用了标准的Flutter插件架构，主要包含以下几个部分：

1. Dart层接口定义

定义平台接口(FlutterBatteryPlatform)，用于规范不同平台实现的API约定

abstract class FlutterBatteryPlatform extends PlatformInterface {
  // 平台通用的API定义
  Future<int?> getBatteryLevel();
  Future<Map<String, dynamic>> getBatteryInfo();
  // 更多API...
}

2. 方法通道实现

class MethodChannelFlutterBattery extends FlutterBatteryPlatform {
  final methodChannel = const MethodChannel('flutter_battery');
  final eventChannel = const EventChannel('flutter_battery/battery_stream');
  
  // 实现平台接口中定义的各种方法
}
MethodChannel
graph TB
    %% 样式定义
    classDef flutter fill:#61DAFB,stroke:#333,stroke-width:1px,color:#333
    classDef android fill:#3DDC84,stroke:#333,stroke-width:1px,color:#333
    classDef methodChannel fill:#FFA726,stroke:#333,stroke-width:1px,color:#333
    classDef core fill:#E57373,stroke:#333,stroke-width:1px,color:#333
    
    %% Flutter 应用层
    FlutterApp["Flutter 应用层"]:::flutter
    
    %% 主动查询模式
    FlutterApp -->|"1. getBatteryLevel()"| FlutterBattery["FlutterBattery 类"]:::flutter
    FlutterBattery -->|"2. getBatteryLevel()"| PlatformInterface["FlutterBatteryPlatform"]:::flutter
    PlatformInterface -->|"3. invokeMethod('getBatteryLevel')"| MethodChannel["MethodChannel"]:::methodChannel
    MethodChannel -->|"4. 通过 JNI 调用"| MethodHandler["MethodChannelHandler"]:::android
    MethodHandler -->|"5. getBatteryLevel()"| BatteryMonitor["BatteryMonitor"]:::core
    BatteryMonitor -->|"6. getIntProperty(BATTERY_PROPERTY_CAPACITY)"| AndroidBatteryManager["Android BatteryManager"]:::android
    AndroidBatteryManager -->|"7. 返回电池电量"| BatteryMonitor
    BatteryMonitor -->|"8. 返回电池电量"| MethodHandler
    MethodHandler -->|"9. 返回结果"| MethodChannel
    MethodChannel -->|"10. 返回结果"| PlatformInterface
    PlatformInterface -->|"11. 返回结果"| FlutterBattery
    FlutterBattery -->|"12. 返回结果"| FlutterApp
EventChannel
graph TB
    %% 样式定义
    classDef flutter fill:#61DAFB,stroke:#333,stroke-width:1px,color:#333
    classDef android fill:#3DDC84,stroke:#333,stroke-width:1px,color:#333
    classDef eventChannel fill:#66BB6A,stroke:#333,stroke-width:1px,color:#333
    classDef core fill:#E57373,stroke:#333,stroke-width:1px,color:#333
    
    %% Flutter 应用层
    FlutterApp["Flutter 应用层"]:::flutter
    FlutterBatteryStream["FlutterBattery.batteryInfoStream"]:::flutter
    EventChannel["EventChannel"]:::eventChannel
    EventHandler["EventChannelHandler"]:::android
    TimerManager1["TimerManager"]:::core
    BatteryMonitor["BatteryMonitor"]:::core
    AndroidBatteryManager["Android BatteryManager"]:::android
    
    %% 调用链
    FlutterApp -->|"1. batteryInfoStream.listen()"| FlutterBatteryStream
    FlutterBatteryStream -->|"2. eventChannel.receiveBroadcastStream()"| EventChannel
    EventChannel -->|"3. onListen()"| EventHandler
    EventHandler -->|"4. 启动定时器 timerManager.start()"| TimerManager1
    TimerManager1 -->|"5. 定时执行 pushBatteryInfo()"| EventHandler
    EventHandler -->|"6. getBatteryLevel()"| BatteryMonitor
    BatteryMonitor -->|"7. 获取电池信息"| AndroidBatteryManager
    AndroidBatteryManager -->|"8. 返回电池信息"| BatteryMonitor
    BatteryMonitor -->|"9. 返回电池信息"| EventHandler
    EventHandler -->|"10. eventSink.success(batteryInfo)"| EventChannel
    EventChannel -->|"11. 推送数据到 Stream"| FlutterBatteryStream
    FlutterBatteryStream -->|"12. 触发 listener 回调"| FlutterApp

graph TB
    %% 样式定义
    classDef flutter fill:#61DAFB,stroke:#333,stroke-width:1px,color:#333
    classDef android fill:#3DDC84,stroke:#333,stroke-width:1px,color:#333
    classDef eventChannel fill:#66BB6A,stroke:#333,stroke-width:1px,color:#333
    classDef methodChannel fill:#FFA726,stroke:#333,stroke-width:1px,color:#333
    classDef core fill:#E57373,stroke:#333,stroke-width:1px,color:#333
    
    %% Flutter 应用层
    FlutterApp["Flutter 应用层"]:::flutter
    
    %% EventChannel 推送
    subgraph EventChannel推送方式
        FlutterApp -->|"1. batteryInfoStream.listen()"| FlutterBatteryStream["FlutterBattery.batteryInfoStream"]:::flutter
        FlutterBatteryStream -->|"2. eventChannel.receiveBroadcastStream()"| EventChannel["EventChannel"]:::eventChannel
        EventChannel -->|"3. onListen()"| EventHandler["EventChannelHandler"]:::android
        EventHandler -->|"4. 启动定时器 timerManager.start()"| TimerManager1["TimerManager"]:::core
        TimerManager1 -->|"5. 定时执行 pushBatteryInfo()"| EventHandler
        EventHandler -->|"6. getBatteryLevel()"| BatteryMonitor["BatteryMonitor"]:::core
        BatteryMonitor -->|"7. 获取电池信息"| AndroidBatteryManager["Android BatteryManager"]:::android
        AndroidBatteryManager -->|"8. 返回电池信息"| BatteryMonitor
        BatteryMonitor -->|"9. 返回电池信息"| EventHandler
        EventHandler -->|"10. eventSink.success(batteryInfo)"| EventChannel
        EventChannel -->|"11. 推送数据到 Stream"| FlutterBatteryStream
        FlutterBatteryStream -->|"12. 触发 listener 回调"| FlutterApp
    end
    
    %% 广播接收器推送
    subgraph 广播接收器推送方式
        AndroidBroadcast["Android 电池广播"]:::android -->|"1. ACTION_BATTERY_CHANGED"| BatteryReceiver["电池广播接收器"]:::android
        BatteryReceiver -->|"2. onReceive()"| BatteryMonitor
        BatteryMonitor -->|"3. 更新 lastBatteryLevel"| BatteryMonitor
        BatteryMonitor -->|"4. 启动定时器 batteryLevelPushTimer"| TimerManager2["TimerManager"]:::core
        TimerManager2 -->|"5. 定时执行 pushBatteryLevel()"| BatteryMonitor
        BatteryMonitor -->|"6. 调用回调 onBatteryLevelChangeCallback"| MethodHandler["MethodChannelHandler"]:::android
        MethodHandler -->|"7. invokeMethod('onBatteryLevelChanged')"| MethodChannel["MethodChannel"]:::methodChannel
        MethodChannel -->|"8. _handleMethodCall()"| FlutterMethodChannel["MethodChannelFlutterBattery"]:::flutter
        FlutterMethodChannel -->|"9. _batteryLevelChangeCallback()"| FlutterBattery["FlutterBattery"]:::flutter
        FlutterBattery -->|"10. 触发回调"| FlutterApp
    end

3. 原生实现层

在Android平台上，插件实现了完整的电池监控功能：

class FlutterBatteryPlugin : FlutterPlugin, ActivityAware {
  // 插件初始化和资源管理
  private lateinit var batteryMonitor: BatteryMonitor
  private lateinit var notificationHelper: NotificationHelper
  // 更多组件...
}

三、通信机制深度解析

1. 双向通信设计

这个插件的通信机制设计非常精巧，采用了双通道策略：

  • MethodChannel：用于Flutter向原生平台发送命令和请求数据
  • EventChannel：用于原生平台向Flutter持续推送电池状态变化事件

这种设计使得插件可以同时支持：

  • 按需查询（如获取当前电量）
  • 持续监听（如实时电池状态变化）

2. 回调机制设计

插件在Dart层定义了多种回调接口：

void configureBatteryCallbacks({
  Function(int batteryLevel)? onLowBattery,
  Function(int batteryLevel)? onBatteryLevelChange,
  Function(Map<String, dynamic> batteryInfo)? onBatteryInfoChange,
})

这些回调通过MethodChannel的反向调用实现，当原生层检测到电池状态变化时，会通过invokeMethod向Flutter层发送事件：

batteryMonitor.setOnBatteryLevelChangeCallback { batteryLevel ->
  val params = HashMap<String, Any>()
  params["batteryLevel"] = batteryLevel
  channel.invokeMethod("onBatteryLevelChanged", params)
}

3. 流式数据处理

对于需要连续监听的数据，插件还提供了基于Stream的API：

Stream<Map<String, dynamic>> get batteryStream {
  return eventChannel.receiveBroadcastStream().map((dynamic event) {
    // 将原生数据转换为Dart类型
    final Map<dynamic, dynamic> map = event as Map<dynamic, dynamic>;
    return map.cast<String, dynamic>();
  });
}

这使得开发者可以使用响应式编程的方式处理电池数据：

flutterBatteryPlugin.batteryStream.listen((batteryData) {
  // 处理电池数据更新
});

四、原生功能实现分析

1. 电池监听的实现原理

插件通过Android的BroadcastReceiver机制监听系统电池事件：

private fun registerBatteryReceiver() {
  batteryReceiver = object : BroadcastReceiver() {
    override fun onReceive(context: Context, intent: Intent) {
      when (intent.action) {
        Intent.ACTION_BATTERY_CHANGED -> {
          val level = intent.getIntExtra(BatteryManager.EXTRA_LEVEL, -1)
          val scale = intent.getIntExtra(BatteryManager.EXTRA_SCALE, -1)
          if (level != -1 && scale != -1) {
            val batteryPct = (level * 100 / scale.toFloat()).toInt()
            lastBatteryLevel = batteryPct
            onBatteryLevelChangeCallback?.invoke(batteryPct)
          }
        }
      }
    }
  }
  
  val filter = IntentFilter(Intent.ACTION_BATTERY_CHANGED)
  context.registerReceiver(batteryReceiver, filter)
}

这种实现能够捕获所有电池状态变化，无需轮询，提高了效率和实时性。

2. 定时任务管理

使用自定义的TimerManager类管理各种定时任务，如定期检查电池状态：将定时逻辑与业务逻辑分离，提高代码可维护性。

private val batteryLevelPushTimer = TimerManager() // 电池电量推送定时器
private val batteryCheckTimer = TimerManager() // 低电量检查定时器
private val batteryInfoPushTimer = TimerManager() // 电池信息推送定时器

// 配置定时器任务
batteryCheckTimer.setTask {
  checkLowBattery()
}

3. 防抖动机制

为了避免频繁更新造成的性能问题，增加防抖动机制：

private fun pushBatteryLevel() {
  val currentLevel = lastBatteryLevel
  if (currentLevel >= 0) {
    if (!enableBatteryLevelDebounce || lastBatteryLevel != currentLevel) {
      onBatteryLevelChangeCallback?.invoke(currentLevel)
    }
  }
}

这确保只有在电池电量实际变化时才会触发事件，减少了不必要的通信开销。

四、总结

1. 结构设计

  • 平台接口抽象：通过抽象接口定义跨平台行为
  • 通道封装：将通信细节封装在专门的处理类中
  • 模块化原生实现：将原生功能分解为职责单一的模块

2. 监控策略

  • 事件驱动：使用系统广播而非轮询
  • 防抖动：过滤不必要的更新
  • 多级别通知：支持系统通知和Flutter自定义UI
  • 可配置的监控频率：允许调整监控精度和资源消耗

通道选择

  • MethodChannel

    • 适用于「一次性」且「明确请求-立即响应」的场景。
    • 常见于查询系统信息、执行单次操作（如请求电池百分比、打开／关闭某功能）。

  • EventChannel

    • 适用于「持续」且「频繁推送」的场景。

    • 适用于电池电量、电量变化、网络状态变化、传感器数据等需要实时监听的功能。

插件地址： lizy-coding/flutter_battery: Flutter Android 推送通知和电池监控插件，支持立即通知、延迟通知和低电量监控。

avatar
文章
阅读
粉丝