Flutter方法调用插件rx_method_channel的使用

rx_method_channel 是一个用于在 Flutter 中通过 ReactiveX（Rx）包装方法通道的库。它允许开发者以更简洁的方式处理来自原生平台（Android 或 iOS）的异步事件。

如何使用？

1. 添加依赖

首先，在 pubspec.yaml 文件中添加 rx_method_channel 作为依赖：

dependencies:
  rx_method_channel: ^版本号

然后运行以下命令以安装依赖：

flutter pub get

2. 创建方法通道

使用 RxMethodChannel 创建一个方法通道实例：

import 'package:rx_method_channel/rx_method_channel.dart';

void main() async {
  // 创建一个名为 "channelName" 的方法通道
  final channel = RxMethodChannel(channelName: "channelName");
}

3. 使用 executeObservable 处理可观察流

executeObservable 方法用于处理来自原生平台的事件流。以下是示例代码：

// 订阅事件流
final observableSubsciption = channel.executeObservable(
  methodName: "methodName", // 原生平台的方法名
  arguments: {},           // 传递给原生平台的参数
).listen((event) {
  // 处理接收到的事件
  debugPrint(event.toString());
});

// 取消订阅
observableSubsciption.cancel();

4. 使用 executeCompletable 处理完成操作

executeCompletable 方法用于执行一次性任务，并在完成后触发回调函数：

// 执行完成操作
final completableOperation =
    channel.executeCompletable(methodName: "methodName");

// 等待任务完成并打印结果
await completableOperation.valueOrCancellation().whenComplete(() {
  debugPrint("Completed");
});

5. 使用 executeSingle 获取单个值

executeSingle 方法用于获取单个返回值：

// 执行单次操作并获取结果
final singleOperation = channel.executeSingle(
  methodName: "methodName",
  arguments: {
    "arg": "someArg", // 传递给原生平台的参数
  },
);

// 等待并打印返回值
final value = await singleOperation.valueOrCancellation();
debugPrint(value.toString());

完整示例代码

以下是一个完整的示例代码，展示了如何使用 rx_method_channel 库：

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

import 'package:rx_method_channel/rx_method_channel.dart';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatefulWidget {
  const MyApp({super.key});

  [@override](/user/override)
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  final channel = RxMethodChannel(channelName: "test_channel");

  StreamSubscription? subs;

  [@override](/user/override)
  void initState() {
    super.initState();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('rx_method_channel 示例'),
        ),
        body: Column(
          crossAxisAlignment: CrossAxisAlignment.stretch,
          mainAxisAlignment: MainAxisAlignment.start,
          children: [
            // 单次操作按钮
            MaterialButton(
              onPressed: () async {
                final value = await channel
                    .executeSingle(methodName: "mySingle")
                    .value;
                debugPrint(value);
              },
              child: const Center(child: Text("执行 Single")),
            ),

            // 完成操作按钮
            MaterialButton(
              onPressed: () async {
                await channel
                    .executeCompletable(methodName: "myCompletable")
                    .value
                    .whenComplete(() => debugPrint("已完成"));
              },
              child: const Center(child: Text("执行 Completable")),
            ),

            // 可观察流按钮
            MaterialButton(
              onPressed: () {
                subs?.cancel(); // 取消之前的订阅
                subs = channel
                    .executeObservable(methodName: "myObservable")
                    .timeout(const Duration(seconds: 5))
                    .listen((event) {
                  debugPrint(event);
                });
              },
              child: const Center(child: Text("执行 Observable")),
            ),
          ],
        ),
      ),
    );
  }
}