Android编程
搜索
分类

Flutter Dio二次封装的实现

作者：头发还没秃 时间：2022-08-27 08:56:05　

目录：

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

来源：https://juejin.im/post/5e158957f265da5d637fff8c

标签：Flutter,Dio,封装
0
投稿

猜你喜欢

  • java swing实现的扫雷游戏及改进版完整示例

    2022-02-27 02:01:18

  • java基础实现猜数字小游戏

    2021-05-24 07:53:25

  • Java中final与继承操作实例分析

    2023-09-14 08:56:02

  • C# 站点IP访问频率限制 针对单个站点的实现方法

    2023-09-23 18:35:30

  • java关键字final使用方法详解

    2023-11-28 22:38:04

  • C#设置MDI子窗体只能弹出一个的方法

    2022-03-19 23:40:11

  • Android自定义TextView跑马灯效果

    2023-08-07 01:14:57

  • Android天气预报之基于HttpGet对象解析天气数据的方法

    2021-11-01 08:00:13

  • Android官方下拉刷新控件SwipeRefreshLayout使用详解

    2021-11-27 16:38:33

  • Java SoftReference类案例详解

    2023-04-07 06:52:29

  • Spring Cloud Ribbon的踩坑记录与原理详析

    2023-02-06 04:06:55

  • Java集合中的fail-fast(快速失败)机制详解

    2023-05-10 16:31:33

  • Java实现map转换成json的方法详解

    2022-09-09 12:26:03

  • SpringBoot自定义启动器Starter流程详解

    2022-08-25 08:28:19

  • C#利用Task实现任务超时多任务一起执行的方法

    2023-07-04 20:03:38

  • 区分C# 中的 Struct 和 Class

    2022-09-10 19:51:25

  • 为SpringBoot服务添加HTTPS证书的方法

    2023-10-11 03:03:22

  • c#读写ini配置文件示例

    2023-09-29 16:31:36

  • 图解Java经典算法冒泡排序的原理与实现

    2023-03-14 21:41:23

  • Android 配置gradle实现VersionCode自增实例

    2021-07-03 12:39:23
    • asp之家 软件编程 m.aspxhome.com