Flutter Dio二次封裝

頭髮還沒禿發表於2020-01-08

DioManager：Dio輔助類NWMethod：請求方法，get、post等
NWApi：大家都知道
EntityFactory：json轉換輔助工廠，把json轉為T
BaseEntity<T>：資料基類，返回的引數為 {“code”: 0, “message”: “”, “data”: {}}
BaseListEntity<T>：資料基類2，返回的引數為 {“code”: 0, “message”: “”, “data”: []}
ErrorEntity：請求報錯基類，{“code”: 0, “message”: “”}

EntityFactory：

class EntityFactory {
  static T generateOBJ<T>(json) {
    if (json == null) {
      return null;
    }
//可以在這裡加入任何需要並且可以轉換的型別，例如下面
//    else if (T.toString() == "LoginEntity") {
//      return LoginEntity.fromJson(json) as T;
//    }
    else {
      return json as T;
    }
  }
}複製程式碼

BaseEntity：

class BaseEntity<T> {
  int code;
  String message;
  T data;

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

  factory BaseEntity.fromJson(json) {
    return BaseEntity(
      code: json["code"],
      message: json["msg"],
      // data值需要經過工廠轉換為我們傳進來的型別
      data: EntityFactory.generateOBJ<T>(json["data"]),
    );
  }
}
複製程式碼

BaseListEntity：

class BaseListEntity<T> {
  int code;
  String message;
  List<T> data;

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

  factory BaseListEntity.fromJson(json) {
    List<T> mData = List();
    if (json['data'] != null) {
      //遍歷data並轉換為我們傳進來的型別
      (json['data'] as List).forEach((v) {
        mData.add(EntityFactory.generateOBJ<T>(v));
      });
    }

    return BaseListEntity(
      code: json["code"],
      message: json["msg"],
      data: mData,
    );複製程式碼

} }

ErrorEntity：

class ErrorEntity {
  int code;
  String message;
  ErrorEntity({this.code, this.message});
}複製程式碼

NWApi：

class NWApi {
  static final baseApi = "https://easy-mock.bookset.io/mock/5dfae67d4946c20a50841fa7/example/";
  static final loginPath = "user/login";//介面返回：{"code": int, "message": "String", "data": {"account": "String", "password": "String"}}
  static final queryListPath = "/query/list";//介面返回：{"code": ing, "message": "String", "data": [int, int, String, int, String, int]}
  static final queryListJsonPath = "/query/listjson";//介面返回：{"code": int, "message": "String", "data": [{"account": "String", "password": "String"}， {"account": "String", "password": "String"}]}
}複製程式碼

NWMethod：

enum NWMethod {
  GET,
  POST,
  DELETE,
  PUT
}
//使用：NWMethodValues[NWMethod.POST]
const NWMethodValues = {
  NWMethod.GET: "get",
  NWMethod.POST: "post",
  NWMethod.DELETE: "delete",
  NWMethod.PUT: "put"
};複製程式碼

下面就可以進行正式的封裝了：

第一步是建立Dio的單例輔助類，並初始化Dio和對Dio進行一些全域性的引數設定：

import 'package:dio/dio.dart';
import 'package:flutter_app/network/NWApi.dart';
import 'package:flutter_app/utils/PrintUtil.dart';
class DioManager {
  static final DioManager _shared = DioManager._internal();
  factory DioManager() => _shared;
  Dio dio;
  DioManager._internal() {
    if (dio == null) {
      BaseOptions options = BaseOptions(
        baseUrl: NWApi.baseApi,
        contentType: Headers.jsonContentType,
        responseType: ResponseType.json,
        receiveDataWhenStatusError: false,
        connectTimeout: 30000,
        receiveTimeout: 3000,
      );
      dio = Dio(options);
    }
  }
}複製程式碼

