Flutter日志记录插件proctologger的使用

Flutter日志记录插件proctologger的使用

欢迎来到Proctologger，这是一个帮助你在Flutter应用中进行深度调试的日志记录插件。我们保证，你的调试体验将会比去看医生还要愉快！

欢迎使用

展示一些爱心并给仓库点个星来支持我们的项目吧！

资源

• Pub包：proctologger
• GitHub仓库：proctologger

开始使用

请按照以下步骤操作：

添加依赖

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

dependencies:
  proctologger: ^1.1.0

简单易用

创建一个Logger实例并开始记录日志：

import 'package:proctologger/proctologger.dart';

Logger logger = Logger();

logger.info("这是信息消息");

输出

文档

选项

在创建Logger时，你可以传递一些选项：

Logger logger = Logger(
    parameters: const LoggerParameters(
        // 控制台宽度。
        maxLength: 54, 
        // 更改日期格式。
        dateFormat: "HH:mm:ss:SSS", 
        // 在控制台显示日志。
        showLog: true, 
        // 在控制台显示初始化消息。
        showInitMessage: true, 
        // 过滤日志类型。
        filterTypes: [], 
        // 过滤日志标签。
        filterTags: []
    )
);

日志类型

你可以调用以下日志类型：

logger.info("这是信息消息");

logger.warning("这是警告消息");

logger.error("这是错误消息");

logger.database("这是数据库消息");

logger.action("这是动作消息");

logger.debug("这是调试消息");

日志定制化

除了logger.debug()之外，所有日志都可以传递可选参数。例如，你可以调用logger.info()并传递可选参数：

logger.info(
  "这是信息消息",
  // 可选参数，你可以选择通道（app / security / request）。
  channel: LoggerChannelState.app,
  // 可选参数，你可以输入标签。
  tags: ["标签", "另一个标签"]
);

这将产生以下效果：

当你调用logger.debug()时，你也可以传递可选参数。你可以直接调试String、int、num、Map、List和类对象。例如，我正在调试logger.parameters变量：

logger.debug(
  logger.parameters,
  // 可选参数，你可以选择通道（app / security / request）。
  channel: LoggerChannelState.app,
  // 可选参数，你可以选择一条消息。
  message: "调试变量 @parameters",
);

这将产生以下效果：

过滤器

logger.parameters中的filterTypes决定哪些日志类型应该显示或不显示。默认情况下，所有日志都会显示。例如，我只想显示info和debug日志：

Logger logger = Logger(
    parameters: const LoggerParameters(
        filterTypes: [LoggerTypeState.info, LoggerTypeState.debug], 
    )
);

logger.parameters中的filterTags决定哪些日志标签应该显示或不显示。默认情况下，所有日志都会显示。你可以结合此参数与filterTypes以实现更精确的过滤。例如，我只想显示具有以下标签的日志：

Logger logger = Logger(
    parameters: const LoggerParameters(
        filterTags: ["我想要的标签"], 
    )
);

许可证

该项目受MIT许可证保护，详情请参阅文件LICENSE.md。

完整示例Demo

以下是完整的示例代码，展示了如何使用proctologger插件：

import 'package:proctologger/logic/states/state_channel.dart';
import 'package:proctologger/proctologger.dart';

// 你可以使用一个辅助函数在整个应用程序中仅初始化一次日志记录器，并应用日志记录器的参数。
class LoggerHelper {
  static final LoggerHelper _singleton = LoggerHelper._internal();
  final Logger logger = Logger(); // 这里，你可以应用自定义参数。

  factory LoggerHelper() {
    return _singleton;
  }

  LoggerHelper._internal();
}

void main() {
  demo();
}

void demo() {
  LoggerHelper().logger.info(
    "这是信息消息",
  );
  LoggerHelper().logger.info(
    "这里是一个非常长的信息消息，用于演示多行处理和标签",
  );
  LoggerHelper().logger.warning(
    "这是警告消息",
  );
  LoggerHelper().logger.action(
    "这是动作消息",
  );
  LoggerHelper().logger.database(
    "这是数据库消息",
  );
  LoggerHelper().logger.error(
    "这是错误消息",
  );
  LoggerHelper().logger.debug("这是要调试的变量");
  LoggerHelper().logger.info(
    "这是信息消息",
    channel: LoggerChannelState.app,
    tags: ["标签", "另一个标签"]
  );
  LoggerHelper().logger.debug(
    LoggerHelper().logger.parameters,
    channel: LoggerChannelState.app,
    message: "调试变量 @parameters",
  );
}