Flutter事件总线插件event_bus_plus的使用

EventBus: Events for Dart/Flutter

描述

EventBus 是一个开源库，它为Dart和Flutter提供了基于发布/订阅模式的松耦合通信。通过EventBus，你可以用几行代码实现组件之间的集中式通信，简化代码结构，减少依赖关系，并加速应用程序开发。

使用EventBus的好处

• 简化组件间的通信；
• 解耦事件发送者和接收者；
• 在UI组件（如Widgets, Controllers）中表现良好；
• 避免复杂的、容易出错的依赖关系和生命周期问题。

定义应用事件

// 初始化服务总线
IAppEventBus eventBus = AppEventBus();

// 定义应用事件
final followEvent = FollowEvent('@devcraft.ninja');
final commentEvent = CommentEvent('Awesome package 😎');

订阅事件

// 监听最新事件
final sub = eventBus.last$.listen((AppEvent event) { 
  // do something
});

// 监听特定类型的事件
final sub2 = eventBus.on<FollowAppEvent>().listen((e) { 
  // do something
});

发布事件

// 触发事件
eventBus.fire(followEvent);

监视进行中的事件

// 开始监视事件直到完成
eventBus.watch(followEvent);

// 检查进度
eventBus.isInProgress<FollowAppEvent>();

// 或监听流以检查处理状态
eventBus.inProgress$.map((List<AppEvent> events) =>
    events.whereType<FollowAppEvent>().isNotEmpty);

// 完成事件
eventBus.complete(followEvent);

// 或使用完成事件完成
eventBus.complete(followEvent, nextEvent: SomeAnotherEvent());

查看历史记录

final events = eventBus.history;

映射

final eventBus = bus = EventBus(
  map: {
    SomeEvent: [
      (e) => SomeAnotherEvent(),
    ],
  },
);

示例代码

以下是event_bus_plus的一个完整示例demo：

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

// 初始化服务总线
IEventBus eventBus = EventBus();

void main() {
  // 监听所有事件
  eventBus.on().listen((event) {
    print('${DateTime.now()} Event: $event');
  });

  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({Key? key}) : super(key: key);

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'EventBus Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(title: 'EventBus Demo Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({Key? key, required this.title}) : super(key: key);

  final String title;

  @override
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  int _counter = 0;

  void _incrementCounter() {
    setState(() {
      _counter++;
    });
    
    // 发布一个计数器增加的事件
    eventBus.fire(CounterIncreasedEvent(_counter));
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            const Text(
              'You have pushed the button this many times:',
            ),
            Text(
              '$_counter',
              style: Theme.of(context).textTheme.headline4,
            ),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _incrementCounter,
        tooltip: 'Increment',
        child: const Icon(Icons.add),
      ), 
    );
  }
}

// 定义一个简单的计数器增加事件
class CounterIncreasedEvent {
  final int count;

  CounterIncreasedEvent(this.count);

  @override
  String toString() {
    return 'CounterIncreasedEvent{count: $count}';
  }
}

在上面的例子中，我们创建了一个简单的Flutter应用，当用户点击FloatingActionButton时，会触发计数器增加的事件。这个事件会被eventBus捕获并打印出来。

希望这些信息对您有帮助！如果您有任何疑问或需要进一步的帮助，请随时提问。