第二步對請求進行封裝，在我的想法中 {“code”: 0, “message”: “”, “data”: {}} 和 {“code”: 0, “message”: “”, “data”: []} 這兩種資料是要分開兩個請求方法的：

  // 請求，返回引數為 T
  // method：請求方法，NWMethod.POST等
  // path：請求地址
  // params：請求引數
  // success：請求成功回撥
  // error：請求失敗回撥
  Future request<T>(NWMethod method, String path, {Map params, Function(T) success, Function(ErrorEntity) error}) async {
    try {
      Response response = await dio.request(path, queryParameters: params, options: Options(method: NWMethodValues[method]));
      if (response != null) {
        BaseEntity entity = BaseEntity<T>.fromJson(response.data);
        if (entity.code == 0) {
          success(entity.data);
        } else {
          error(ErrorEntity(code: entity.code, message: entity.message));
        }
      } else {
        error(ErrorEntity(code: -1, message: "未知錯誤"));
      }
    } on DioError catch(e) {
      error(createErrorEntity(e));
    }
  }

  // 請求，返回引數為 List
  // method：請求方法，NWMethod.POST等
  // path：請求地址
  // params：請求引數
  // success：請求成功回撥
  // error：請求失敗回撥
  Future requestList<T>(NWMethod method, String path, {Map params, Function(List) success, Function(ErrorEntity) error}) async {
    try {
      Response response = await dio.request(path, queryParameters: params, options: Options(method: NWMethodValues[method]));
      if (response != null) {
        BaseListEntity entity = BaseListEntity<T>.fromJson(response.data);
        if (entity.code == 0) {
          success(entity.data);
        } else {
          error(ErrorEntity(code: entity.code, message: entity.message));
        }
      } else {
         error(ErrorEntity(code: -1, message: "未知錯誤"));
      }
    } on DioError catch(e) {
      error(createErrorEntity(e));
    }
  }複製程式碼

提取請求錯誤處理方法createErrorEntity：

  // 錯誤資訊
  ErrorEntity createErrorEntity(DioError error) {
    switch (error.type) {
      case DioErrorType.CANCEL:{
        return ErrorEntity(code: -1, message: "請求取消");
      }
      break;
      case DioErrorType.CONNECT_TIMEOUT:{
        return ErrorEntity(code: -1, message: "連線超時");
      }
      break;
      case DioErrorType.SEND_TIMEOUT:{
        return ErrorEntity(code: -1, message: "請求超時");
      }
      break;
      case DioErrorType.RECEIVE_TIMEOUT:{
        return ErrorEntity(code: -1, message: "響應超時");
      }
      break;
      case DioErrorType.RESPONSE:{
        try {
          int errCode = error.response.statusCode;
          String errMsg = error.response.statusMessage;
          return ErrorEntity(code: errCode, message: errMsg);
//          switch (errCode) {
//            case 400: {
//              return ErrorEntity(code: errCode, message: "請求語法錯誤");
//            }
//            break;
//            case 403: {
//              return ErrorEntity(code: errCode, message: "伺服器拒絕執行");
//            }
//            break;
//            case 404: {
//              return ErrorEntity(code: errCode, message: "無法連線伺服器");
//            }
//            break;
//            case 405: {
//              return ErrorEntity(code: errCode, message: "請求方法被禁止");
//            }
//            break;
//            case 500: {
//              return ErrorEntity(code: errCode, message: "伺服器內部錯誤");
//            }
//            break;
//            case 502: {
//              return ErrorEntity(code: errCode, message: "無效的請求");
//            }
//            break;
//            case 503: {
//              return ErrorEntity(code: errCode, message: "伺服器掛了");
//            }
//            break;
//            case 505: {
//              return ErrorEntity(code: errCode, message: "不支援HTTP協議請求");
//            }
//            break;
//            default: {
//              return ErrorEntity(code: errCode, message: "未知錯誤");
//            }
//          }
        } on Exception catch(_) {
          return ErrorEntity(code: -1, message: "未知錯誤");
        }
      }
      break;
      default: {
        return ErrorEntity(code: -1, message: error.message);
      }
    }
  }複製程式碼

完整的 DioManager 類程式碼：

import 'package:dio/dio.dart';
import 'package:flutter_app/network/entity/BaseEntity.dart';
import 'package:flutter_app/network/entity/BaseListEntity.dart';
import 'package:flutter_app/network/entity/EntityFactory.dart';
import 'package:flutter_app/network/entity/ErrorEntity.dart';
import 'package:flutter_app/network/NWApi.dart';
import 'package:flutter_app/network/NWMethod.dart';
class DioManager {
  static final DioManager _shared = DioManager._internal();
  factory DioManager() => _shared;
  Dio dio;
  DioManager._internal() {
    if (dio == null) {
      BaseOptions options = BaseOptions(
        baseUrl: NWApi.baseApi,
        contentType: Headers.jsonContentType,
        responseType: ResponseType.json,
        receiveDataWhenStatusError: false,
        connectTimeout: 30000,
        receiveTimeout: 3000,
      );
      dio = Dio(options);
    }
  }

