Flutter日志记录插件logger_fork的使用

Flutter日志记录插件logger_fork的使用

这是一个用于支持Flutter版本的logger_fork插件的fork版本

这是一个小巧、易于使用且可扩展的日志记录器，可以打印美观的日志。该插件受到Android平台上的logger插件启发。

请支持项目并给仓库点赞！

资源

• 文档
• Pub包
• GitHub仓库

入门指南

只需创建一个Logger实例并开始记录：

var logger = Logger();

logger.d("Logger is working!");

除了字符串消息，你还可以传递其他对象，如List、Map或Set。

输出

文档

日志级别

你可以使用不同的日志级别进行记录：

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");

要仅显示特定的日志级别，可以设置：

Logger.level = Level.warning;

这将隐藏所有verbose、debug和info级别的日志事件。

选项

在创建日志记录器时，你可以传递一些选项：

var logger = Logger(
  filter: null, // 使用默认的LogFilter（仅在调试模式下记录）
  printer: PrettyPrinter(), // 使用PrettyPrinter格式化并打印日志
  output: null, // 使用默认的LogOutput（发送到控制台）
);

如果你使用PrettyPrinter，则可以有更多选项：

var logger = Logger(
  printer: PrettyPrinter(
    methodCount: 2, // 显示的方法调用数量
    errorMethodCount: 8, // 如果提供堆栈跟踪，则显示的方法调用数量
    lineLength: 120, // 输出宽度
    colors: true, // 彩色日志消息
    printEmojis: true, // 打印每个日志消息的emoji
    printTime: false // 每个日志是否包含时间戳
  ),
);

自动检测

通过io包可以自动检测lineLength和colors参数。 假设你已经导入了io包（import 'dart:io' as io;），你可以通过io.stdout.supportsAnsiEscapes来自动检测colors，并通过io.stdout.terminalColumns来自动检测lineLength。

除非有特殊原因不希望导入io包（例如在Web平台上使用此库），否则你应该这样做。

日志过滤器

LogFilter决定哪些日志事件应该被显示，哪些不应该显示。 默认实现（DevelopmentFilter）在调试模式下显示所有日志，条件是level >= Logger.level。而在发布模式下，所有日志都会被忽略。

你可以创建自己的LogFilter，例如：

class MyFilter extends LogFilter {
  @override
  bool shouldLog(LogEvent event) {
    return true;
  }
}

这将显示所有日志，即使在发布模式下。（这不是一个好的做法）

日志打印机

LogPrinter创建并格式化输出，然后将其发送到LogOutput。 你可以实现自己的LogPrinter，以获得最大的灵活性。

一个非常基础的打印机可能如下所示：

class MyPrinter extends LogPrinter {
  @override
  List<String> log(LogEvent event) {
    return [event.message];
  }
}

如果你创建了一个很酷的LogPrinter，并且觉得它对其他人也有帮助，请随时提交拉取请求。：）

颜色

请注意，所有IDE（如VSCode、XCode、Android Studio、IntelliJ）都不支持终端输出中的ANSI转义序列。这些转义序列用于为输出着色。如果你使用这样的IDE，不要配置彩色输出。

然而，如果你正在使用JetBrains IDE（如Android Studio、IntelliJ等），你可以利用Grep Console插件和PrefixPrinter装饰器来实现任何日志的彩色输出：

var logger = Logger(
  printer: PrefixPrinter(PrettyPrinter(colors: false))
);

日志输出

LogOutput将日志行发送到所需的输出目的地。 默认实现（ConsoleOutput）将每一行发送到系统控制台。

class ConsoleOutput extends LogOutput {
  @override
  void output(OutputEvent event) {
    for (final line in event.lines) {
      print(line);
    }
  }
}

未来可能的LogOutput可以发送到文件、Firebase或Logcat。请随时提交拉取请求。

logger_flutter扩展

logger_flutter插件是logger的扩展，你可以将其添加到任何Flutter应用中。只需摇晃手机即可显示控制台。

MIT许可证

Copyright (c) 2019 Simon Leier

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

示例代码

import 'package:logger_fork/logger_fork.dart';

var logger = Logger(
  printer: PrettyPrinter(),
);

var loggerNoStack = Logger(
  printer: PrettyPrinter(methodCount: 0),
);

void main() {
  print('Run with either `dart example/main.dart` or `dart --enable-asserts example/main.dart`.');
  demo();
}

void demo() {
  logger.d('Log message with 2 methods');

  loggerNoStack.i('Info message');

  loggerNoStack.w('Just a warning!');

  logger.e('Error! Something bad happened', 'Test Error');

  loggerNoStack.v({'key': 5, 'value': 'something'});

  Logger(printer: SimplePrinter(colors: true)).v('boom');
}