其实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二次封装的资料请关注其它相关文章!