Flutter网络请求格式化插件dio_http_formatter的使用

简介

dio_http_formatter 是一个简单的 Dio 拦截器，用于在控制台中以漂亮的格式打印 HTTP 请求和响应，以便更容易调试和分享。它支持多种内容类型的漂亮打印，如 application/json、application/x-www-form-urlencoded 和 text/html。

快速开始

安装包

1. 在您的项目中安装 dio_http_formatter：

   flutter pub get dio_http_formatter
   

   或者如果不是Flutter项目：

   pub get dio_http_formatter
   

添加拦截器

1. 将拦截器添加到您的 Dio 实例中：

   final _dio = Dio();
   _dio.interceptors.add(HttpFormatter());
   

Dio 版本映射表

根据您使用的 Dio 版本，选择相应的 dio_http_formatter 版本：

配置选项

以下是可选参数，用于自定义要打印的内容以及如何打印 HTTP 请求和响应：

日志过滤器

HttpFormatter 支持通过 loggingFilter 来过滤是否记录请求/响应。例如，不记录返回状态码为 201 的请求/响应：

final dio = Dio();
dio.interceptors.add(
  HttpFormatter(
    loggingFilter: (request, response, error) {
      if (response?.statusCode == 201) {
        return false;
      }
      return true;
    },
  ),
);

警告：httpLoggerFilter 已被弃用，请迁移到新的 loggingFilter。httpLoggerFilter 将在下一个主要版本中移除。

示例代码

POST 请求 [application/json]

await _dio.post(
  'https://postman-echo.com/post',
  data: {'foo': 'foo'},
  options: Options()
    ..headers = {
      'my-custom-header': 'my-custom-header',
      'content-type': 'application/json'
    },
);

POST 请求 [multipart/form-data]

await dio.post(
  "https://postman-echo.com/post",
  data: FormData.fromMap({
    "foo": "foo",
    "bar": MultipartFile.fromBytes([1, 2, 3, 4, 5, 6])
  }),
);

POST 请求 [application/x-www-form-urlencoded]

await dio.post(
  "https://postman-echo.com/post",
  data: {
    "foo": "foo",
    "bar": "bar",
  },
  options: Options(contentType: Headers.formUrlEncodedContentType),
);

成功的 GET 请求 [text/html]

await _dio.get('https://example.org');

带查询参数的 GET 请求 [text/html]

await _dio.get(
  'https://example.com',
  queryParameters: {'limit_start': 0, 'search_term': 'dart'},
);

完整示例代码

import 'package:dio/dio.dart';
import 'package:dio_http_formatter/dio_http_formatter.dart';

void main() async {
  final _dio = Dio();

  // 添加拦截器
  _dio.interceptors.add(
    HttpFormatter(
      includeRequest: true,
      includeRequestHeaders: true,
      includeRequestQueryParams: true,
      includeRequestBody: true,
      includeResponse: true,
      includeResponseHeaders: true,
      includeResponseBody: true,
      loggingFilter: (request, response, error) {
        // 不记录返回状态码为 201 的请求/响应
        if (response?.statusCode == 201) {
          return false;
        }
        return true;
      },
    ),
  );

  // 发送GET请求
  await _dio.get('https://example.com', queryParameters: {'limit_start': 0, 'search_term': 'dart'});

  // 发送POST请求
  await _dio.post(
    'https://postman-echo.com/post',
    data: {'foo': 'foo'},
    options: Options()
      ..headers = {
        'my-custom-header': 'my-custom-header',
        'content-type': 'application/json'
      },
  );
}

以上是 dio_http_formatter 插件的详细使用说明及示例代码，希望对您有所帮助！