Flutter网络请求与API调用插件chopper_client_wrapper的使用

Flutter网络请求与API调用插件chopper_client_wrapper的使用

Chopper Client Wrapper 是一个包，它提供了一个抽象类 ChopperClientWrapper，用于创建一个可以与您的API服务交互的Chopper客户端。该类提供了一系列功能，如创建Chopper客户端、拦截器、转换器等。

使用方法

要使用 ChopperClientWrapper 类，您需要继承它并实现其抽象方法。以下是需要实现的方法：

• jsonToModelConvertorMap: 一个映射表，包含类型及其将JSON转换为其类型的函数。例如：LoginResponseModel: LoginResponseModel.fromJson
• jsonToErrorModelConvertorMap: 一个映射表，包含类型及其将JSON转换为其类型的函数，用于反序列化错误响应。例如：ErrorResponseModel: ErrorResponseModel.fromJson
• baseUrl: 您的API服务的基本URL。
• chopperServices: 您为应用程序创建的一系列Chopper服务。
• getToken(): 应覆盖此方法以返回可以传递到头部的令牌。

以下是如何扩展 ChopperClientWrapper 类的一个示例：

import 'package:chopper/chopper.dart'; 
import 'package:chopper_client_wrapper/ChopperService/Utils/Convertors/JsonToTypeConverter.dart';
import 'package:chopper_client_wrapper/ChopperService/Utils/Interceptors/ApplyHeaderInterceptor.dart'; 
import 'package:chopper_client_wrapper/ChopperService/Utils/Interceptors/RequestLogger.dart'; 
import 'package:chopper_client_wrapper/ChopperService/Utils/Interceptors/ResponseLogger.dart'; 

class MyChopperClient extends ChopperClientWrapper
{ 
  // 实现将JSON转换为模型的映射
  [@override](/user/override)
  Map<Type, JsonConvertorFunction> get jsonToModelConvertorMap => {};

  // 实现将JSON转换为错误模型的映射
  [@override](/user/override)
  Map<Type, JsonConvertorFunction> get jsonToErrorModelConvertorMap => {};

  // 设置基础URL
  [@override](/user/override)
  String get baseUrl => 'https://myapi.com';

  // 设置Chopper服务列表
  [@override](/user/override)
  List<ChopperService> get chopperServices => [
    // 列出您为应用创建的所有Chopper服务
  ];

  // 获取令牌，用于传递到头部
  [@override](/user/override)
  String getToken() {
    return 'mytoken';
  }
}

方法

getChopperService

此方法可用于访问您已创建并分配在 chopperServices 中的任何特定Chopper服务。您需要指定要获取的Chopper服务的类型。例如：

var myChopperService = MyChopperClient().getChopperService();

_createChopperClient

此私有方法使用 baseUrl, chopperServices 和拦截器创建一个Chopper客户端实例。它还设置了用于将JSON转换为您模型类的转换器和错误转换器。

拦截器

Chopper Client Wrapper 提供了三个拦截器：

• RequestLogger(): 在发送到服务器之前记录请求。它会记录请求类型、URL 和主体。
• ResponseLogger(): 记录来自服务器的响应，并且如果存在错误也会记录。
• ApplyHeaderInterceptor(): 在发送到服务器之前添加一个头部。

转换器

Chopper Client Wrapper 提供了一个 JsonToTypeConverter，用于将JSON转换为您模型类。您需要提供一个映射表，其中包含类型及其将JSON转换为其类型的函数。

注意：请参阅示例以更清楚地理解如何使用该包。

示例代码

import 'dart:async';

import 'package:chopper/chopper.dart';
import 'package:chopper_client_wrapper/ChopperService/ChopperClientWrapper.dart';

void main() {}

class MyChopperClient extends ChopperClientWrapper {

  /// 示例
  /// LoginResponseModel : LoginResponseModel.fromJson
  /// 我们有一个名为LoginResponseModel的模型，这是用户成功登录后收到的响应模型
  /// LoginResponseModel.fromJson是将Map转换为LoginResponseModel对象的工厂构造函数
  [@override](/user/override)
  Map<Type, JsonConvertorFunction> get jsonToModelConvertorMap => {};

  [@override](/user/override)
  Map<Type, JsonConvertorFunction> get jsonToErrorModelConvertorMap => {};

  /// 我的基础URL
  [@override](/user/override)
  String get baseUrl => 'https://myapi.com';

  [@override](/user/override)
  List<ChopperService> get chopperServices => [
    // 列出您为应用创建的所有Chopper服务
  ];

  /// 返回一个用于认证的令牌
  [@override](/user/override)
  FutureOr<String> getToken() {
    return 'mytoken';
  }

  /// 如果您想更改包中默认设置的头部参数，可以在这里设置
  [@override](/user/override)
  Map<String, String> getHeaderParameters(){
    return {};
  }
}