Flutter日志记录插件simple_dart_logger的使用

simple_dart_logger 是一个简单易用的日志记录插件，提供了多种日志记录方式，如文件日志、控制台日志等。本文将详细介绍如何在Flutter项目中使用该插件。

Features

• FileLogger：支持可选的日志轮换。
• ConsoleLogger：输出日志到控制台。
• 抽象Logger：用户可以扩展此抽象类来实现自定义的日志目标，例如Web服务或数据库。
• MultiLogger：可以同时使用多个不同类型的日志记录器。

Getting Started

首先需要在项目中引入 simple_dart_logger 插件，并配置一个全局的日志构建函数。

import 'package:simple_dart_logger/simple_dart_logger.dart';

void main() {
  Logger.builder = (className) => ConsoleLogger(
    className: className,
    logLvl: LogLvl.all,
  );
}

class SomeClass {
  late final _logger = Logger.createByObject(this);

  SomeClass();

  void someMethod() {
    _logger.trace("call to someMethod");
  }
}

Usage

配置日志记录器

在使用日志记录器之前，必须定义一个构建函数来实例化具体的日志记录器。这个函数只需要定义一次，它会被 Logger 类的工厂构造函数调用。

控制台日志记录器示例

Logger.builder = (className) => ConsoleLogger(
  className: className,
  colorized: true, // 设置为true以启用颜色输出
  colors: (
    trace: TermColor.reset,
    debug: TermColor.reset,
    info: TermColor.green,
    warning: TermColor.yellow,
    error: TermColor.red,
  ),
);

文件日志记录器示例

如果要在移动项目（如Android/iOS）中使用 FileLogger，建议使用 path_provider 包获取可用的目录。

import "package:path_provider/path_provider.dart";

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  final dir = await getApplicationDocumentsDirectory();

  Logger.builder = (className) => FileLogger(
    directory: dir,
    fileName: "log_file",
    maxSize: KBytes(500),
    backups: 2,
    logLvl: LogLvl.all ^ LogLvl.trace,
    className: className,
  );
}

多日志记录器示例

可以使用 MultiLogger 将日志记录到多个目标。

Logger.builder = (className) => MultiLogger(
  className: className,
  logLvl: LogLvl.all,
  loggers: [
    ConsoleLogger.multi(),
    FileLogger.multi(
      directory: Directory("log/"),
      fileName: "simple_log",
      maxSize: const MBytes(500),
      backups: 5,
    ),
  ],
);

自定义日志格式

可以通过设置 Logger.formatter 来更改日志消息的格式。

Logger.formatter =
    (timestamp, logLvl, className, msg) => "[$logLvl] ($className) {$msg}";

日志记录器实例化

有两种工厂构造函数可用于实例化日志记录器实例：

1. 使用字符串作为类名：

class SomeClass {
  final _logger = Logger.create("SomeClass");
}

1. 使用对象的运行时类型作为类名：

class SomeClass {
  late final _logger = Logger.createByObject(this);
}

创建自定义日志记录器

如果需要创建自己的日志记录器，只需继承抽象类 Logger 并实现 log 方法。

final class DebugPrintLogger extends Logger {
  DebugPrintLogger({
    super.logLvl,
    required super.className,
  });

  [@override](/user/override)
  void log(String msg) {
    debugPrint(msg);
  }
}

void main() {
  Logger.builder = (className) => DebugPrintLogger(
    logLvl: LogLvl.all,
    className: className,
  );
  final logger = Logger.create("SomeName");    
  logger.debug("some message");
}

完整示例代码

以下是一个完整的示例代码，展示了如何配置和使用 simple_dart_logger：

import 'dart:io';
import 'package:simple_dart_logger/simple_dart_logger.dart';
import 'package:path_provider/path_provider.dart';

///////////////////////////////////////////////////////
// Simple example of how to configure a FileLogger
///////////////////////////////////////////////////////

void showConfigFileLogger() {
  Logger.builder = (className) => FileLogger(
    directory: Directory("log/"),
    fileName: "log_file",
    maxSize: KiBytes(500),
    backups: 2,
    logLvl: LogLvl.info | LogLvl.error | LogLvl.warning,
    className: className,
  );
}

///////////////////////////////////////////////////////
// How to get a logger instance and log something.
///////////////////////////////////////////////////////

void logSomething() {
  final logger = Logger.create("Some ClassName");
  logger.trace("some message");
}

///////////////////////////////////////////////////////
// How to create your own logger
///////////////////////////////////////////////////////

final class PrintLogger extends Logger {
  PrintLogger({
    super.logLvl,
    required super.className,
  });

  [@override](/user/override)
  void log(String msg) {
    print(msg);
  }
}

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  final dir = await getApplicationDocumentsDirectory();

  Logger.builder = (className) => FileLogger(
    directory: dir,
    fileName: "log_file",
    maxSize: KBytes(500),
    backups: 2,
    logLvl: LogLvl.all ^ LogLvl.trace,
    className: className,
  );

  final logger = Logger.create("MainClass");
  logger.info("Application started.");
}