Flutter日志记录插件logger的使用

简介

Logger 是一个小型、易于使用且可扩展的日志记录库，它打印出漂亮且格式化的日志。该插件受到Android平台上的 logger 的启发。

资源

• 文档
• Pub Package
• GitHub Repository

快速开始

只需创建一个 Logger 实例并开始记录日志：

import 'package:logger/logger.dart';

void main() {
  var logger = Logger();
  logger.d("Logger is working!");
}

除了字符串消息，你还可以传递其他对象，如 List、Map 或 Set。

日志级别

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

var logger = Logger();

logger.t("Trace log"); // 跟踪日志
logger.d("Debug log"); // 调试日志
logger.i("Info log");  // 信息日志
logger.w("Warning log"); // 警告日志
logger.e("Error log", error: 'Test Error'); // 错误日志
logger.f("What a fatal log", error: error, stackTrace: stackTrace); // 致命错误日志

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

Logger.level = Level.warning; // 只显示警告及更高级别的日志

配置选项

在创建 Logger 实例时，可以传递一些配置选项：

var logger = Logger(
  filter: null, // 使用默认过滤器（仅在调试模式下记录日志）
  printer: PrettyPrinter(), // 使用PrettyPrinter格式化和打印日志
  output: null, // 使用默认输出（将所有内容发送到控制台）
);

如果你使用 PrettyPrinter，可以进一步自定义输出格式：

var logger = Logger(
  printer: PrettyPrinter(
      methodCount: 2, // 显示的方法调用数量
      errorMethodCount: 8, // 如果提供堆栈跟踪，则显示的方法调用数量
      lineLength: 120, // 输出宽度
      colors: true, // 彩色日志消息
      printEmojis: true, // 每条日志前打印表情符号
      dateTimeFormat: DateTimeFormat.onlyTimeAndSinceStart, // 包含时间戳
  ),
);

自动检测

使用 io 包可以自动检测 lineLength 和 colors 参数：

import 'dart:io' as io;

var logger = Logger(
  printer: PrettyPrinter(
    lineLength: io.stdout.terminalColumns,
    colors: io.stdout.supportsAnsiEscapes,
  ),
);

自定义 LogFilter

LogFilter 决定哪些日志事件应该显示，哪些不应该。默认实现 (DevelopmentFilter) 在调试模式下显示所有日志，在发布模式下不显示任何日志。

你可以创建自己的 LogFilter：

class MyFilter extends LogFilter {
  @override
  bool shouldLog(LogEvent event) {
    return true; // 显示所有日志（不推荐用于发布模式）
  }
}

var logger = Logger(filter: MyFilter());

自定义 LogPrinter

LogPrinter 创建和格式化输出，然后将其发送给 LogOutput。你可以实现自己的 LogPrinter：

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

var logger = Logger(printer: MyPrinter());

自定义 LogOutput

LogOutput 将日志行发送到目标位置。默认实现 (ConsoleOutput) 将每行发送到系统控制台。

你可以创建自己的 LogOutput：

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

var logger = Logger(output: MyOutput());

示例代码

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

import 'package:logger/logger.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.t({'key': 5, 'value': 'something'});

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

通过上述内容，你应该能够轻松地在Flutter项目中集成并使用 Logger 插件来记录和查看日志。希望这些信息对你有所帮助！