Flutter日志管理插件clever_logger的使用

Flutter日志管理插件clever_logger的使用

一个具有彩色打印功能的日志库。

基本用法 🚀

您可以使用不同严重程度的日志记录器来记录消息。

默认的日志级别如下：

• fine
• info
• config
• warning
• shout

使用默认的日志记录器记录一条信息级别的日志消息：

logInfo('Hello there!');

这将在控制台中打印该消息：

[Logger - INFO] Hello there!

创建一个日志记录器并使用它来记录消息：

final logger = CleverLogger('Test Logger');
// 现在可以使用此日志记录器
logger.logFine('Hello there!');

高级用法 🧪

日志操作

日志操作负责处理日志（例如将它们存储到文件或将它们发送到您的分析服务）。

LogRecords 按顺序传递给操作。默认情况下，日志记录器使用 ColorfulPrintAction 作为其默认操作，负责将彩色输出打印到控制台。

final otherLogger = CleverLogger(
  'Other Logger',
  logActions: [
    // 默认的彩色控制台输出。
    ColorfulPrintAction(),
    // 自定义操作
    MyLogAction(),
  ],
);

日志操作也可以配置为仅对具有特定级别的日志运行。

class MyLogAction extends LogAction {
  [@override](/user/override)
  Level get level => Level.INFO;

  [@override](/user/override)
  void onRecord(LogRecord record) {
    // 这仅在日志级别大于等于 Level.info 时执行
    print('${record.loggerName} has a log with ${record.level}');
  }
}

功能扩展

您可以编写扩展方法以扩展日志记录器的功能。日志记录器中的 value 变量可以存储附加值。

默认情况下，日志记录器集成有一个 Stopwatch 扩展。

有关更多信息，请参见 示例。

自定义打印

扩展 ColorfulPrintAction 并重写默认的打印函数，如 printInfo、printWarning 等，以便自定义打印消息样式。

您可以使用 ansicolor 插件进行彩色打印。

示例代码

以下是完整的示例代码：

import 'package:clever_logger/clever_logger.dart';
import 'package:clever_logger/extension.dart';

// 这是您的日志记录器。您可以将其定义为全局或局部。
final logger = CleverLogger('Test Logger', logActions: [
  ColorfulPrintAction(
    printer: EmojiPrinter(),
  ),
]);

void main(List<String> arguments) async {
  // 使用默认日志记录器
  logInfo('Hello there');

  logger.log('Something not important', Level.FINE);
  logger.log('This is a info', Level.INFO);
  logger.log('This is a config', Level.CONFIG);
  logger.log(Exception('Oh ho'), Level.WARNING);

  logger.log('This is severe', Level.SEVERE);
  logger.log('This is a LOUD', Level.SHOUT);

  final otherLogger = CleverLogger(
    'Other Logger',
    logActions: [
      // 默认的彩色控制台输出。
      ColorfulPrintAction(),
      // 自定义操作
      MyLogAction(),
    ],
  );

  otherLogger.logFine('A message');

  // 这将运行 [MyLogAction] 的 `onRecord`
  otherLogger.logWarning('Another one');

  // 使用此日志记录器上的默认扩展来使用秒表
  logger.startWatch();
  await Future.delayed(const Duration(milliseconds: 500));
  logger.finishWatch();

  // 自定义扩展以使用此日志记录器进行计数
  // 查看示例文件夹中的 extension.dart 以了解如何为 [CleverLogger] 创建扩展
  logger.countUp();
  logger.countUp('other');
  logger.resetCount('other');
}

class MyLogAction extends LogAction {
  [@override](/user/override)
  Level get level => Level.INFO;

  [@override](/user/override)
  void onRecord(LogRecord record) {
    // 这仅在日志级别大于等于 Level.info 时执行
    print('${record.loggerName} has a log with ${record.level}');
  }
}