Flutter日志记录插件en_logger的使用

EnLogger 允许你根据需要写入日志消息，而不会限制你将消息写入调试控制台或其他系统。它维护了一个内部的 EnLoggerHandlers 列表。你可以基于特定需求实现自己的 EnLoggerHandler。每次你想使用 EnLogger 记录消息时，每个 EnLoggerHandler 都会被调用来执行写操作。

• 如果你需要你的系统将日志写入文件，实现一个 EnLoggerHandler 来执行写入文件的操作。
• 如果你想将日志发送到 Sentry，实现一个 EnLoggerHandler，该处理器内部维护一个 Sentry 实例。每次写入日志时，调用 Sentry 的写入方法。

PrinterHandler 是库内提供的一个 EnLoggerHandler，允许你在开发者控制台上写入彩色消息。

一些示例可以在 示例项目 中看到。

日志符合 syslog 严重性级别。

安装

dependencies:
  en_logger:

配置

快速设置

1. 创建一个 EnLogger 实例：final logger = EnLogger()
2. 向你的日志记录器添加处理器：logger.addHandler(PrinterLogger())
3. 写入日志：logger.debug('Arrived here'), logger.error('Error deserializing data')

前缀

日志可以有前缀。可以为这个前缀应用样式。

final logger = EnLogger(defaultPrefixFormat: PrefixFormat(
    startFormat: '[',
    endFormat: ']',
    style: PrefixStyle.uppercaseSnakeCase,
  ))
  ..addHandler(PrinterLogger())
  ..debug('get data', prefix: "API repository")

// 打印机输出 --> [API_REPOSITORY] get data

数据

消息可以包含附件，例如序列化数据、文件内容等。

// 带有数据的错误
logger.error(
  "error",
  data: [
    EnLoggerData(
      name: "response",
      content: jsonEncode("BE data"),
      description: "serialized BE response",
    ),
  ],
);

实例

为了避免每次都重写前缀，可以根据 EnLogger 创建实例。例如，如果你有一个特定的范围（如 API 存储库），你可以实例化一个带有前缀 “API repository” 的 EnLogger，并且这个前缀会包含在每条日志中，除非你明确覆盖它。

final instLogger = logger.getConfiguredInstance(prefix: 'API Repository');
instLogger.debug('a debug message'); // [API Repository] a debug message
instLogger.error(
  'error',
  prefix: 'Custom prefix',
); // [Custom prefix] a debug message

PrinterHandler

默认开发控制台处理器已着色。有一个基本的颜色设置，可以更新。

final printer = PrinterHandler()
  ..configure({Severity.notice: PrinterColor.green()});

你也可以创建自定义颜色。

PrinterColor.custom(schema: '\x1B[31m')

示例代码

以下是一个完整的示例代码，展示了如何使用 en_logger 插件。

import 'dart:convert';

import 'package:en_logger/en_logger.dart';
import 'package:sentry/sentry.dart';

void main(List<String> args) async {
  // 一个自定义处理器，底层使用 Sentry
  final sentry = await SentryHandler.init();

  // 默认打印机配置
  final printer = PrinterHandler()
    ..configure({Severity.notice: PrinterColor.green()});

  // 一个具有默认前缀格式的 enLogger
  final logger = EnLogger(
      defaultPrefixFormat: PrefixFormat(
    startFormat: '[',
    endFormat: ']',
    style: PrefixStyle.uppercaseSnakeCase,
  ))
    ..addHandlers([
      sentry,
      printer,
    ]);

  // 调试日志
  logger.debug('a debug message');

  // 带有数据的错误
  logger.error(
    "error",
    data: [
      EnLoggerData(
        name: "response",
        content: jsonEncode("BE data"),
        description: "serialized BE response",
      ),
    ],
  );

  // 带有前缀的日志实例
  final instLogger = logger.getConfiguredInstance(prefix: 'API Repository');
  instLogger.debug('a debug message'); // [API Repository] a debug message
  instLogger.error(
    'error',
    prefix: 'Custom prefix',
  ); // [Custom prefix] a debug message
}

class SentryHandler extends EnLoggerHandler {
  SentryHandler._();

  static Future<SentryHandler> init() async {
    await Sentry.init(
      (options) {
        options.dsn = 'https://example@sentry.io/example';
      },
    );
    return SentryHandler._();
  }

  [@override](/user/override)
  void write(
    String message, {
    required Severity severity,
    String? prefix,
    StackTrace? stackTrace,
    List<EnLoggerData>? data,
  }) {
    // 只是一个简单的示例
    // 精细调整你的实现...
    if (severity.atLeastError) {
      Sentry.captureException(message, stackTrace: stackTrace);
      return;
    }
    Sentry.captureMessage(message);
  }
}