Flutter日志记录插件hybrid_logger的使用

Flutter日志记录插件hybrid_logger的使用

Hybrid Logger

这是一个有用的包，提供了开发时的日志工具。它允许你选择不同的日志设计或类型，并轻松跟踪HTTP调用、堆栈跟踪等。

包提供的功能

这些功能可以分为三大类：通用日志功能、堆栈跟踪日志 和 HTTP日志。

通用日志

• critical(dynamic msg, {String? header})
• error(dynamic msg, {String? header})
• warning(dynamic msg, {String? header})
• debug(dynamic msg, {String? header})
• info(dynamic msg, {String? header})
• success(dynamic msg, {String? header})

这些类型的日志会在被调用时显示出来。header 是可选的，如果未设置，则不会显示。每种日志的样式依赖于库定义的颜色，但可以通过配置 Hybrid Settings Class 进行覆盖。

堆栈跟踪

• stackTrx(StackTrace stack, {String? header}): 要使用它，只需在函数或方法中调用它并传入 StackTrace.current。这样做后，每次调用该方法时，都会有一个包含其名称和所在文件的日志。

HTTP日志

• httpRequest(HybridHttpRequest request): 需要一个 HybridHttpRequest 对象，该对象将包含已记录请求的状态码、数据、查询参数等。
• httpResponse(HybridHttpResponse response): 需要一个 HybridHttpResponse 对象来记录响应数据。
• httpError(HybridHttpError httpError): 需要一个 HybridHttpError 对象来记录HTTP请求被拒绝或无法执行时的错误数据。

使用包

要使用此包，只需将其导入到 pubspec.yaml 文件中，配置一个 HybridLogger 实例，并使用其方法执行不同类型的日志记录。

创建和配置HybridLogger

import 'package:hybrid_logger/hybrid_logger.dart';

final logger = HybridLogger(
    settings: HybridSettings(
        // 参数以自定义日志使用的颜色
        colors: {
            LogTypeEntity.debug: AnsiPen.green()
        },

        // 默认日志类型
        type: LogTypeEntity.info,

        // 分隔符
        lineSymbol: '-',

        // 每行最大字符数
        maxLineWidth: 60,

        // 是否显示分隔符
        showLines: true,

        // 是否隐藏或显示定义的头或每个日志的标题
        showHeaders: true,

        // 如果需要，是否使用Dart SDK打印
        forceLogs: false,
    ),

    // 抽象类以定义日志在控制台上如何显示，默认实现为 "LineStyleLogger"
    formatter: const LineStyleLogger(),

    // 可选抽象类以定义何时显示日志
    filter: LogTypeFilter()
);

使用HybridLogger对象，在需要记录日志的地方调用方法

void main() async {
    await apiCallMethod();
    stackTraceMethod();
    debugMethod();
}

// HTTP日志将需要在API调用期间获取的参数，
// 如果它们未设置，记录器将默认显示null字段
Future<void> apiCallMethod() async {
    logger.httpRequest(
        const HybridHttpRequest(
            path: "/hello",
            method: "GET",
            baseUrl: "https://fakeapi/api",
            data: {},
            queryParameters: {},
            headers: {},
        ),
    );
    logger.httpResponse(
        const HybridHttpResponse(
            statusCode: "200",
            data: {"message": "Hello World!"}
        ),
    );
    logger.httpError(
        const HybridHttpError(
            path: 'Test/text/v2', 
            statusCode: '500',
        )
    );
}

void stackTraceMethod() {
    logger.stackTrx(StackTrace.current);
}

void debugMethod() {
    logger.info("This is a log", header: "Debug Method");
}