Flutter事件总线插件event_bus_arch的使用

Flutter事件总线插件event_bus_arch的使用

关于

这个包是事件驱动架构的一部分，提供发送、监听、处理和接收事件的功能。

V2 简单使用

EventBus在V2中有三个主要方法：send、listen和lastData。

void main() async {
  /// EventBusIsolate由主隔离区和工作隔离区两部分组成。
  /// 它们之间交换EventDTO和处理程序的工作结果。
  EventBusIsolate isolateBus = EventBusIsolate(onInit: _initIsolate);
  await isolateBus.waitInit;
  
  /// 在主隔离区监听来自工作隔离区的事件
  isolateBus.listen<String>().listen((event) {
    print('event from isolate: $event');
  });
  
  print('result: ${await isolateBus.send(10)}');
  print('result: ${await isolateBus.send(11)}');
  await Future.delayed(Duration(seconds: 1));
}

/// 此函数在隔离区运行。我们等待类型为<int>的事件，并返回一个字符串结果
void _initIsolate(EventBus bus) {
  /// 所有的EventBus都实现了EventBusHandlers接口
  /// 设置事件类型为<int>的处理程序
  (bus as EventBusHandlers).setHandler<int>(handler: (dto, lastData) async {
    // 发送结果到主线程
    dto.completer?.complete(dto.data.toString());
    // 发送事件<String>
    bus.send(dto.data.toString());
  });
}

V1 简单使用

事件(EventDTO)由三部分组成：头部（主题）、唯一标识符和数据。主题由传输对象的类型（必需）和事件名称组成。

EventBus bus = EventBus();
//----- 不使用EventDTO
/// listenEvent返回Stream
/// 主题 = 'int' 
/// bus.listenEvent<int>()! 可以返回null，如果你设置了前缀，因为bus会搜索其他带有前缀的EventBus
bus.listenEvent<int>()!.listen((event) => print('int event:$event'));
/// 主题 = 'int^test' 
bus.listenEvent<int>(eventName: 'test')!.listen((event) => print('int^test event:$event'));
/// 主题 = 'int' 
bus.send<int>(1); //'int event:1'
bus.send(2); //'int event:2' 在这种情况下类型事件自动获取
/// 主题 = 'int^test' 
bus.send<int>(3, eventName: 'test');//'int@test event:3'
//----- 使用EventDTO
bus
      .listenEventDTO<int>()!
      .listen((event) => print('topic ${event.topic} uuid:${event.uuid} event:${event.data}'));
bus
      .listenEventDTO<int>(eventName: 'test')!
      .listen((event) => print('topic ${event.topic} uuid:${event.uuid} event:${event.data}'));

当你调用listenEvent方法时，你可以设置标志repeatLastEvent，它会在等待1毫秒或指定的持续时间后发送事件。

V1 使用前缀和EventBusMaster

EventBusMaster是一个单例，它知道所有创建的EventBus并使用前缀进行排序。EventBusMaster还提供了从不同业务发送和接收事件的能力，如果没有EventBus，它将返回null或false。如果你使用任何EventBus通过前缀发送事件，且EventBus的前缀与指定的前缀不匹配，事件将被发送到EventBusMaster。

EventBus bus = EventBus();
EventBus busServices = EventBus(prefix: 'services');
/// 获取来自bus的事件
EventBusMaster.instance.listenEvent<int>()!.listen((event) => print('int master event:$event'));
/// 获取来自busServices的事件
EventBusMaster.instance
      .listenEvent<int>(prefix: 'services')!
      .listen((event) => print('int master services bus event:$event'));
  bus.send<int>(5);
  EventBusMaster.instance.send(6);
  EventBusMaster.instance.send(7, prefix: 'services');

前缀可以用来将应用程序分为不同的层次，例如：

• ViewModel：用于存储模型的最新状态，不会删除未使用的节点。
• App：包含业务逻辑的层。
• AppModel：类似于ViewModel，用于存储应用运行所需的数据模型。
• Services和ServicesModel：分别对应服务层和数据模型层。

V1 EventBus for Model

默认情况下，EventBus在没有事件监听器的情况下不会清除事件节点。但是，如果你在构造函数中添加了标志isBusForModel，你会得到一个不会清除事件节点的EventBus(EventModelController)。这个EventModelController可以用于持有资源管理器并更新对象（模型、提供者、命令、接口等）。

V1 EventBus Handler

EventBusHandlersGroup这个接口用于处理组。你可以将EventBusHandlersGroup连接到你的EventBus。

/// 事件处理器
typedef EventHandler<T> = Future<void> Function(
    EventDTO<T> event,

    /// 发送事件给其他监听器
    EventEmitter<EventDTO<T>>? emit,
    {EventBus? bus,
    Completer<dynamic>? needComplete});

class TestHandlers implements EventBusHandlersGroup {
  EventBusHandler? _bus;

  @override
  // TODO: 实现 isConnected
  bool get isConnected => _bus != null;

  @override
  void connect(EventBusHandler bus) {
    _bus = bus;
    bus.addHandler<int>(plusNoEmit, eventName: 'no_emit');
    bus.addHandler<int>(plusEmit, eventName: 'emit');
  }

  @override
  void disconnect(EventBusHandler bus) {
    // TODO: 实现 disconnect
  }

  Future<void> plusNoEmit(EventDTO<int> event, EventEmitter<EventDTO<int>>? emit,
      {EventBus? bus, Completer? needComplete}) async {
    print('plusNoEmit: ${event.data + 1}');
  }

  Future<void> plusEmit(EventDTO<int> event, EventEmitter<EventDTO<int>>? emit,
      {EventBus? bus, Completer? needComplete}) async {
    var e = event.copy(data: event.data + 1);
    print('plusEmit: ${e.data}');
    emit?.call(e);
  }
}

Future<void> main() async {
  EventBus bus = EventBus(prefix: 'test');
  var handlers = TestHandlers();
  handlers.connect(bus);
  bus.send<void>(null, eventName: 'getMasterData'); // 调用 getMasterData 函数
  bus.send(Test()); // 调用 test 函数
}

V1 方法：Call

如果事件有处理程序，处理程序可以处理needCompleter并完成它。完成的结果将从未来返回。如果没有处理程序或者处理程序不支持needCompleter，未来将完成一个错误。

try {
  var r = await bus1.call('Hello');
} catch (e) {
  print(e);
}