Flutter日志管理插件log_plus的使用

log_plus 是一个轻量且功能丰富的日志记录包，适用于Dart和Flutter项目。它完全用纯Dart编写，没有任何外部依赖。

主要特性

• 多级别日志记录：支持定义不同的日志级别以分类消息。
• 格式化控制台日志：以结构化和可读的格式打印日志，并带有颜色编码的日志级别。
• 选择性输出：基于日志级别控制控制台输出，简化调试工作流程。
• 内存日志存储：在内存中存储日志以便后续分析和故障排除。
• 增强调试：可选地包含并打印堆栈跟踪信息，以加速调试过程。

快速开始

1. 安装插件
2. 导入插件
3. 创建 Logs 的新实例并开始记录日志。在整个应用程序中使用相同的实例以维护单一的日志历史记录。

示例代码

基础使用

import 'package:log_plus/log_plus.dart';

void main() {
  final log = Logs();
  log.v('This is a verbose message');
  log.d('This is a debug message');
  log.i('This is an info message');
  log.w('This is a warning message');
  log.e('This is an error message', includeStackTrace: true); // 可选地包含堆栈跟踪
}

自定义配置

import 'package:log_plus/log_plus.dart';

void main() {
  final log = Logs(
    storeLogLevel: LogLevel.warning, // 存储警告级别及以上的日志
    printLogLevelWhenDebug: LogLevel.verbose, // 在调试模式下打印所有级别的日志
    printLogLevelWhenRelease: LogLevel.error, // 在发布模式下仅打印错误级别的日志
    storeLimit: 500, // 在内存中最多存储500条日志
  );

  log.v('This is a verbose message'); // 在调试模式下打印，但不存储
  log.d('This is a debug message'); // 在调试模式下打印，但不存储
  log.i('This is an info message'); // 在调试模式下打印，但不存储
  log.w('This is a warning message', includeStackTrace: true); // 可选地包含堆栈跟踪
  log.e('This is an error message', includeStackTrace: true); // 可选地包含堆栈跟踪
}

更多示例

以下是一个完整的示例demo，展示了如何快速启动、自定义设置以及如何在发布模式下隐藏日志：

import 'package:log_plus/log_plus.dart';

void main() {
  print('Run with either `dart example/main.dart` or `dart --enable-asserts example/main.dart`.');
  quickStartDemo(); // 快速启动演示，无需自定义设置
  customiseDemo(); // 所有自定义选项的示例
  hideLogsInRelease(); // 发布模式下隐藏日志的示例
}

void quickStartDemo() {
  Logs log = Logs();
  log.v('This is a verbose log');
  log.d('This is a debug log');
  log.i('This is an info log');
  log.w('This is a warning log');
  log.e('This is an error log', includeTrace: true);
}

void customiseDemo() {
  Logs log = Logs(
    storeLogLevel: LogLevel.warning, // 仅存储警告和错误日志
    printLogLevelWhenDebug: LogLevel.verbose, // 调试模式下打印所有日志
    printLogLevelWhenRelease: LogLevel.error, // 发布模式下仅打印错误日志
    storeLimit: 500, // 内存中的日志历史记录限制
  );
  log.v('This is a verbose log');
  log.d('This is a debug log');
  log.i('This is an info log');
  log.w('This is a warning log');
  log.e('This is an error log', includeTrace: true);

  List<Map> logs = log.getStoredLogs(); // 获取存储的日志列表
  print(logs);
}

void hideLogsInRelease() {
  Logs log = Logs(
    printLogLevelWhenRelease: LogLevel.none, // 禁用发布模式下的日志打印
  );

  print('All logs will be shown in debug, but hidden in release mode.');

  log.v('This is a verbose log');
  log.d('This is a debug log');
  log.i('This is an info log');
  log.w('This is a warning log');
  log.e('This is an error log', includeTrace: true);
}