logger_box 是一个用于 Flutter 的日志记录插件，它提供了一个简单且强大的方式来记录和管理应用程序的日志。它支持自定义日志级别、日志格式、日志过滤等功能，并且可以将日志输出到控制台、文件或其他自定义目标。

安装

首先，你需要在 pubspec.yaml 文件中添加 logger_box 依赖：

dependencies:
  flutter:
    sdk: flutter
  logger_box: ^1.0.0  # 请使用最新版本

然后运行 flutter pub get 来安装依赖。

基本使用

1. 导入包：

   import 'package:logger_box/logger_box.dart';
   

2. 初始化 LoggerBox：

   你可以通过 LoggerBox.init() 方法来初始化 LoggerBox，并配置日志级别、日志格式等。

   void main() {
     LoggerBox.init(
       level: Level.verbose,  // 设置日志级别
       printer: PrettyPrinter(),  // 设置日志打印器
     );
     runApp(MyApp());
   }
   

3. 记录日志：

   使用 LoggerBox 提供的不同方法来记录不同级别的日志：

   LoggerBox.v('Verbose log');
   LoggerBox.d('Debug log');
   LoggerBox.i('Info log');
   LoggerBox.w('Warning log');
   LoggerBox.e('Error log', error: 'Error details');
   LoggerBox.wtf('What a terrible failure log');
   

   这些方法分别对应不同的日志级别：verbose, debug, info, warning, error, wtf。

4. 自定义日志格式：

   你可以通过实现 LogPrinter 接口来自定义日志格式。PrettyPrinter 是 logger_box 提供的一个默认的日志打印器，它可以将日志格式化为易读的格式。

   class CustomPrinter implements LogPrinter {
     [@override](/user/override)
     void log(Level level, String message, {dynamic error, StackTrace? stackTrace}) {
       // 自定义日志格式
       print('[$level] $message');
     }
   }
   
   void main() {
     LoggerBox.init(
       level: Level.verbose,
       printer: CustomPrinter(),
     );
     runApp(MyApp());
   }
   

5. 日志过滤：

   你可以通过 LoggerBox.init() 方法中的 filter 参数来过滤日志。Level 类定义了不同的日志级别，你可以根据日志级别来过滤日志。

   void main() {
     LoggerBox.init(
       level: Level.info,  // 只记录info级别及以上的日志
       printer: PrettyPrinter(),
     );
     runApp(MyApp());
   }
   

6. 日志输出到文件：

   你可以通过自定义 LogPrinter 将日志输出到文件或其他目标。例如，使用 dart:io 将日志写入文件：

   import 'dart:io';
   
   class FilePrinter implements LogPrinter {
     final File file;
   
     FilePrinter(this.file);
   
     [@override](/user/override)
     void log(Level level, String message, {dynamic error, StackTrace? stackTrace}) {
       final logMessage = '[$level] $message\n';
       file.writeAsStringSync(logMessage, mode: FileMode.append);
     }
   }
   
   void main() {
     final logFile = File('app.log');
     LoggerBox.init(
       level: Level.verbose,
       printer: FilePrinter(logFile),
     );
     runApp(MyApp());
   }
   

高级功能

• 日志缓存：LoggerBox 支持日志缓存，你可以在初始化时设置 cacheSize 参数来指定缓存的大小。
• 日志输出到多个目标：你可以通过实现 LogPrinter 接口将日志输出到多个目标，例如同时输出到控制台和文件。
• 日志标签：你可以在记录日志时添加标签，以便更好地组织和过滤日志。

示例

import 'package:flutter/material.dart';
import 'package:logger_box/logger_box.dart';

void main() {
  LoggerBox.init(
    level: Level.debug,
    printer: PrettyPrinter(),
  );
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: Text('LoggerBox Example'),
        ),
        body: Center(
          child: ElevatedButton(
            onPressed: () {
              LoggerBox.d('Button pressed');
              LoggerBox.i('This is an info message');
              LoggerBox.e('An error occurred', error: 'Error details');
            },
            child: Text('Log Messages'),
          ),
        ),
      ),
    );
  }
}