Flutter通信中介插件broker的使用

Broker

Flutter应用程序的对象代理

从应用的任何位置向任意小部件发送消息

Broker 是一个为 Flutter 应用程序设计的消息代理包，它允许你从应用的任何地方向任何小部件发送消息。通过 Broker，你只需初始化一次 Broker 类，就可以在应用的任何地方向上下文中的小部件发送消息。此外，如果你有多个订阅者，Broker 支持消息广播，确保所有相关的小部件都能接收到相同的消息。

功能特性

• 为 Flutter 应用提供消息代理。
• 不论小部件在 widget 树中的位置如何，都可以向其发送消息。
• 支持消息广播。
• 初始化一次即可全局使用，使用 getBroker() 函数。

import 'package:broker/broker.dart';

使用步骤

第一步：初始化 Broker

void main() {
    // 初始化 Broker 一次，并在任何地方使用
    Broker broker = Broker();

    runApp(const MyApp());
}

第二步：注册和监听消息

// 建议将以下代码作为无状态或有状态小部件的属性
late Broker broker;

// 建议将以下代码放在 initState() 方法中
broker = getBroker();
broker.register("<subscriber-name>");

broker.listen("<subscriber-name>", (event) {
    Protocol protocol = (event as Protocol);
    print("Message: ${protocol.data}");
});

如果在设置过程中遇到问题，请查看 示例代码。

完整示例代码

以下是一个完整的示例，展示了如何使用 Broker 插件来实现消息的发布和订阅功能。

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

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  final broker = Broker();
  runApp(const MyApp());
}

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

  // 这是你的应用根组件
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Broker Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const MyHomePage(),
    );
  }
}

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

  [@override](/user/override)
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {

  late Broker broker;

  String data = "";

  // 演示如何为特定订阅者发布消息
  _brokerMessagePublisherDemo() {
    int count = 0;
    final _timer = Timer.periodic(Duration(seconds: 2), (_) {
      broker.publish("<publisher-name>", "<subscriber-name>", "${count++}");
    });
  }

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

    // 初始化 Broker 并注册订阅者
    broker = getBroker();
    broker.register("<subscriber-name>");

    // 监听来自订阅者的事件
    broker.listen("<subscriber-name>", (event) {
      Protocol protocol = (event as Protocol);
      setState(() {
        data = protocol.data;
      });
    });

    // 启动定时器以模拟消息发布
    _brokerMessagePublisherDemo();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text("Broker Demo"),
        actions: [
          IconButton(
            icon: const Icon(Icons.calculate_rounded),
            onPressed: () {},
          )
        ],
      ),

      body: Container(
        child: Center(
            child: Text("Data: $data")
        )
      )
    );
  }
}