  // 請求，返回引數為 T
  // method：請求方法，NWMethod.POST等
  // path：請求地址
  // params：請求引數
  // success：請求成功回撥
  // error：請求失敗回撥
  Future request<T>(NWMethod method, String path, {Map params, Function(T) success, Function(ErrorEntity) error}) async {
    try {
      Response response = await dio.request(path, queryParameters: params, options: Options(method: NWMethodValues[method]));
      if (response != null) {
        BaseEntity entity = BaseEntity<T>.fromJson(response.data);
        if (entity.code == 0) {
          success(entity.data);
        } else {
          error(ErrorEntity(code: entity.code, message: entity.message));
        }
      } else {
        error(ErrorEntity(code: -1, message: "未知錯誤"));
      }
    } on DioError catch(e) {
      error(createErrorEntity(e));
    }
  }

  // 請求，返回引數為 List
  // method：請求方法，NWMethod.POST等
  // path：請求地址
  // params：請求引數
  // success：請求成功回撥
  // error：請求失敗回撥
  Future requestList<T>(NWMethod method, String path, {Map params, Function(List<T>) success, Function(ErrorEntity) error}) async {
    try {
      Response response = await dio.request(path, queryParameters: params, options: Options(method: NWMethodValues[method]));
      if (response != null) {
        BaseListEntity entity = BaseListEntity<T>.fromJson(response.data);
        if (entity.code == 0) {
          success(entity.data);
        } else {
          error(ErrorEntity(code: entity.code, message: entity.message));
        }
      } else {
        error(ErrorEntity(code: -1, message: "未知錯誤"));
      }
    } on DioError catch(e) {
      error(createErrorEntity(e));
    }
  }

  // 錯誤資訊
  ErrorEntity createErrorEntity(DioError error) {
    switch (error.type) {
      case DioErrorType.CANCEL:{
        return ErrorEntity(code: -1, message: "請求取消");
      }
      break;
      case DioErrorType.CONNECT_TIMEOUT:{
        return ErrorEntity(code: -1, message: "連線超時");
      }
      break;
      case DioErrorType.SEND_TIMEOUT:{
        return ErrorEntity(code: -1, message: "請求超時");
      }
      break;
      case DioErrorType.RECEIVE_TIMEOUT:{
        return ErrorEntity(code: -1, message: "響應超時");
      }
      break;
      case DioErrorType.RESPONSE:{
        try {
          int errCode = error.response.statusCode;
          String errMsg = error.response.statusMessage;
          return ErrorEntity(code: "$errCode", message: errMsg);
//          switch (errCode) {
//            case 400: {
//              return ErrorEntity(code: errCode, message: "請求語法錯誤");
//            }
//            break;
//            case 403: {
//              return ErrorEntity(code: errCode, message: "伺服器拒絕執行");
//            }
//            break;
//            case 404: {
//              return ErrorEntity(code: errCode, message: "無法連線伺服器");
//            }
//            break;
//            case 405: {
//              return ErrorEntity(code: errCode, message: "請求方法被禁止");
//            }
//            break;
//            case 500: {
//              return ErrorEntity(code: errCode, message: "伺服器內部錯誤");
//            }
//            break;
//            case 502: {
//              return ErrorEntity(code: errCode, message: "無效的請求");
//            }
//            break;
//            case 503: {
//              return ErrorEntity(code: errCode, message: "伺服器掛了");
//            }
//            break;
//            case 505: {
//              return ErrorEntity(code: errCode, message: "不支援HTTP協議請求");
//            }
//            break;
//            default: {
//              return ErrorEntity(code: errCode, message: "未知錯誤");
//            }
//          }
        } on Exception catch(_) {
          return ErrorEntity(code: -1, message: "未知錯誤");
        }
      }
      break;
      default: {
        return ErrorEntity(code: -1, message: error.message);
      }
    }
  }
}複製程式碼

使用：

// 返回 LoginEntity
DioManager().request<LoginEntity>(
  NWMethod.POST,
  NWApi.loginPath,
  params: {"account": "421789838@qq.com", "password": "123456"},
  success: (data) {
      print("success data = $data"});
  }, error: (error) {
      print("error code = ${error.code}, massage = ${error.message}");
  }
);

