Flutter网络请求适配器插件dio_adapter的使用

Flutter网络请求适配器插件dio_adapter的使用

DioAdapterBase

DioBuilder 是一个 Dart 包装，它简化了使用 Dio 库进行 HTTP 请求。 它提供了一处理 API CRUD 操作的结构化方式，包括自定义请求和响应处理、错误管理以及 HTTP 客户端适应。

功能

• CRUD 操作: 简单地执行 GET, POST, PUT 和 DELETE 请求。
• 自定义请求和响应处理器: 自定义请求和响应处理器。
• 错误处理: 综合错误处理来管理各种 Dio 异常。
• HTTP 客户端适应: 为特定用例适应 HTTP 客户端，包括自签名证书。

开始使用

安装

将 dio_adapter 包添加到您的 pubspec.yaml 文件中：

dependencies:
  dio_adapter: ^2.1.2 # 这是最新版本

示例代码

// 示例使用 DioBuilderBase
import 'package:dio_adapter/dio_adapter.dart';

void main() async {
  final dioBuilder = DioAdapterBase(
    baseUrl: 'https://jsonplaceholder.typicode.com',
    connectTimeout: Duration(seconds: 1000),
    receiveTimeout: Duration(seconds: 1800),
    contentTypeEnum: ContentTypeEnum.applicationJson,
    responseTypeEnum: ResponseTypeEnum.json,
    sslCertificateSHa256:
        "drJ7gKWAJ9w88dpo2sFEO2TmX0LYDYD4vrb6FASSTtac=", // 这个值必须存储在安全的地方，如 .env 文件中，并不提交到源代码控制
    customRequestHandler: (options, handler) async {
      // 在发送请求之前做点什么。
      // 如果你想用自定义数据解决请求，你可以用 `handler.resolve(response)` 来解决
      //       if (options.path.contains("/mock-endpoint")) {
      //         // 创建一个模拟响应
      //         final mockResponse = Response(
      //           requestOptions: options,
      //           data: {"message": "This is a mock response"},
      //           statusCode: 200,
      //           statusMessage: "OK",
      //         );
      //         // 解决请求与模拟响应
      //         return handler.resolve(mockResponse);
      //       }
      // 如果你想用错误信息拒绝请求，你可以用 `handler.reject(dioError)` 来拒绝
      //  final token = options.headers["Authorization"];
      //       if (token == null || token.isEmpty) {
      //         return handler.reject(
      //           DioException(
      //             requestOptions: options,
      //             type: DioExceptionType.badResponse,
      //             error: "Unauthorized: Missing or invalid token",
      //           ),
      //         );
      //       }
      return options;
    },
    customResponseHandler: (response, handler) async {
      // 处理响应数据。
      // 如果你想用错误信息拒绝请求，你可以用 `handler.reject(dioError)` 来拒绝。
      return response;
    },
    customErrorHandler: (error, handler) async {
      // 处理响应错误。
      // 如果你想用自定义数据解决请求，你可以用 `handler.resolve(response)` 来解决。
      return error;
    },
  );

  // 示例 GET 请求
  final getResult = await dioBuilder.get('/posts/1');
  getResult.fold(
    (error) => print('GET Error: $error'),
    (response) => print('GET Response: ${response.data}'),
  );

  // 示例 POST 请求
  final postResult = await dioBuilder
      .post('/posts', body: {'title': 'foo', 'body': 'bar', 'userId': 1});
  postResult.fold(
    (error) => print('POST Error: $error'),
    (response) => print('POST Response: ${response.data}'),
  );

  // 示例 PUT 请求
  final putResult = await dioBuilder.put('/posts/1', body: {
    'id': 1,
    'title': 'updated title',
    'body': 'updated body',
    'userId': 1
  });
  putResult.fold(
    (error) => print('PUT Error: $error'),
    (response) => print('PUT Response: ${response.data}'),
  );

  // 示例 DELETE 请求
  final deleteResult = await dioBuilder.delete('/posts/1');
  deleteResult.fold(
    (error) => print('DELETE Error: $error'),
    (response) => print('DELETE Response: ${response.statusCode}'),
  );
}