Flutter插件roundtripper的特性与使用方法详解

Flutter插件roundtripper的特性与使用方法详解

Flutter插件roundtripper简介

roundtripper 是一个基于 dio 的多平台 HTTP 客户端，提供了灵活的请求处理能力。它完全参考了 Go 语言中 http.RoundTripper 的设计理念，并且在 Dart 中进行了风格化的适配。你可以通过 RoundTrip 对每个请求进行自定义处理。

功能特性

• 日志记录：可以为每个请求添加日志。
• 错误处理：将非 2xx 响应抛出为错误。
• 请求/响应体编码：支持对请求和响应体进行编码。

示例代码

以下是一个完整的示例，展示了如何使用 roundtripper 插件来处理 HTTP 请求。

// 引入必要的依赖
import 'package:logr/logr.dart'; // 日志记录库
import 'package:logr/stdlogr.dart'; // 标准日志记录器
import 'package:roundtripper/roundtripbuilders.dart'; // roundtripper 提供的构建器
import 'package:roundtripper/roundtripper.dart'; // roundtripper 主库

void main() async {
  // 创建一个客户端实例，并配置处理链
  var c = Client(roundTripBuilders: [
    // 抛出非 2xx 响应的错误
    ThrowsNot2xxError(),
    // 处理请求体的编码
    RequestBodyConvert(),
    // 记录请求日志
    RequestLog(),
  ]);

  // 初始化日志记录器
  var l = Logger(StdLogSink("roundtripper"));

  // 使用日志上下文运行任务
  var ctx = Logger.withLogger(l);

  ctx.run(() async {
    // 发送 HTTP 请求
    var resp = await c.fetch(Request.uri(
      "https://httpbin.org/anything", // 目标 URL
      queryParameters: { // 查询参数
        "int": 1,
        "slice": [1, 2],
      },
      headers: { // 自定义头信息
        "x-int": 1,
        "x-slice": [1, 2],
      },
    ));

    try {
      // 尝试解析 JSON 响应
      await resp.json();
    } on ResponseException catch (_) {
      // 捕获并处理异常
    }
  });
}

代码说明

1. 依赖引入：

   • logr 和 stdlogr 用于日志记录。
   • roundtripper 提供了核心功能和构建器。

2. Client 配置：

   • ThrowsNot2xxError()：将非 2xx 响应视为错误。
   • RequestBodyConvert()：处理请求体的编码。
   • RequestLog()：记录请求日志。

3. 日志记录：

   • 使用 Logger 和 StdLogSink 来记录日志。

4. HTTP 请求：

   • 使用 fetch 方法发送 HTTP 请求。
   • 支持设置查询参数和自定义头信息。

5. 异常处理：

   • 使用 try-catch 捕获并处理 ResponseException。

输出示例

运行上述代码后，你将在控制台看到类似如下的日志输出：

[roundtripper] INFO: Request sent to https://httpbin.org/anything?int=1&slice=1%2C2 with headers {"x-int":1,"x-slice":[1,2]}
[roundtripper] INFO: Response received with status code 200