// 返回 List
DioManager().requestList<LoginEntity>(
  NWMethod.POST,
  NWApi.queryListJsonPath,
  params: {"account": "421789838@qq.com", "password": "123456"},
  success: (data) {
      print("success data = $data"});
  }, error: (error) {
      print("error code = ${error.code}, massage = ${error.message}");
  }
);複製程式碼

Flutter Dio封裝實踐
2021-03-14
Flutter封裝
Flutter 網路請求 Dio 封裝
2021-09-01
Flutter封裝
Flutter Dio原始碼分析(四)--封裝
2021-08-30
Flutter原始碼封裝
Flutter Dio 親媽級別封裝教程
2021-10-20
Flutter封裝
Flutter Dio http簡單封裝與使用
2020-09-23
FlutterHTTP封裝
flutter dio網路請求封裝實現
2020-09-12
Flutter封裝
Flutter 熱門網路請求框架Dio的簡單封裝
2021-03-03
Flutter框架封裝
Flutter 入門與實戰（二十八）：Dio 封裝之金屋藏嬌
2021-07-14
Flutter封裝
二次封裝WebDriverWait
2024-08-26
封裝WebAI
axios二次封裝
2019-02-16
iOS封裝
flutter dio+rxdart
2019-04-30
FlutterDart
Flutter MVP 封裝
2020-03-27
FlutterMVP封裝
Flutter Dio原始碼分析(一)--Dio介紹
2021-08-30
Flutter原始碼
elment dialog二次封裝
2020-11-06
封裝
axios的二次封裝
2020-12-24
iOS封裝
Flutter 封裝：富文字 RichText 極簡封裝
2021-07-31
Flutter封裝
Dapper的封裝、二次封裝、官方擴充套件包封裝，以及ADO.NET原生封裝
2022-01-03
APP封裝套件
OpenResty Redis操作二次封裝
2022-08-29
RESTRedis封裝
axios二次封裝學習
2019-03-04
iOS封裝
Selenium二次封裝-Python版本
2018-08-29
封裝Python
Flutter Dio原始碼分析(二)--HttpClient、Http、Dio對比
2021-08-30
Flutter原始碼HTTPclient
一步一步教你封裝最新版的Dio
2021-05-16
封裝
uview-ui toast 二次封裝
2024-03-22
ViewUIAST封裝
強大的dio封裝，可能滿足你的一切需要
2020-06-14
封裝
selenium-webdriver的二次封裝(十)
2019-02-04
Web封裝
基於Glide4.7.1二次封裝
2018-08-21
IDE封裝
Flutter 入坑指南（dio +fish_redux）
2019-06-16
FlutterRedux
Flutter Dio原始碼分析(三)--深度剖析
2021-08-30
Flutter原始碼
Flutter Http庫Dio 2.1正式釋出
2019-03-12
FlutterHTTP
Flutter Http請求開源庫-dio
2018-05-23
FlutterHTTP
基於python+selenium的二次封裝
2020-01-08
Python封裝
vue介面請求方式axios二次封裝
2018-12-17
VueiOS封裝
小程式二次封裝wx.request方法
2018-09-19
封裝
Vue二次封裝axios為外掛使用
2018-04-28
Vue封裝iOS
Flutter視訊播放封裝歷程
2020-02-24
Flutter封裝
Flutter 基於Bloc框架的封裝
2019-06-20
FlutterBloC框架封裝
Flutter 網路請求框架封裝
2019-03-30
Flutter框架封裝
Disruptor 高效能併發框架二次封裝
2020-07-09
框架封裝

Flutter Dio二次封裝

目錄：

EntityFactory：

BaseEntity：

BaseListEntity：

ErrorEntity：

NWApi：

NWMethod：

下面就可以進行正式的封裝了：

第一步是建立Dio的單例輔助類，並初始化Dio和對Dio進行一些全域性的引數設定：

第二步對請求進行封裝，在我的想法中 {“code”: 0, “message”: “”, “data”: {}} 和 {“code”: 0, “message”: “”, “data”: []} 這兩種資料是要分開兩個請求方法的：

提取請求錯誤處理方法createErrorEntity：

完整的 DioManager 類程式碼：

使用：

相關文章