Flutter日志管理插件echo_logger的使用

Flutter日志管理插件echo_logger的使用

Echo Logger 是一个为 Flutter 设计的强大且灵活的日志工具，它允许开发者使用自定义标签、颜色和严重性级别记录消息。通过提供高度可定制的日志体验，它使调试和监控变得更加容易。

目录

• 安装
• 使用
  • 基本用法
  • 自定义标签
  • 每个日志级别的自定义颜色
  • 日志级别
• 特性
• 截图
  • 可用的ANSI颜色代码

安装

在 pubspec.yaml 文件中添加 echo_logger 依赖：

dependencies:
  echo_logger: ^0.0.5

然后运行：

flutter pub get

使用

基本用法

导入包并开始记录日志：

import 'package:echo_logger/echo_logger.dart';

void main() {
  final echo = Echo(
    level: LogLevel.all,
    formatter: LogFormatter(
      errorColors: ANSIColors.red,
      debugColors: ANSIColors.green,
      infoColors: ANSIColors.blue,
      warningColors: ANSIColors.yellow,
    ),
  );

  echo.d('这是调试信息');
  echo.i('这是信息消息');
  echo.w('这是警告信息');
  echo.e('这是错误信息');
}

自定义标签

覆盖默认标签（Echo）以使用自己的自定义标签：

echo.d('带有自定义标签的调试信息', name: 'MyTag');

每个日志级别的自定义颜色

通过传递带有预定义或自定义 ANSIColor 实例的 LogFormatter 到 Echo 构造函数，可以为每个日志级别自定义颜色：

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

void main() {
  runApp(const MainApp());
}

// 创建一个具有每个日志级别自定义颜色的Echo实例
final echo = Echo(
  level: LogLevel.all,
  formatter: LogFormatter(
    errorColors: ANSIColors.red,       // 错误日志的自定义颜色
    debugColors: ANSIColors.green,     // 调试日志的自定义颜色
    infoColors: ANSIColors.blue,       // 信息日志的自定义颜色
    warningColors: ANSIColors.yellow,  // 警告日志的自定义颜色
  ),
);

class MainApp extends StatelessWidget {
  const MainApp({super.key});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        floatingActionButton: FloatingActionButton(
          onPressed: () {
            try {
              List<Duck> a = [
                Duck(name: 'Donald', age: 3),
                Duck(name: 'Daisy', age: 2)
              ];

              Map<String, Duck> b = {
                'Donald': Duck(name: 'Donald', age: 3),
                'Daisy': Duck(name: 'Daisy', age: 2)
              };

              Set<Duck> c = {
                Duck(name: 'Donald', age: 3),
                Duck(name: 'Daisy', age: 2)
              };

              echo.d(a.toString()); // 具有自定义颜色的调试日志
              echo.i(b.toString()); // 具有自定义颜色的信息日志
              echo.w(c.toString()); // 具有自定义颜色的警告日志

              echo.d('这是具有新行的自定义标签消息\n',
                  tag: "Repository");

              echo.d('这是具有新行的自定义标签消息\n',
                  tag: "Auth Bloc");

              echo.d('这是具有新行的自定义标签消息\n',
                  tag: "Database");

              throw Exception('这是一个异常');
            } catch (e, s) {
              echo.e(
                '这是一个错误消息',
                error: e,
                stackTrace: s,
              );
            }
          },
          child: Icon(Icons.send),
        ),
        body: Center(
          child: Text('Hello World!'),
        ),
      ),
    );
  }
}

class Duck {
  final String name;
  final int age;

  Duck({required this.name, required this.age});

  @override
  String toString() {
    return 'Duck{name: $name, age: $age}';
  }
}

日志级别

根据严重性级别过滤日志：

Echo(
  level: LogLevel.debug, // 只显示级别 >= debug 的日志
).log('这是一个调试日志', level: LogLevel.debug);

可用的日志级别：

• LogLevel.all （显示所有日志）
• LogLevel.debug
• LogLevel.info
• LogLevel.warning
• LogLevel.error
• LogLevel.none （禁用所有日志）

特性

• 自定义标签： 覆盖默认标签。
• 自定义颜色： 为每个日志级别设置完全自定义的颜色。
• 日志级别： 根据严重性过滤日志。
• ANSI 颜色： 在终端中使用彩色日志提高可读性。
• 平台兼容性： 支持所有 Flutter 支持的平台（Android、iOS、Web、Windows、macOS、Linux）。

截图

可用的ANSI颜色代码

你可以使用以下预定义的 ANSIColor 常量或创建自己的颜色：

abstract class ANSIColors {
  static const black = ANSIColor(foreground: 30, background: 40);
  static const red = ANSIColor(foreground: 31, background: 41);
  static const green = ANSIColor(foreground: 32, background: 42);
  static const yellow = ANSIColor(foreground: 33, background: 43);
  static const blue = ANSIColor(foreground: 34, background: 44);
  static const magenta = ANSIColor(foreground: 35, background: 45);
  static const cyan = ANSIColor(foreground: 36, background: 46);
  static const white = ANSIColor(foreground: 37, background: 47);
  static const brightBlack = ANSIColor(foreground: 90, background: 100);
  static const brightRed = ANSIColor(foreground: 91, background: 101);
  static const brightGreen = ANSIColor(foreground: 92, background: 102);
  static const brightYellow = ANSIColor(foreground: 93, background: 103);
  static const brightBlue = ANSIColor(foreground: 94, background: 104);
  static const brightMagenta = ANSIColor(foreground: 95, background: 105);
  static const brightCyan = ANSIColor(foreground: 96, background: 106);
  static const brightWhite = ANSIColor(foreground: 97, background: 107);
}