Flutter总线通信插件flutter_easybus的使用

flutter_easybus

flutter_easybus 是一个用于 Flutter 的订阅通信总线插件。

Getting Started

该项目是一个 Dart 包的起点，作为库模块，可以轻松地在多个 Flutter 或 Dart 项目中共享代码。

有关如何开始使用 Flutter 的更多信息，请参阅我们的在线文档，其中包含教程、示例、移动开发指南以及完整的 API 参考。

基础使用

定义任意订阅对象

class BusTest{  
  late Map bus;  
  BusTest({required this.bus});  
}

注册订阅

第一种（推荐）

EventSubscription subscription = EasyBus().on<BusTest>().listen((arg) {  
  print("normal listen ${arg.bus}" );  
});  
// subscription.free(); /// 在合适的位置释放，防止内存泄露

第二种

/// 注意使用 wait 方法订阅，在第一次回调后会自动销毁
var busTest = await EasyBus().on<BusTest>().wait();  
print("wait listen ${busTest.bus}");

发送信息

EasyBus().send(BusTest(bus: {'name': 'easyBus'}));

注销所有当前对象订阅

EasyBus().free<BusTest>();

更简单的使用方法

EasyBus().simpleOn().listen((arg) { /// 直接使用内置对象
  print("simple listen ${arg.key}" );  
});

/// 发送信息
EasyBus().simpleSend("key123", {'name': 'lisa'});

完整示例 Demo

以下是一个完整的示例，展示如何使用 flutter_easybus 插件进行消息传递。

1. 创建订阅者

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

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

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: SubscriberPage(),
    );
  }
}

class SubscriberPage extends StatefulWidget {
  [@override](/user/override)
  _SubscriberPageState createState() => _SubscriberPageState();
}

class _SubscriberPageState extends State<SubscriberPage> {
  String _message = "Waiting for message...";

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

    // 使用推荐方式订阅消息
    EventSubscription subscription = EasyBus().on<Map<String, dynamic>>().listen((arg) {
      setState(() {
        _message = arg.toString();
      });
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text("Subscriber"),
      ),
      body: Center(
        child: Text(_message),
      ),
    );
  }
}

2. 创建发布者

class PublisherPage extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text("Publisher"),
      ),
      body: Center(
        child: ElevatedButton(
          onPressed: () {
            // 发送消息
            EasyBus().send({"key": "value"});
          },
          child: Text("Send Message"),
        ),
      ),
    );
  }
}

3. 主页面路由

class MyHomePage extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return DefaultTabController(
      length: 2,
      child: Scaffold(
        appBar: TabBar(
          tabs: [
            Tab(text: "Subscriber"),
            Tab(text: "Publisher"),
          ],
        ),
        body: TabBarView(
          children: [
            SubscriberPage(),
            PublisherPage(),
          ],
        ),
      ),
    );
  }
}