Flutter日志记录工具插件paw的使用

PAW 🐾 是一个专注于可访问性和易读性的日志记录工具，同时提供了高度可定制的日志选项。以下是关于如何安装、配置和使用PAW 🐾 的详细介绍。

安装

你可以通过以下方式将PAW 🐾 添加到你的项目中：

1. 直接在pubspec.yaml中添加依赖：

   dependencies:
     paw: ^0.0.4
   

2. 通过命令行安装：

   • 对于Flutter项目：flutter pub add paw
   • 对于Dart项目：dart pub add paw

快速开始

使用Paw类

import 'package:paw/paw.dart';

void main() {
  final paw = Paw(
    title: "MyApp",
    shouldIncludeSourceFileInfo: true,
    shouldIncludeTitle: true,
    shouldPrint: true,
    stackTraceToPrint: 5,
    theme: PawDarkTheme(),
    level: null,
  );

  // Log an informational message.
  paw.info("This is an informational message");

  // Log a tracing message.
  paw.trace("This is a trace log");

  // Log a warning message.
  paw.warn("Be aware! This is a warning message");

  // Log a data object for debugging.
  paw.debug({'key': 'value', 'count': 42});

  try {
    throw UnsupportedError("Oops! You've forgotten to implement this feature");
  } catch (e, stackTrace) {
    // Log an error with a message and error object.
    paw.error('An unexpected error occurred', error: e);

    // Log a fetal log with a message, error object, and stack trace.
    paw.fetal('A very serious error occurred', stackTrace: stackTrace, error: e);
  }
}

创建自定义日志器

import 'package:paw/paw.dart';

class MyLogger extends PawInterface {
  MyLogger({
    super.name = "MyApp",
    super.maxStackTraces = 5,
    super.shouldIncludeSourceInfo = false,
    super.shouldPrintLogs = true,
    super.shouldPrintName = false,
  }) : super(currentTheme: PawDarkTheme());

  @override
  void info(String msg, {StackTrace? stackTrace}) {
    super.info(msg, stackTrace: stackTrace);
    print("Custom actions after logging info");
  }

  // Override any log level to enhance its functionality.
}

// Usage of MyLogger
final myLogger = MyLogger();
myLogger.info("This is a custom logger info message");

日志级别

PAW 🐾 提供了多种日志级别，包括：

• info: 信息性消息。
• trace: 跟踪消息。
• warn: 警告消息。
• debug: 调试数据对象。
• error: 错误消息。
• fetal: 严重错误消息。

主题

PAW 🐾 提供了两种内置主题：

• PawDarkTheme: 适用于深色模式。
• PawLightTheme: 适用于浅色模式。

自定义主题

你可以通过PawCustomTheme类来自定义日志颜色：

import 'package:paw/paw.dart';

final kCustomTheme = PawCustomTheme(
  heading: AnsiForegroundColors.black,
  message: AnsiForegroundColors.softPink,
  object: AnsiForegroundColors.gray,
  errorMessage: AnsiForegroundColors.orange,
  errorObject: AnsiForegroundColors.red,
  bgWarn: AnsiBackgroundColor.lightGray,
  bgInfo: AnsiBackgroundColor.blue,
  bgTrace: AnsiBackgroundColor.darkPink,
  bgDebug: AnsiBackgroundColor.gray,
  bgError: AnsiBackgroundColor.darkPink,
  bgFetal: AnsiBackgroundColor.brown,
  infoCardBg: AnsiBackgroundColor.custom(r: 204, g: 255, b: 153),
);

final paw = Paw(
  theme: kCustomTheme,
);

高效使用实践

使用全局实例

为了避免重复创建多个Paw实例，建议使用全局实例：

import 'package:paw/paw.dart';

final kPaw = Paw(
  title: "MyApp",
  shouldIncludeSourceFileInfo: true,
  shouldIncludeTitle: true,
  shouldPrint: true,
  stackTraceToPrint: 5,
  theme: PawDarkTheme(),
  level: null,
);

// Use kPaw throughout your application.

实现单例PawInterface

如果你更喜欢单例模式，可以这样做：

import 'package:paw/paw.dart';

class MyLogger extends PawInterface {
  MyLogger._({
    required super.name,
    required super.maxStackTraces,
    required super.shouldIncludeSourceInfo,
    required super.shouldPrintLogs,
    required super.shouldPrintName,
    required super.theme,
    required super.level,
  });

  static MyLogger? _instance;

  factory MyLogger() {
    _instance ??= MyLogger._(
      name: "MyApp",
      maxStackTraces: 5,
      shouldIncludeSourceInfo: true,
      shouldPrintLogs: true,
      shouldPrintName: true,
      theme: PawDarkTheme(),
      level: null,
    );
    return _instance!;
  }

  @override
  void info(String msg, {StackTrace? stackTrace}) {
    super.info(msg, stackTrace: stackTrace);
    print("Custom actions after logging info");
  }
}

// Usage of MyLogger singleton
final myLogger = MyLogger();
myLogger.info("This is a custom logger info message");