詳解Flutter中網(wǎng)絡(luò)框架dio的二次封裝

更新時(shí)間：2022年04月16日 08:30:55 作者：老李code

其實(shí)dio框架已經(jīng)封裝的很好了，但是在實(shí)戰(zhàn)項(xiàng)目中，為了項(xiàng)目可以統(tǒng)一管理，還是需要對dio框架進(jìn)行二次封裝。本文將詳細(xì)講解一下dio如何二次封裝，需要的可以參考一下

其實(shí)dio框架已經(jīng)封裝的很好了，但是在實(shí)戰(zhàn)項(xiàng)目中，為了項(xiàng)目可以統(tǒng)一管理，還是需要對dio框架進(jìn)行二次封裝。

整體思路：一般情況下，后臺(tái)返回的數(shù)據(jù)我們可以分為兩部分

1.狀態(tài)數(shù)據(jù)
2.渲染數(shù)據(jù)

狀態(tài)數(shù)據(jù)就是接口有沒有正常返回?cái)?shù)據(jù)相關(guān)的數(shù)據(jù)，這部分?jǐn)?shù)據(jù)跟業(yè)務(wù)無關(guān)，我們可以封裝起來統(tǒng)一管理，渲染數(shù)據(jù)就是我們渲染頁面所需要的數(shù)據(jù)，這塊的數(shù)據(jù)需要我們自己處理。

接下來我們就主要處理渲染數(shù)據(jù)這塊的內(nèi)容，我定義了兩個(gè)函數(shù)，渲染數(shù)據(jù)可能為一個(gè)對象或者一個(gè)數(shù)組，我做了分別處理，定義兩個(gè)函數(shù)來接受渲染數(shù)據(jù)。

// 定義兩個(gè)函數(shù)
typedef Success<T> = Function(T data);  請求數(shù)據(jù)data為obj對象
typedef SuccessList<T> = Function(List<T> data); // 請求數(shù)據(jù)data為[]數(shù)組

首先我們需要定義兩種數(shù)據(jù)接口的bean對象，返回對象示例：

/// 響應(yīng)數(shù)據(jù)頭數(shù)據(jù)統(tǒng)一管理
class BaseRes<T> {
  int? code;// 狀態(tài)碼
  String? message; // 狀態(tài)碼說明
  T? data; // 渲染數(shù)據(jù)

  BaseRes({this.code, this.message, this.data});

  factory BaseRes.fromJson(json) {
    // json 渲染json數(shù)據(jù)
    try {
      if (json["code"] != null) {
        try {
         code = json["code"];
        } catch (e) {
          code = -1;
        }
      } else {
        return BaseRes(code: -1, message: "服務(wù)器開小差了~", data: null);
      }
      return BaseRes(
          code: json["code"] ?? -1,
          message: json["message"],
          data: BeanFactory.generateOBJ<T>(json["data"]));
    } catch (e) {
      return BaseRes(code: -1, message: "服務(wù)器開小差了~", data: null);
    }
  }
}

返回?cái)?shù)組示例省略... 只把 T?data 改為 List<T?> data 即可，大同小異。

渲染實(shí)體類轉(zhuǎn)化:

/// 實(shí)體bean轉(zhuǎn)化工廠類
class BeanFactory {
  static T? generateOBJ<T>(json) {
    //T.toString() 類名
    try {
      switch (T.toString()) {
        case "int":
          return json;
        case "bool":
          return json;
        case "String":
          return json;
        default:
          // 實(shí)體類序列化
          return TestBean.formJson(json) as T;
      }
    } catch (e) {
      return null;
    }
  }
}

實(shí)體類：

/// 測試bean
class TestBean {
  String? msg;
  bool? isSelector;
  TestBean(this.msg,this.isSelector);

  TestBean.fromJson(dynamic json) {
    msg = json["msg"];
    isSelector = json["isSelector"];
  }

  Map<String, dynamic> toJson() {
    var map = <String, dynamic>{};
    map["msg"] = msg;
    map["isSelector"] = isSelector;
    return map;
  }
}

實(shí)際項(xiàng)目中用的JsonToDart插件一鍵生成即可。（這個(gè)插件唯一不好的地方，不能在已生成的文件里序列化，其他都很好）。

接下來就需要進(jìn)行對dio請求進(jìn)行二次封裝，dio庫核心請求方法是request方法，dio的get、post方法都是基于request方法，所以我們要自己再次對request方法進(jìn)行封裝成我們所需要的。

/// dio配置類
class DioManager {

  static const baseUrl = "https://xxx"; // 正式環(huán)境

  static DioManager instance = DioManager._internal();
  Dio? _dio;
  final Map<String, dynamic> _headers = {};


