Flutter网络请求插件dio_http_client的使用

Flutter网络请求插件dio_http_client的使用

dio_http_client 是一个高级封装库，用于处理网络请求。它目前支持认证令牌和缓存系统（通过 dio_http_cache）。

添加依赖

为了使 dio_http_client 能正常工作，你还需要添加以下依赖：

dependencies:
  dio: ^4.0.x  #最新版本
  dio_http_client: ^0.0.x #最新版本
  dio_http_cache: ^0.3.x #最新版本
  dartz: ^0.10.x #最新版本

数据结构

我们建议使用如下的数据结构：

data/
|-request/
|-response/
|-name_repository_impl.dart
|-name_repository.dart

在 request 目录下，每个请求都有一个对应的类。

在 response 目录下，每个响应都有一个对应的类。

简单示例

TestGetRequest

class TestGetRequest extends ApiRequest {
  TestGetRequest()
      : super(
            baseUrl: Constants.domain, //您的域名
            endPoint: "${Constants.getEndpoint}?key=value", //您的端点
            method: RestMethod.get, //请求方法
            decoder: (data) => 
                TestGetResponse.fromMap(Map<String, dynamic>.from(data))); //响应解码器
}

TestGetResponse

class TestGetResponse extends ApiResponse<Map<String, dynamic>> {
  TestGetResponse._( //私有构造函数
      {Map<String, dynamic>? body, String? message, String? result}) //body的类型为你需要的类型，也需要在仓库中设置
      : super(body: body, message: message, result: result);

  factory TestGetResponse.fromMap(Map<String, dynamic> data) {
    return TestGetResponse._(body: data["args"]);
  }
}

TestRepository

abstract class TestRepository extends RemoteRepository {
  TestRepository(AppHttpClient remoteDataSource) : super(remoteDataSource);

  Future<Either<ErrorResponse, SuccessResponse<Map<String, dynamic>>>> testGet( //更改SuccessResponse的类型为你需要的类型
      {bool? cached, bool? forceRefresh}); //如果需要缓存响应，则将cached设置为true；如果需要刷新缓存响应，则将forceRefresh设置为true；如果不希望缓存，则留空
}

TestRepositoryImpl

class TestRepositoryImpl extends TestRepository {
  TestRepositoryImpl(AppHttpClient remoteDataSource) : super(remoteDataSource);
  
  [@override](/user/override)
  Future<Either<ErrorResponse, SuccessResponse<Map<String, dynamic>>>> testGet(
      {bool? cached, bool? forceRefresh}) async {
    final response = await dataSource.retrieveData<TestGetResponse>( //设置返回类型
      TestGetRequest(),
      cached: cached,
      forceRefresh: forceRefresh,
    );

    return response.fold(
        (error) => Left(error),
        (success) => Right(
            SuccessResponse(success.statusCode, success.data.body ?? {})));
  }
}

拦截器

LoggingInterceptor

这是为了在控制台中记录所有请求和响应。

你可以创建自己的拦截器并将其附加到客户端。

快速开始

1. 初始化客户端：

AppHttpClient client = AppHttpClient(debug: true, interceptors: [ //添加所有需要的拦截器
   LoggingInterceptor(),
   DioCacheManager(CacheConfig(baseUrl: "https://www.google.it")).interceptor //如果需要缓存你的应用，则添加此拦截器
 ],
 requestReceiveTimeout: 3600, //全局接收超时
 requestSendTimeout: 3600, //全局发送超时
 );

1. 初始化仓库：

TestRepository testRepository = TestRepositoryImpl(client);

1. 发起请求：

final response = await testRepository.testGet();

更新授权令牌

要更新授权令牌，可以调用：

  client.updateToken(token);

我们建议使用 get_it 作为依赖注入来管理你的实例。

请求类

当你创建请求类时，需要扩展 ApiRequest。

只在需要时覆盖方法：

class TestGetRequest extends ApiRequest {
  TestGetRequest()
      : super(
            token: //授权令牌,
            userEmail: //用户邮箱,
            baseUrl: //您的域名,
            endPoint: //您的端点,
            method: //请求方法 (RestMethod.get, post, patch, put, delete),
            decoder: (data) => //响应解码器,
  );
                
  [@override](/user/override)
  //请求体
  Map<String, dynamic> get body => super.body;

  [@override](/user/override)
  //查询参数
  Map<String, dynamic> get queryParameters => super.queryParameters;

  [@override](/user/override)
  // Dio 响应类型。默认为 ResponseType.json
  ResponseType get responseType => super.responseType;

  [@override](/user/override)
  //默认为36000毫秒
  int get receiveTimeout => super.receiveTimeout;

  [@override](/user/override)
  //默认为36000毫秒
  int get sendTimeout => super.sendTimeout;
}

响应类

当你创建响应类时，需要扩展 ApiResponse。

class TestGetResponse extends ApiResponse<Map<String, dynamic>> {
  TestGetResponse._({
    Map<String, dynamic>? body,
    String? message,
    String? result,
  }) : super(
          body: body,
          message: message,
          result: result,
        );

  factory TestGetResponse.fromMap(Map<String, dynamic> data) { //解码器需要调用工厂方法
    return TestGetResponse._(body: data["args"]);
  }
}

仓库实现类

class TestRepositoryImpl extends TestRepository { //继承抽象仓库
  TestRepositoryImpl(AppHttpClient remoteDataSource) : super(remoteDataSource);
  
  [@override](/user/override)
  Future<Either<ErrorResponse, SuccessResponse<Map<String, dynamic>>>> testGet(
      {bool? cached, bool? forceRefresh}) async {
    final response = await dataSource.retrieveData<TestGetResponse>( //设置返回类型
      TestGetRequest(),
      cached: cached, // 如果希望缓存响应，则设为true
      forceRefresh: forceRefresh, // 如果希望刷新缓存，则设为true
      duration: Duration(days: 1) // 设置缓存持续时间，默认为7天
    );
    
    // 返回正确的响应
    return response.fold(
        (error) => Left(error),
        (success) => Right(
            SuccessResponse(success.statusCode, success.data.body ?? {})));
  }
}