Flutter日志管理插件logger_csx的使用

获取开始

要使用 logger_csx 插件，只需创建一个 Logger 实例并开始记录日志：

var logger = Logger();

logger.d("Logger is working!");

你还可以传递其他对象，如 List、Map 或 Set。

文档

日志级别

你可以使用不同的日志级别进行记录：

logger.v("Verbose log"); // 详细日志
logger.d("Debug log");   // 调试日志
logger.i("Info log");    // 信息日志
logger.w("Warning log"); // 警告日志
logger.e("Error log");   // 错误日志
logger.wtf("What a terrible failure log"); // 致命错误日志

要仅显示特定的日志级别，可以设置：

Logger.level = Level.warning;

这将隐藏所有 verbose、debug 和 info 级别的日志事件。

选项

在创建 Logger 时，你可以传入一些选项：

var logger = Logger(
  filter: null, // 使用默认的 LogFilter（仅在调试模式下记录）
  printer: PrettyPrinter(), // 使用 PrettyPrinter 来格式化和打印日志
  output: null, // 使用默认的 LogOutput（输出到控制台）
);

如果你使用 PrettyPrinter，还有更多选项：

var logger = Logger(
  printer: PrettyPrinter(
    methodCount: 2, // 显示的方法调用数
    errorMethodCount: 8, // 如果有堆栈跟踪，则显示的方法调用数
    lineLength: 120, // 输出宽度
    colors: true, // 彩色日志消息
    printEmojis: true, // 打印每个日志消息的emoji
    printTime: false // 每个日志是否包含时间戳
  ),
);

自动检测

使用 io 包可以自动检测 lineLength 和 colors 参数。假设你已经导入了 io 包：

import 'dart:io' as io;

// 自动检测颜色支持
bool supportsColors = io.stdout.supportsAnsiEscapes;

// 自动检测终端列宽
int terminalWidth = io.stdout.terminalColumns;

除非有特殊原因不希望导入 io（例如在Web上使用此库），否则建议这样做。

日志过滤器

LogFilter 决定哪些日志事件应该被显示，哪些不应该被显示。

默认实现（DevelopmentFilter）在调试模式下显示所有日志，而在发布模式下则忽略所有日志。

你可以创建自己的 LogFilter：

class MyFilter extends LogFilter {
  @override
  bool shouldLog(LogEvent event) {
    return true;
  }
}

这将显示所有日志，即使在发布模式下也不例外。（这不是一个好的做法）

日志打印机

LogPrinter 创建并格式化输出，然后将其发送到 LogOutput。

你可以实现自己的 LogPrinter。这提供了最大的灵活性。

一个非常基础的打印机可能看起来像这样：

class MyPrinter extends LogPrinter {
  @override
  List<String> log(LogEvent event) {
    return [event.message];
  }
}

如果你创建了一个有用的 LogPrinter，欢迎提交拉取请求。

颜色

请注意，所有的IDE（如 VSCode、XCode、Android Studio、IntelliJ）都不支持它们的终端输出中的ANSI转义序列。这些转义序列用于给输出着色。如果你使用这样的IDE，不要配置彩色输出。

然而，如果你使用的是JetBrains IDE（如Android Studio、IntelliJ等），你可以使用Grep Console插件和PrefixPrinter装饰器来为任何日志实现彩色输出：

var logger = Logger(
  printer: PrefixPrinter(PrettyPrinter(colors: false))
);

日志输出

LogOutput 将日志行发送到所需的目的地。

默认实现（ConsoleOutput）会将每一行发送到系统控制台。

class ConsoleOutput extends LogOutput {
  @override
  void output(OutputEvent event) {
    for (var line in event.lines) {
      print(line);
    }
  }
}

未来的 LogOutput 可能会发送到文件、Firebase或Logcat。欢迎提交拉取请求。

示例代码

以下是一个完整的示例，展示了如何使用 logger_csx 插件：

import 'package:logger_csx/logger_csx.dart';

var logger = Logger(
  printer: PrettyPrinter(),
);

var loggerNoStack = Logger(
  printer: PrettyPrinter(methodCount: 0),
);

void main() {
  print(
      'Run with either `dart example/main.dart` or `dart --enable-asserts example/main.dart`.');
  demo();
}

void demo() {
  logger.d('Log message with 2 methods');

  loggerNoStack.i('Info message');

  loggerNoStack.w('Just a warning!');

  logger.e('Error! Something bad happened', error: 'Test Error');

  loggerNoStack.v({'key': 5, 'value': 'something'});

  loggerNoStack.wtf('what the fuck!');

  Logger(printer: SimplePrinter(colors: true)).v('boom');
}