Flutter日志记录插件thin_logger的使用

thin_logger 是一个轻量级的日志记录插件，适用于 Flutter 应用程序。它提供了简单的 API 来记录不同级别的日志，并且可以自定义日志的输出格式和输出位置。以下是如何在 Flutter 项目中使用 thin_logger 的基本步骤。

1. 添加依赖

首先，在 pubspec.yaml 文件中添加 thin_logger 依赖：

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

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

2. 初始化 Logger

在应用程序的入口文件（通常是 main.dart）中初始化 thin_logger：

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

void main() {
  // 初始化 Logger
  Logger.init(
    level: Level.ALL,  // 设置日志级别
    printer: PrettyPrinter(),  // 使用 PrettyPrinter 输出日志
  );

  runApp(MyApp());
}

3. 使用 Logger

在应用程序的任何地方，你可以使用 Logger 来记录日志：

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

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    // 记录不同级别的日志
    Logger.v("Verbose log");
    Logger.d("Debug log");
    Logger.i("Info log");
    Logger.w("Warning log");
    Logger.e("Error log");
    Logger.wtf("What a Terrible Failure log");

    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(),
    );
  }
}

class MyHomePage extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Flutter Demo Home Page'),
      ),
      body: Center(
        child: Text('Hello, World!'),
      ),
    );
  }
}

4. 日志级别

thin_logger 支持以下几种日志级别：

• Level.VERBOSE: 用于记录详细的日志信息。
• Level.DEBUG: 用于调试信息。
• Level.INFO: 用于记录一般的信息。
• Level.WARNING: 用于记录警告信息。
• Level.ERROR: 用于记录错误信息。
• Level.WTF: 用于记录严重的错误信息。

你可以在初始化 Logger 时设置日志级别，只有高于或等于该级别的日志才会被记录。

5. 自定义 Printer

thin_logger 允许你自定义日志的输出格式。你可以实现自己的 Printer 类，或者使用内置的 PrettyPrinter 和 SimplePrinter。

例如，使用 SimplePrinter：

Logger.init(
  level: Level.ALL,
  printer: SimplePrinter(),  // 使用 SimplePrinter 输出日志
);

6. 日志输出到文件

如果你想将日志输出到文件中，你可以实现自己的 LogOutput 类，并将其传递给 Logger.init 方法。

class FileOutput extends LogOutput {
  [@override](/user/override)
  void output(OutputEvent event) {
    // 将日志写入文件
    // 例如，使用 dart:io 的 File 类
  }
}

void main() {
  Logger.init(
    level: Level.ALL,
    printer: PrettyPrinter(),
    output: FileOutput(),  // 使用自定义的 FileOutput
  );

  runApp(MyApp());
}

7. 日志过滤

你还可以通过实现 LogFilter 类来过滤日志。例如，只记录包含特定关键字的日志：

class KeywordFilter extends LogFilter {
  final String keyword;

  KeywordFilter(this.keyword);

  [@override](/user/override)
  bool shouldLog(LogEvent event) {
    return event.message.contains(keyword);
  }
}

void main() {
  Logger.init(
    level: Level.ALL,
    printer: PrettyPrinter(),
    filter: KeywordFilter('important'),  // 只记录包含 'important' 的日志
  );

  runApp(MyApp());
}