Flutter审计监控插件audit_spy的使用

概述

在本教程中，我们将学习如何使用 audit_spy 插件来实现 Flutter 应用程序中的审计日志记录。该插件通过在 EventMediator 和 MutableEventMediator 上添加装饰器来记录带时间戳的日志，从而帮助调试事件处理问题，甚至可以重构事件流。

特性

• 集成了 i_spy 和日志记录功能，将事件写入审计日志。

开始使用

依赖项

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

dependencies:
  i_spy: ^1.0.0
  logging: ^1.2.0
  audit_spy: ^x.y.z  # 请替换为实际版本号

配置

你应该配置根日志级别为 info。这应该可以在任何 Dart 3+ 运行环境中工作。

使用方法

查看 example/audit_spy_example.dart 中的示例代码。

示例代码

import 'dart:math';

import 'package:audit_spy/audit_spy.dart';
import 'package:i_spy/i_spy.dart';
import 'package:logging/logging.dart';

// 定义事件类型
final class Ping implements Event {}
final class Pong implements Event {}

// 创建可审计的中介器
final MutableAuditingMediator<Pong> pongMediator = auditedSimpleEventMediator<Pong>();
final MutableAuditingMediator<Ping> pingMediator = auditedSimpleEventMediator<Ping>();

// 创建随机数生成器
final fate = Random();

// 定义 Pinger 类
final class Pinger
    with BasicObservable<Ping>
    implements Observable<Ping>, Observer<Pong> {
  final Set<Subscription<Ping>> stored = {};

  Pinger() {
    pongMediator.add(this);  // 添加到 Pong 的中介器
    add(pingMediator);  // 添加到 Ping 的中介器
  }

  // 触发 Ping 事件
  void ping() => notifyObservers(Ping());

  // 处理 Pong 事件
  [@override](/user/override)
  void update(final Pong e) {
    if (fate.nextBool()) {
      ping();  // 如果随机值为 true，则触发 Ping 事件
    }
  }

  // 获取订阅者
  [@override](/user/override)
  Set<Subscription<Ping>> get subscriptions => stored;
}

// 定义 Ponger 类
final class Ponger
    with BasicObservable<Pong>
    implements Observable<Pong>, Observer<Ping> {
  final Set<Subscription<Pong>> stored = {};

  Ponger() {
    pingMediator.add(this);  // 添加到 Ping 的中介器
    add(pongMediator);  // 添加到 Pong 的中介器
  }

  // 处理 Ping 事件
  [@override](/user/override)
  void update(final Ping e) {
    if (fate.nextBool()) {
      pong();  // 如果随机值为 true，则触发 Pong 事件
    }
  }

  // 触发 Pong 事件
  void pong() => notifyObservers(Pong());

  // 获取订阅者
  [@override](/user/override)
  Set<Subscription<Pong>> get subscriptions => stored;
}

/// 主函数，演示如何记录日志。
void main() {
  final caught = [];
  final Pinger ping = Pinger();
  final Ponger pong = Ponger();

  // 监听日志记录并打印
  Logger.root.onRecord.listen((record) {
    print(record);
    caught.add(record);
  });

  // 触发事件
  ping.ping();
  pong.pong();

  // 断言捕获的日志不为空
  assert(caught.isNotEmpty);
}