跳到正文
教程首页
FlutterCH 15ch15_platform_channels

ch15-platform-channels

平台通道与原生互操作:MethodChannel / EventChannel。完整工程共 100 个文件,其中 60 个文本源文件可在下面在线阅读。

60

在线文本文件

3,832

源码行数

dart / c / yaml

语言

281 KB

打包体积

在线阅读源码

左侧按目录浏览,点击文件切换。右上角可复制代码、复制路径或单独下载文件。在线视图只覆盖文本源码,完整工程请下载 zip。

textxmldartkotlinyaml

60 text files · 3,832 lines

darttest/platform_channel_test.dart
import 'package:ch15_platform_channels/main.dart';
import 'package:ch15_platform_channels/src/platform_service.dart';
import 'package:flutter/material.dart';
import 'package:flutter/services.dart';
import 'package:flutter_test/flutter_test.dart';

/// 把 MethodChannel 的 mock handler 换成指定实现。
void mockChannel(String name, Future<Object?> Function(MethodCall call) handler) {
  TestDefaultBinaryMessengerBinding.instance.defaultBinaryMessenger
      .setMockMethodCallHandler(MethodChannel(name), handler);
}

/// 模拟原生通过 EventChannel 主动推事件。
Future<void> emitEvent(int value) async {
  await TestDefaultBinaryMessengerBinding.instance.defaultBinaryMessenger.handlePlatformMessage(
    kTicksChannel,
    const StandardMethodCodec().encodeSuccessEnvelope(value),
    (ByteData? _) {},
  );
}

