Flutter网络请求增强插件sturdy_http的使用

SturdyHttp

SturdyHttp 是一个基于 Dio 封装的强类型、事件驱动、可靠的HTTP客户端。

Features

SturdyHttp 提供了以下特性：

• 执行实际对象形式的请求（参见 NetworkRequest）
• 请求执行期间的事件通知（参见 SturdyHttpEventListener）
• 使用 Isolate 反序列化以避免阻塞主线程（参见 Deserializer）
• 清晰枚举响应类型（参见 NetworkResponse）

Note 在 Betterment，我们过去一年一直在内部使用 SturdyHttp。它已经在应用程序中超过200个网络请求调用点上进行了测试，其强烈的风格是这种实验的直接结果。如果有必要，我们总是愿意让它更灵活；请随时开一个Issue来讨论！

Usage

创建实例

在应用程序启动时创建 SturdyHttp 实例：

return SturdyHttp(
  baseUrl: '$baseUrl/api/',
  eventListener: eventListener,
  interceptors: interceptors,
);

执行请求

执行GET请求示例：

Future<Result<MyData>> fetch({required int id}) async {
  return _client.execute<Json, MyData>(
    GetRequest('/v6/data/${id}'),
    onResponse: (r) => r.maybeWhen(
      ok: (json) => Result.success(MyData.fromJson),
      orElse: () => Result.failure(r),
    ),
  );
}

处理异常

为了更好地处理异常，可以扩展 SturdyHttp 类：

extension SturdyHttpX on SturdyHttp {
  Future<Result<M, NetworkError>> executeForResult<R, M extends Object>(
    NetworkRequest request, {
    required Result<M, NetworkError> Function(NetworkResponse<R> response) onResponse,
  }) async {
    return Result.fromAsync(
      () => execute(
        request,
        onResponse: onResponse,
      ),
    ).match(ok: (o) => o, error: (e) => Result.error(NetworkError.forException(e)));
  }
}

Warning 我们正在考虑开源我们的 Result 类型并将其集成到 SturdyHttp 中。如果这样做，我们将可能更改 execute 的返回类型为 Result，并提供 executeUnsafe 作为非 Result（即抛出 Exception）的替代方法。这将是一个破坏性变化。

示例代码

以下是一个完整的示例，展示了如何设置和使用 SturdyHttp：

import 'package:charlatan/charlatan.dart';
import 'package:sturdy_http/sturdy_http.dart';

void main(List<String> args) async {
  // 设置一些假的HTTP响应
  final charlatan = Charlatan()
    ..whenGet(
      '/foo',
      (request) => CharlatanHttpResponse(
        body: 'Hello World!',
      ),
    )
    ..whenPost(
      '/foo',
      (request) => CharlatanHttpResponse(statusCode: 204),
    );

  // 创建客户端
  final client = SturdyHttp(
    baseUrl: 'api/v1/',
    customAdapter: charlatan.toFakeHttpClientAdapter(),
    eventListener: ExampleEventListener(),
  );

  // GET请求。打印 'Hello World!'
  await client.execute<Json, void>(
    GetRequest('/foo'),
    onResponse: (r) {
      return switch (r) {
        OkResponse(:final response) => print(response),
        _ => print('GET /foo failed: $r'),
      };
    },
  );

  // POST请求。
  // 打印:
  // 'mutative request success' <-- 来自 ExampleEventListener
  // 'success!'
  await client.execute<void, void>(
    PostRequest('/foo', data: NetworkRequestBody.empty()),
    onResponse: (r) {
      return switch (r) {
        OkNoContent() => print('success!'),
        _ => print('POST /foo failed: $r'),
      };
    },
  );
}

class ExampleEventListener implements SturdyHttpEventListener {
  @override
  Future<void> onEvent(SturdyHttpEvent event) {
    return event.when(
      decodingError: (_, __, ___) async => print('decoding error'),
      authFailure: (_) async => print('auth failure'),
      mutativeRequestSuccess: (_) async => print('mutative request success'),
    );
  }
}

Contributing

如果您在使用 SturdyHttp 时遇到bug或限制，我们非常希望您能帮助解决这些问题。首先，请 打开一个issue 进行讨论。如果我们认为应该继续进行更改并且您愿意贡献代码，请创建 SturdyHttp 的分支并向主仓库提交PR。

以上就是 SturdyHttp 插件的使用介绍，希望对您有所帮助！