  // 單例 私有化構(gòu)造初始化dio
  DioManager._internal() {
    if (_dio == null) {
      BaseOptions options = BaseOptions(
          baseUrl: baseUrl,
          contentType: Headers.jsonContentType,
          responseType: ResponseType.json,
          receiveDataWhenStatusError: false,
          connectTimeout: _connectTimeout,
          receiveTimeout: _receiveTimeout,
          headers: _headers);
      _dio = Dio(options);

/// 正式環(huán)境攔截日志打印
if (!const bool.fromEnvironment("dart.vm.product")) {
  _dio?.interceptors
      .add(LogInterceptor(requestBody: true, responseBody: true));
}


Future<Uint8List> imageToBytes(String imageUrl) async {
  var response = await _dio?.get(imageUrl,
      options: Options(responseType: ResponseType.bytes));
  return Uint8List.fromList(response?.data);
}

get header => _headers;

/// 更新header
updateHeader() {
  _dio?.options.headers = _headers;
}

/// 請求，返回的渲染數(shù)據(jù) T
/// method：請求方法，NWMethod.GET等
/// path：請求地址
/// params：請求參數(shù)
/// success：請求成功回調(diào)
/// error：請求失敗回調(diào)
Future request<T>(Method method, String path,
    {String? baseUrl,
      Map<String, dynamic>? params,
      data,
      ProgressCallback? onSendProgress, // 上傳數(shù)據(jù)進(jìn)度
      ProgressCallback? onReceiveProgress, // 接受數(shù)據(jù)進(jìn)度
      Success<T>? success,
      Function(ErrorRes)? error}) async {
  try {
    var connectivityResult = await (Connectivity().checkConnectivity());

    if (connectivityResult == ConnectivityResult.none) {
      if (error != null) {
        error(ErrorRes(code: -9, message: "網(wǎng)絡(luò)異常~,請檢查您的網(wǎng)絡(luò)狀態(tài)!"));
      }
      return;
    }
    _setBaseUrl(baseUrl); // 動(dòng)態(tài)設(shè)置baseUrl 
    Response? response = await _dio?.request(
      path,
      queryParameters: params,
      data: data,
      onSendProgress: onSendProgress,
      onReceiveProgress: onReceiveProgress,
      options: Options(method: methodValues[method]),
    );
    if (response != null) {
      BaseRes entity = BaseRes<T>.fromJson(response.data);
      // 對象數(shù)據(jù)結(jié)構(gòu)
      if (entity.code == 200 && entity.data != null) {
        if (success != null) success(entity.data);
      } else {
        if (error != null) {
          error(ErrorRes(code: entity.code, message: entity.message));
        }
      }
    } else {
      if (error != null) error(ErrorRes(code: -1, message: "未知錯(cuò)誤"));
    }
  } on DioError catch (e) {
    if (error != null) error(createErrorEntity(e));
  }
}

Http最終調(diào)用類：

typedef Success<T> = Function(T data); // 定義一個(gè)函數(shù) 請求成功回調(diào)
typedef Error = Function(ErrorRes errorRes); // 請求失敗統(tǒng)一回調(diào)
typedef SuccessList<T> = Function(List<T> data); // 請求數(shù)據(jù)data為[]集合

/// 通用調(diào)用接口類
class Http {
  // 私有構(gòu)造
  Http._internal();
  static Http instance = Http._internal();
 
  /// get請求
  /// baseUrl 切換baseUrl
  /// params 參數(shù)
  /// success 請求對象成功回調(diào)
  /// successList 請求列表成功回調(diào)
  /// error 錯(cuò)誤回調(diào)
  /// [isList] 請求的數(shù)據(jù)是否為List列表 默認(rèn)對象
  /// [isList]=true 請求data數(shù)據(jù)為[]list列表
  void get<T>(String url,
      {String? baseUrl,
        Map<String, dynamic>? params,
        Success<T>? success,
        SuccessList<T>? successList,
        Error? error,
        bool isList = false}) {
    if (isList) {
      _requestList<T>(Method.get, url,
          baseUrl: baseUrl, params: params, success: successList, error: error);
    } else {
      _request<T>(Method.get, url,
          baseUrl: baseUrl, params: params, success: success, error: error);
    }
  }
  
/// post請求
/// baseUrl 切換baseUrl
/// params 參數(shù)
/// data 上傳表單數(shù)據(jù) formData
/// success 請求對象成功回調(diào)
/// successList 請求列表成功回調(diào)
/// error 錯(cuò)誤回調(diào)
/// [isList] 請求的數(shù)據(jù)是否為List列表 默認(rèn)對象
/// [isList]=true 請求data數(shù)據(jù)為[]list列表
void post<T>(String url,
    {String? baseUrl,
      Map<String, dynamic>? params,
      required data,
      Success<T>? success,
      SuccessList<T>? successList,
      Error? error,
      bool isList = false}) {
  if (isList) {
    _requestList<T>(Method.post, url,
        data: data,
        baseUrl: baseUrl,
        params: params,
        success: successList,
        error: error);
  } else {
    _request<T>(Method.post, url,
        data: data,
        baseUrl: baseUrl,
        params: params,
        success: success,
        error: error);
  }
}

實(shí)戰(zhàn)應(yīng)用調(diào)用：

我這邊對對業(yè)務(wù)模塊加了一層model處理，頁面只需要混入我們的model層調(diào)用具體的方法即可。

mixin LoginModel {
// get請求
loadCode(
  String value, {
  required Success<String> success,
  required Error error,
}) {
  Http.instance.get(Api.loadxxx,
      params: {"key": value}, success: success, error: error);
}
}

可以看到，我們在頁面中只需要關(guān)注具體的業(yè)務(wù)請求就可以了。

以上就是詳解Flutter中網(wǎng)絡(luò)框架dio的二次封裝的詳細(xì)內(nèi)容，更多關(guān)于Flutter dio二次封裝的資料請關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: