Flutter事件处理插件handle的使用

Flutter事件处理插件handle的使用

Handle 是一个用于组合HTTP客户端和创建服务以进行HTTP请求的简单库。它基于 package:http 的 Client 构建，可以作为其他 HTTP 客户端生成库（如 retrofit 和 chopper）的替代方案。

特性

• 可以组合不同的客户端来创建适合您需求的完美HTTP客户端。
• 与 package:http 的 Client 兼容 - 您可以将现有的 HTTP Clients 包装起来，例如 RetryClient。
• 创建 REST 请求和服务所需的最少样板代码，无需代码生成。
• 广泛的测试套件和基准测试确保了可靠性和高性能。

文档

有关以下主题的详细信息，请参阅API文档：

• 开始使用
• 配置
• 客户端
• 服务
• 扩展
• 错误处理
• 示例

最新的基准测试结果

在 benchmarks/ 目录中包含了该库的客户端和 package:http 的 Client 的性能比较基准测试。

HttpClientListSerializationBenchmark(RunTime): 1788231.5 us.
RestClientListSerializationBenchmark(RunTime): 1745168.5 us.
RestClientListAsyncSerializationBenchmark(RunTime): 1832672.0 us.
HttpClientSingleSerializationBenchmark(RunTime): 1257598.0 us.
RestClientSingleSerializationBenchmark(RunTime): 1257561.0 us.
RestClientSingleAsyncSerializationBenchmark(RunTime): 1262549.0 us.

基准测试最后更新于2023年6月20日。

完整示例 Demo

以下是 Handle 插件的完整示例代码，展示如何使用 Handle 进行 HTTP 请求处理：

import 'package:http/http.dart' as http;
import 'package:handle/handle.dart';

// 创建一个带有基础 URL 的 HTTP 客户端
final http.Client jsonPlaceholderClient = RequestClient(
  http.Client(),
  url: Uri.https('jsonplaceholder.typicode.com'), // 基础 URL
);

// 添加反序列化器到通用的 JsonModelSerializer
void addAllDeserializers() {
  JsonModelSerializer.common.addDeserializers({
    JsonDeserializerOf<TodoModel>((json) => TodoModel.fromJson(json)),
  });
}

// 定义一个 REST 服务类
class TodoService extends RestService {
  TodoService(super.client)
      : super(
          builder: (client) {
            return RequestClient(
              client,
              // 合并来自包装客户端的 URL 和头部信息
              url: Uri(path: '/todos'),
            );
          },
          serializer: null, // 如果不为空，则会在此基础上创建一个新的序列化器
        );

  // 获取单个 Todo
  Future<TodoModel?> getTodo(int id) {
    return client.get(Uri(path: '$id')).dataAsync();
  }

  // 获取所有 Todos
  Future<List<TodoModel>?> getTodos() {
    return client.get(Uri()).dataAsync();
  }
}

void main() async {
  // 在从 RestClient 获取反序列化的响应之前必须添加反序列化器
  addAllDeserializers();

  // 创建 TodoService 实例，并传入预配置的客户端
  final service = TodoService(jsonPlaceholderClient);

  // 并发请求获取 ID 为 1 到 10 的 Todo
  await Future.wait([
    for (final id in [1, 2, 3, 4, 5, 6, 7, 8, 9, 10])
      service.getTodo(id).then(print), // 打印每个 Todo 的结果
  ]);

  // 单次请求获取所有 Todos
  await service.getTodos().then(print); // 打印所有 Todos 的结果

  // 使用完毕后销毁服务
  service.dispose(keepHttpClientAlive: false);
}

// 简单的 JSON 序列化类
class TodoModel {
  final int userId;
  final int id;
  final String title;
  final bool completed;

  const TodoModel(this.userId, this.id, this.title, this.completed);

  factory TodoModel.fromJson(dynamic json) {
    return TodoModel(
      json['userId'],
      json['id'],
      json['title'],
      json['completed'],
    );
  }

  [@override](/user/override)
  String toString() {
    final String status = completed ? 'completed' : 'pending';
    return 'Todo #$id "$title" is $status by user#$userId';
  }
}