Flutter 中的优雅日志记录

2023-12-05 21:09:18

尽管 Flutter 中提供了 print 函数来记录日志，但它仅能显示单一的颜色，这在调试时会造成不便。为解决此问题，本文介绍了如何在 Flutter 中使用 logger 来实现更优雅的日志记录，包括控制文本颜色和简洁的日志记录输出。

设置 Logger

要开始使用 logger，需要在项目中添加 logger 依赖项：

dependencies:
  logger: ^1.1.0

然后，在代码中导入库：

import 'package:logger/logger.dart';

接下来，创建 Logger 实例并设置最低日志记录级别：

final logger = Logger(
  printer: PrettyPrinter(
    methodCount: 0, // 不打印调用方法名
    errorMethodCount: 5, // error 时打印 5 层调用方法名
    lineLength: 120, // 每行最长 120 字符
    colors: true, // 启用彩色打印
    printEmojis: true, // 启用表情符号
  ),
);

logger 支持为不同日志记录级别设置颜色。以下是示例代码：

logger.d('调试信息', color: Colors.blue); // 蓝色调试信息
logger.i('信息消息', color: Colors.green); // 绿色信息消息
logger.w('警告信息', color: Colors.yellow); // 黄色警告信息
logger.e('错误信息', color: Colors.red); // 红色错误信息

logger 提供了 format 方法，可以自定义日志记录输出格式。例如，可以将时间和日志记录级别包含在输出中：

logger.printer = PrefixPrinter(printer: [
  LinePrinter(colors: true),
  // 添加时间和日志记录级别
  PrettyPrinter(methodCount: 0, colors: true),
]);

以下示例演示了如何在 Flutter 小部件中使用 logger：

class MyWidget extends StatelessWidget {
  final logger = Logger();

  @override
  Widget build(BuildContext context) {
    logger.i('MyWidget 已构建');
    // ...
  }
}