首頁 > 軟體

詳解Flutter中網路框架dio的二次封裝

2022-04-16 13:01:02

其實dio框架已經封裝的很好了,但是在實戰專案中,為了專案可以統一管理,還是需要對dio框架進行二次封裝。

整體思路:一般情況下,後臺返回的資料我們可以分為兩部分

  • 1.狀態資料
  • 2.渲染資料

狀態資料就是介面有沒有正常返回資料相關的資料,這部分資料跟業務無關,我們可以封裝起來統一管理,渲染資料就是我們渲染頁面所需要的資料,這塊的資料需要我們自己處理。

接下來我們就主要處理渲染資料這塊的內容,我定義了兩個函數,渲染資料可能為一個物件或者一個陣列,我做了分別處理,定義兩個函數來接受渲染資料。

// 定義兩個函數
typedef Success<T> = Function(T data);  請求資料data為obj物件
typedef SuccessList<T> = Function(List<T> data); // 請求資料data為[]陣列

首先我們需要定義兩種資料介面的bean物件,返回物件範例:

/// 響應資料頭資料統一管理
class BaseRes<T> {
  int? code;// 狀態碼
  String? message; // 狀態碼說明
  T? data; // 渲染資料

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

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

返回陣列範例省略... 只把 T?data 改為 List<T?> data 即可,大同小異。

渲染實體類轉化:

/// 實體bean轉化工廠類
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:
          // 實體類序列化
          return TestBean.formJson(json) as T;
      }
    } catch (e) {
      return null;
    }
  }
}

實體類:

/// 測試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;
  }
}

實際專案中用的JsonToDart外掛一鍵生成即可。(這個外掛唯一不好的地方,不能在已生成的檔案裡序列化,其他都很好)。

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

/// dio設定類
class DioManager {

  static const baseUrl = "https://xxx"; // 正式環境

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


  // 單例 私有化構造初始化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);

/// 正式環境攔截紀錄檔列印
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;
}
/// 請求,返回的渲染資料 T
/// method:請求方法,NWMethod.GET等
/// path:請求地址
/// params:請求引數
/// success:請求成功回撥
/// error:請求失敗回撥
Future request<T>(Method method, String path,
    {String? baseUrl,
      Map<String, dynamic>? params,
      data,
      ProgressCallback? onSendProgress, // 上傳資料進度
      ProgressCallback? onReceiveProgress, // 接受資料進度
      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: "網路異常~,請檢查您的網路狀態!"));
      }
      return;
    }
    _setBaseUrl(baseUrl); // 動態設定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);
      // 物件資料結構
      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: "未知錯誤"));
    }
  } on DioError catch (e) {
    if (error != null) error(createErrorEntity(e));
  }
}

Http最終呼叫類:

typedef Success<T> = Function(T data); // 定義一個函數 請求成功回撥
typedef Error = Function(ErrorRes errorRes); // 請求失敗統一回撥
typedef SuccessList<T> = Function(List<T> data); // 請求資料data為[]集合

/// 通用呼叫介面類
class Http {
  // 私有構造
  Http._internal();
  static Http instance = Http._internal();
 
  /// get請求
  /// baseUrl 切換baseUrl
  /// params 引數
  /// success 請求物件成功回撥
  /// successList 請求列表成功回撥
  /// error 錯誤回撥
  /// [isList] 請求的資料是否為List列表 預設物件
  /// [isList]=true 請求data資料為[]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 引數
/// data 上傳表單資料 formData
/// success 請求物件成功回撥
/// successList 請求列表成功回撥
/// error 錯誤回撥
/// [isList] 請求的資料是否為List列表 預設物件
/// [isList]=true 請求data資料為[]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);
  }
}

實戰應用呼叫:

我這邊對對業務模組加了一層model處理,頁面只需要混入我們的model層呼叫具體的方法即可。

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);
}
}

可以看到,我們在頁面中只需要關注具體的業務請求就可以了。

以上就是詳解Flutter中網路框架dio的二次封裝的詳細內容,更多關於Flutter dio二次封裝的資料請關注it145.com其它相關文章!


IT145.com E-mail:sddin#qq.com