void main() {
  TestWidgetsFlutterBinding.ensureInitialized();

  tearDown(() {
    TestDefaultBinaryMessengerBinding.instance.defaultBinaryMessenger
        .setMockMethodCallHandler(const MethodChannel(kDeviceChannel), null);
    TestDefaultBinaryMessengerBinding.instance.defaultBinaryMessenger
        .setMockMethodCallHandler(const MethodChannel(kTicksChannel), null);
  });

  group('MethodChannel', () {
    test('解析原生返回的 Map', () async {
      mockChannel(kDeviceChannel, (MethodCall call) async {
        expect(call.method, 'getPlatformInfo');
        return <String, Object?>{
          'os': 'macOS',
          'version': '27.2.1',
          'arch': 'arm64',
          'isDarkMode': true,
        };
      });

      final PlatformInfo info = await PlatformService().getPlatformInfo();
      expect(info.os, 'macOS');
      expect(info.version, '27.2.1');
      expect(info.arch, 'arm64');
      expect(info.isDarkMode, isTrue);
    });

    test('字段缺失时用默认值,不崩', () async {
      mockChannel(kDeviceChannel, (MethodCall call) async => <String, Object?>{'os': 'Linux'});
      final PlatformInfo info = await PlatformService().getPlatformInfo();
      expect(info.os, 'Linux');
      expect(info.version, '');
      expect(info.arch, '');
      expect(info.isDarkMode, isFalse);
    });

    test('原生返回非 Map → FormatException', () async {
      mockChannel(kDeviceChannel, (MethodCall call) async => 'not-a-map');
      expect(() => PlatformService().getPlatformInfo(), throwsA(isA<FormatException>()));
    });

    test('原生抛 PlatformException → PlatformUnsupportedException', () async {
      mockChannel(kDeviceChannel, (MethodCall call) async {
        throw PlatformException(code: 'E_PERM', message: '权限不足');
      });

      await expectLater(
        PlatformService().getPlatformInfo(),
        throwsA(isA<PlatformUnsupportedException>()
            .having((PlatformUnsupportedException e) => e.toString(), 'message', contains('权限不足'))),
      );
    });

    test('没有原生实现(MissingPluginException)被翻译成 PlatformUnsupportedException', () async {
      // 不注册任何 handler
      await expectLater(
        PlatformService().getPlatformInfo(),
        throwsA(isA<PlatformUnsupportedException>()),
      );
    });

    test('无返回值的方法:vibrate', () async {
      var called = 0;
      mockChannel(kDeviceChannel, (MethodCall call) async {
        if (call.method == 'vibrate') called++;
        return null;
      });

      await PlatformService().vibrate();
      expect(called, 1);
    });
  });

  group('EventChannel', () {
    test('接收原生推送的多条事件', () async {
      final List<String> nativeCalls = <String>[];
      mockChannel(kTicksChannel, (MethodCall call) async {
        nativeCalls.add(call.method);
        return null; // listen / cancel 都回 null
      });

      final List<int> received = <int>[];
      final subscription = PlatformService().ticks().listen(received.add);

      // 等 EventChannel 把 listen 发给原生
      await Future<void>.delayed(const Duration(milliseconds: 20));
      expect(nativeCalls, contains('listen'));

      await emitEvent(1);
      await emitEvent(2);
      await emitEvent(3);
      await Future<void>.delayed(const Duration(milliseconds: 20));

      expect(received, <int>[1, 2, 3]);

      await subscription.cancel();
      await Future<void>.delayed(const Duration(milliseconds: 20));
      expect(nativeCalls, contains('cancel')); // 取消订阅必须通知原生,否则定时器不停
    });

    test('事件类型不对 → Stream 报错', () async {
      mockChannel(kTicksChannel, (MethodCall call) async => null);

      final Future<Object?> error = PlatformService().ticks().first
          .then<Object?>((int value) => value)
          .catchError((Object e) => e);

      await Future<void>.delayed(const Duration(milliseconds: 20));
      await TestDefaultBinaryMessengerBinding.instance.defaultBinaryMessenger.handlePlatformMessage(
        kTicksChannel,
        const StandardMethodCodec().encodeSuccessEnvelope('oops'),
        (ByteData? _) {},
      );

      expect(await error, isA<FormatException>());
    });
  });

  group('页面集成', () {
    testWidgets('显示原生信息、状态文案、事件计数', (WidgetTester tester) async {
      mockChannel(kDeviceChannel, (MethodCall call) async {
        if (call.method == 'getPlatformInfo') {
          return <String, Object?>{'os': 'TestOS', 'version': '1.0', 'arch': 'test-arch'};
        }
        return null;
      });
      mockChannel(kTicksChannel, (MethodCall call) async => null);

      await tester.pumpWidget(const PlatformChannelApp());
      await tester.pumpAndSettle();

      expect(find.text('OS: TestOS'), findsOneWidget);
      expect(find.text('版本: 1.0'), findsOneWidget);
      expect(find.text('架构: test-arch'), findsOneWidget);
      expect(find.text('状态: getPlatformInfo 成功'), findsOneWidget);

      // 推两条事件,界面应更新
      await emitEvent(1);
      await tester.pump();
      await emitEvent(2);
      await tester.pump();
      expect(find.text('收到 2 次事件'), findsOneWidget);

      // 调用 vibrate
      await tester.tap(find.byKey(const Key('vibrate')));
      await tester.pumpAndSettle();
      expect(find.text('状态: vibrate 已调用'), findsOneWidget);

      // 卸载,让 EventChannel 发 cancel
      await tester.pumpWidget(const SizedBox.shrink());
      await tester.pumpAndSettle();
    });

    testWidgets('原生未实现时显示提示而不是崩溃', (WidgetTester tester) async {
      // 模拟原生侧回 FlutterMethodNotImplemented(引擎会转成 MissingPluginException)
      mockChannel(kDeviceChannel, (MethodCall call) async => throw MissingPluginException());
      mockChannel(kTicksChannel, (MethodCall call) async => null);

      await tester.pumpWidget(const PlatformChannelApp());
      await tester.pumpAndSettle();

      expect(find.byKey(const Key('info-error')), findsOneWidget);
      expect(find.text('状态: 原生未实现'), findsOneWidget);

      await tester.pumpWidget(const SizedBox.shrink());
      await tester.pumpAndSettle();
    });
  });
}

代码构成:text 60 KB · xml 41 KB · dart 18 KB · kotlin 6 KB

本地运行

zip → 解压 → 执行
$cd examples/ch15-platform-channels && flutter run -d macos

这个 zip 里有什么

  • • 完整工程目录(含 Android / iOS / 桌面平台脚手架)
  • • lib / bin / test / native 全部源码与测试
  • • pubspec.yaml、锁文件与平台配置文件
  • • 已排除 .dart_tool / build / target / ephemeral 等构建产物

已验证

  • flutter analyze 0 告警、flutter test 10 个用例全绿、flutter build macos --debug 真实构建
查看全部示例