Flutter控制台监控插件hisma_console_monitor的使用

特性

hisma_console_monitor 插件实现了对 Hisma 状态机程序中所有层次状态机活动状态的简单监控。它会将这些状态打印到控制台（或者你可以定义的其他地方，例如日志记录器）。

开始使用

首先，确保你已经在项目中添加了 hisma 和 hisma_console_monitor 依赖项。在你的 pubspec.yaml 文件中添加以下内容：

dependencies:
  hisma: ^x.x.x
  hisma_console_monitor: ^x.x.x

然后运行 flutter pub get 来安装依赖。

使用方法

基本用法

要启用 [ConsoleMonitor]，只需在 Machine.monitorCreators 中添加一个返回 ConsoleMonitor 的创建函数即可。以下是从 hisma 示例代码中提取的示例：

Future<void> main() async {
  // 添加 ConsoleMonitor 到监控创建函数列表中
  Machine.monitorCreators = [
    (machine) => ConsoleMonitor(machine),
  ];

  // 启动状态机并开始播放
  await lightMachine.start();
  await play();
}

这将使控制台监控器跟踪状态机的创建和状态变化，并打印出所有层次状态机的当前活动状态。

自定义输出方式

如果你想自定义 [ConsoleMonitor] 的输出方式，比如使用自己的日志记录器而不是直接打印到控制台，可以修改 printer 参数。例如，我们可以在每次输出之前添加一行分隔符：

Future<void> main() async {
  Machine.monitorCreators = [
    (machine) => ConsoleMonitor(
          machine,
          printer: (str) {
            // 自定义输出格式
            print('-MONITOR----------------------------');
            print(str);
          },
        ),
  ];

  await lightMachine.start();
  await play();
}

这样，每次状态更新时都会在输出前加上一行分隔符。

完整示例代码

以下是完整的示例代码，展示了如何使用 hisma_console_monitor 插件来监控状态机的状态变化。

// ignore_for_file: avoid_print

import 'package:hisma/hisma.dart';
import 'package:hisma_console_monitor/hisma_console_monitor.dart';

Future<void> main() async {
  // 添加 ConsoleMonitor 到监控创建函数列表中
  Machine.monitorCreators = [
    (machine) => ConsoleMonitor(machine),
  ];

  // 启动状态机并开始播放
  await lightMachine.start();
  await play();
}

// 定义状态枚举
enum S { on, off }

// 定义事件枚举
enum E { turnOn, turnOff }

// 定义转换枚举
enum T { toOn, toOff }

// 创建状态机
Machine<S, E, T> createLightMachine({
  List<Region<S, E, T, dynamic>>? regions,
}) =>
    Machine<S, E, T>(
      name: 'lightMachine',
      events: E.values,
      initialStateId: S.off,
      states: {
        S.off: State(
          etm: {
            E.turnOn: [T.toOn],
          },
          onEntry: Action(
            description: 'Turning off.',
            action: (machine, dynamic arg) async => print('OFF'),
          ),
        ),
        S.on: State(
          etm: {
            E.turnOff: [T.toOff],
          },
          regions: regions,
          onEntry: Action(
            description: 'Turning on.',
            action: (machine, dynamic arg) async => print('ON'),
          ),
        ),
      },
      transitions: {
        T.toOn: Transition(to: S.on),
        T.toOff: Transition(to: S.off),
      },
    );

// 初始化状态机
final lightMachine = createLightMachine();

// 模拟状态机操作
Future<void> play() async {
  while (true) {
    await Future<void>.delayed(const Duration(seconds: 1));
    await lightMachine.fire(E.turnOn);
    await Future<void>.delayed(const Duration(seconds: 1));
    await lightMachine.fire(E.turnOff);
  }
}