Flutter事件生成与管理插件eventified_generator的使用

Eventified

将方法调用转换为事件流。

开始使用

在你的 pubspec.yaml 文件中添加以下依赖：

dependencies:
  eventified:

dev_dependencies:
  build_runner:
  eventified_generator: 

使用方法

1. 声明方法

首先声明一个类，该类定义一组公开的方法，并带有参数。使用 @eventified 注解标注该类。

在文件顶部添加 part 'example.g.dart'; 声明。

方法的返回类型必须是 void。

import 'package:eventified/eventified.dart';

part 'example.g.dart';

@eventified
abstract class Example {
  void hello({
    required bool world,
    String? name,
  });

  void world(String name);
}

2. 生成事件类和流实现

运行构建工具命令来生成事件类和流实现：

dart run build_runner build

如果你使用的是 Flutter，可以运行以下命令：

flutter pub run build_runner build

3. 使用实现

/// 创建 `Streamed` 生成实现的实例。
final streamed = StreamedExample();

/// 监听从 `stream` 中发出的事件。
streamed.stream.listen((event) {
  print(event);
});

/// 调用方法以触发相应的事件。
streamed
  ..hello(world: false, name: 'Jeff')
  ..world('john');

/// 上面的调用会在控制台打印：
///
/// HelloExampleEvent(
///   world : false,
///   name : Jeff,
/// )
/// WorldExampleEvent(
///   name : john,
/// )

/// 关闭底层的流。
streamed.dispose();

高级用法

通过注解可以自定义生成的类和行为。

自定义事件名称

你可以设置一个基础事件名称和特定的事件名称。

[@Eventified](/user/Eventified)(baseEvent: 'MyEvent')
abstract class ExampleCustomEventNames {
  [@Event](/user/Event)(name: 'HelloEvent')
  void hello({
    required bool world,
    String? name,
  });

  [@Event](/user/Event)(name: 'WorldEvent')
  void world(String name);
}

添加元数据

你可以生成一个 $metadata 属性，允许在运行时反射事件及其参数。这可能对序列化特别有用。

[@Eventified](/user/Eventified)(metadata: true)
abstract class Example {
  void hello({
    required bool world,
    String? name,
  });

  void world(String name);
}

元数据键也可以独立地使用 [@Event](/user/Event) 和 @EventArgument 注解进行自定义。

[@Eventified](/user/Eventified)(metadata: true)
abstract class Example {
  [@Event](/user/Event)(metadata: 'Hello')
  void hello({
    required bool world,
    @EventArgument(metadata: 'Name') String? name,
  });

  void world(String name);
}