Flutter网络请求日志记录插件dart_frog_request_logger的使用 🪵

dart_frog_request_logger 是一个用于 Dart Frog 的中间件，旨在帮助开发者记录和管理网络请求的日志。该插件支持多种日志格式，并且可以与 Google Cloud Logging 集成。

特性 ✨

• 🎯🐸 与 Dart Frog 兼容。
• ☁️ 支持控制台日志和 Google Cloud Logging。
• 📋 包含丰富的调试信息，包括堆栈跟踪。
• 🧪 100% 代码覆盖率，通过 Very Good Workflows 验证。

快速开始 🚀

以下是一个简化的示例，完整示例请访问 GitHub 示例。

设置 🏗️

在你的顶级 _middleware.dart 文件中添加 RequestLogger 中间件：

import 'package:dart_frog/dart_frog.dart';
import 'package:dart_frog_request_logger/dart_frog_request_logger.dart';
import 'package:request_logger/log_formatters.dart';

Handler middleware(Handler handler) {
  return handler.use(
    provider<RequestLogger>(
      (context) => RequestLogger(
        headers: context.request.headers,
        logFormatter: formatSimpleLog(),
      ),
    ),
  );
}

记录日志 📝

从 RequestContext 中读取 RequestLogger 并记录日志：

import 'package:dart_frog/dart_frog.dart';
import 'package:dart_frog_request_logger/dart_frog_request_logger.dart';

Response onRequest(RequestContext context) {
  final logger = context.read<RequestLogger>();
  logger.debug('Hello Logs');
  return Response();
}

使用不同的日志格式

你可以通过提供不同的 LogFormatter 来改变日志格式。你可以选择内置格式或自定义格式。

内置格式

所有内置的日志格式都在 package:request_logger/log_formatters.dart 中。

目前提供的内置格式有：

• formatSimpleLog(): 简单格式化日志，适合本地开发。
• formatCloudLoggingLog(): 格式化日志以兼容 Google Cloud Logging。

自定义格式

你也可以创建自己的格式器：

LogFormatter formatMyCustomLog() => ({
      required Severity severity,
      required String message,
      required Request request,
      Map<String, dynamic>? payload,
      Map<String, dynamic>? labels,
      bool? isError,
      Chain? chain,
      Frame? stackFrame,
    }) {
      return 'My custom log: $message';
    };

完整示例 Demo

以下是一个完整的示例应用程序，展示如何使用 RequestLogger：

// _middleware.dart
import 'package:dart_frog/dart_frog.dart';
import 'package:dart_frog_request_logger/dart_frog_request_logger.dart';
import 'package:request_logger/log_formatters.dart';

Handler middleware(Handler handler) {
  return handler.use(
    provider<RequestLogger>(
      (context) => RequestLogger(
        headers: context.request.headers,
        logFormatter: formatSimpleLog(),
      ),
    ),
  );
}

// main.dart
import 'package:dart_frog/dart_frog.dart';
import 'package:dart_frog_request_logger/dart_frog_request_logger.dart';

Future<Response> onRequest(RequestContext context) async {
  final logger = context.read<RequestLogger>();
  
  // 记录一条调试信息
  logger.debug('This is a debug message.');
  
  // 记录一条错误信息
  try {
    throw Exception('An error occurred!');
  } catch (e, stackTrace) {
    logger.error('Error occurred', error: e, stackTrace: stackTrace);
  }

  return Response(body: 'Check your logs!');
}

通过上述步骤，你可以在 Dart Frog 应用程序中轻松集成并使用 dart_frog_request_logger 插件来记录和管理网络请求日志。

这个 Markdown 文档详细介绍了如何在 Dart Frog 项目中使用 `dart_frog_request_logger` 插件，并提供了完整的示例代码以供参考。