Flutter日志跟踪插件trackit_console的使用

Flutter日志跟踪插件trackit_console的使用

完整的文档可以在 GitHub 上查看。

Trackit Console模块

允许你输出日志如下：

或者如下：

Trackit 是一个轻量级且可模块化的Dart和Flutter日志系统。Trackit具有模块化结构，可以避免未使用的功能。

trackit_console 模块用于格式化并输出日志事件到控制台。由于其格式化系统，它允许你灵活地自定义事件在控制台上的输出。使用诸如 ansicolor 的包，你可以为控制台添加颜色。

此外，你可以单独使用格式化器，例如，在将其发送到日志收集系统之前或在应用程序中显示时进行格式化。

如何使用

import 'package:trackit/trackit.dart';
import 'package:trackit_console/trackit_console.dart';

void main() {
  Trackit().listen(TrackitConsole(
    formatter: TrackitPatternFormater(),
  ).onData);

  final log = Trackit.create('MAIN');

  log.info('Hello world!');
  log.info('Log info message');
  log.info('Multiline\nlog\nmessage');

  log.debug('Debug message');
  try {
    throw Exception('Test Error exception message');
  } catch (exception, stackTrace) {
    log.error('catch error exception', exception, stackTrace);
  }
  try {
    throw Exception('Test Fatal exception message');
  } catch (exception, stackTrace) {
    log.fatal('catch fatal exception', exception, stackTrace);
  }
}

格式化器

TrackitJsonFormatter

将日志事件转换为可以发送到日志收集系统的 Map<String, dynamic>。

TrackitSimpleFormatter

用于最小化地将日志事件转换为字符串，如下所示：

[info] 2024-11-19T13:20:52.488727 {MAIN} Log info message

它有两个配置参数：

• bool withException - 指定是否显示存在的错误信息（默认为 true）
• bool withStackTrace - 指定是否显示存在的堆栈跟踪信息（默认为 true）

TrackitPatternFormater

根据模板格式化日志输出。这是一个相当灵活的格式化器，允许你灵活地自定义事件字符串，通过添加或排除参数，每个参数都可以指定转换为字符串的方法。

模板在 template 参数中指定，是一个带有替换器的字符串，这些替换器将被当前的日志事件值替换。模板替换器可以取以下值：

此外，你可以指定如何形成日志事件字段的字符串值。为此，使用 stringify 参数。传递一个形成 LogEventString 对象的函数，该对象包含字段的字符串值。此参数可用于向输出添加颜色并格式化输出。以下是一个使用示例：

import 'package:trackit/trackit.dart';
import 'package:trackit_console/trackit_console.dart';

LogEventString stringifyEvent(LogEvent event) {
  String color() => switch (event.level) {
    LogLevelTrace() => '37m',
    LogLevelDebug() => '34m',
    LogLevelInfo() => '32m',
    LogLevelWarn() => '33m',
    LogLevelError() => '31m',
    LogLevelFatal() => '31m',
  };
  
  return LogEventString(
    level: '\x1B[${color()}${event.level.name.toUpperCase().substring(0, 1)}\x1B[0m',
    title: event.title.toUpperCase(),
    time: (event.time.millisecondsSinceEpoch ~/ 1000).toString(),
    message: event.message?.toString() ?? '',
  );
}

void main(){
  Trackit().listen(TrackitConsole(
    formatter: TrackitPatternFormater(
      pattern: '[{L}] <{D}> ({T}): {M}\n{E}\n{S}',
      stringify: stringifyEvent,
    ),
  ).onData);

  final log = Trackit.create('MAIN');
  log.info('Hello world!');
  log.debug('Debug message');

  try {
    throw Exception('Test Fatal exception message');
  } catch (exception, stackTrace) {
    log.fatal('catch fatal exception', exception, stackTrace);
  }
}

此外，使用 post 参数，你可以对生成的字符串进行后处理。例如，为其添加颜色或边框。以下是一个使用示例：

import 'package:trackit/trackit.dart';
import 'package:trackit_console/trackit_console.dart';

String color(LogEvent event) => switch (event.level) {
  LogLevelTrace() => '37m',
  LogLevelDebug() => '34m',
  LogLevelInfo() => '32m',
  LogLevelWarn() => '33m',
  LogLevelError() => '31m',
  LogLevelFatal() => '31m',
};

void main(){
  Trackit().listen(TrackitConsole(
    formatter: TrackitPatternFormater(
      pattern: '[{L}] <{D}> ({T}): {M}\n{E}\n{S}',
      post: (event, value) => [
        '\x1B[${color(event)}┌──────────────────────────────────────────────────────────────────\x1B[0m',
        ...value.split('\n').map((str) => '\x1B[${color(event)}│ $str\x1B[0m'),
        '\x1B[${color(event)}└──────────────────────────────────────────────────────────────────\x1B[0m',
      ].join('\n'),
    ),
  ).onData);

  final log = Trackit.create('MAIN');
  log.info('Hello world!');
  log.debug('Debug message');

  try {
    throw Exception('Test Fatal exception message');
  } catch (exception, stackTrace) {
    log.fatal('catch fatal exception', exception, stackTrace);
  }
}