Flutter Dio源码分析(四)--封装
Posted
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Flutter Dio源码分析(四)--封装相关的知识，希望对你有一定的参考价值。
参考技术AFlutter Dio源码分析(一)--Dio介绍
Flutter Dio源码分析(二)--HttpClient、Http、Dio对比
Flutter Dio源码分析(三)--深度剖析
Flutter Dio源码分析(四)--封装
Flutter Dio源码分析(一)--Dio介绍视频教程
Flutter Dio源码分析(二)--HttpClient、Http、Dio对比视频教程
Flutter Dio源码分析(三)--深度剖析视频教程
Flutter Dio源码分析(四)--封装视频教程
github仓库地址
本文会手把手教你该怎么去封装一个类库，平时在我们的工作中都是拿着别人的造好的轮子在使用，这篇文章将带你怎么去自己造轮子，以后再碰到别的类库需要对其进行封装的时候提供一个的思路和方法。
在前面的文章中，我们对 Dio 的基本使用、请求库对比、源码分析，我们知道 Dio 的使用非常的简单，那为什么还需要进行封装呢？有两点如下：
当组件库方法发生重要改变需要迁移的时候如果有多处地方用到，那么需要对使用到的每个文件都进行修改，非常的繁琐而且很容易出问题。
当不需要 Dio 库的时候，我们可以随时方便切换到别的网络请求库，当然 Dio 目前内置支持使用第三方库的适配器。
因为一个应用程序基本都是统一的配置方式，所以我们可以针对 拦截器 、 转换器 、 缓存 、 统一处理错误 、 代理配置 、 证书校验 等多个配置进行统一管理。
因为我们的应用程序在每个页面中都会用到网络请求，那么如果我们每次请求的时候都去实例化一个 Dio ，无非是增加了系统不必要的开销，而使用单例模式对象一旦创建每次访问都是同一个对象，不需要再次实例化该类的对象。
这是通过静态变量的私有构造器来创建的单例模式
我们对 超时时间 、 响应时间 、 BaseUrl 进行统一设置
因为不管是 get() 还是 post() 请求， Dio 内部最终都会调用 request 方法，只是传入的 method 不一样，所以我们这里定义一个枚举类型在一个方法中进行处理
我们已经把 Restful API 风格简化成了一个方法，通过 DioMethod 来标明不同的请求方式。在我们平时开发的过程中，需要在请求前、响应前、错误时对某一些接口做特殊的处理，那我们就需要用到拦截器。 Dio 为我们提供了自定义拦截器功能，很容易轻松的实现对请求、响应、错误时进行拦截
我们发现虽然 Dio 框架已经封装了一个 DioError 类库，但如果需要对返回的错误进行统一弹窗处理或者路由跳转等就只能自定义了
在我们发送请求的时候会碰到几种情况，比如需要对非open开头的接口自动加上一些特定的参数，获取需要在请求头增加统一的 token
在我们请求接口前可以对响应数据进行一些基础的处理，比如对响应的结果进行自定义封装，还可以针对单独的 url 做特殊处理等。
我们看了转换器的介绍，发现和拦截器的功能差不多，那为什么还要存在转换器，有两点：
执行流程： 请求拦截器 >> 请求转换器 >> 发起请求 >> 响应转换器 >> 响应拦截器 >> 最终结果 。
只会被用于 \'PUT\'、 \'POST\'、 \'PATCH\'方法，因为只有这些方法才可以携带请求体(request body)
会被用于所有请求方法的返回数据。
在开发过程中，客户端和服务器打交道的时候，往往会用一个 token 来做校验，因为每个公司处理刷新token的逻辑都不一样，我这里举一个简单的例子
为什么我们需要有取消请求的功能，如果当我们的页面在发送请求时，用户主动退出当前界面或者app应用程序退出的时候数据还没有响应，那我们就需要取消该网络请求，防止不必要的错误。
由 服务器生成 的 一小段文本信息 ，发送给浏览器，浏览器把 cookie 以kv形式保存到本地 某个目录下的文本文件内，下一次请求同一网站时会把该 cookie 发送给服务器。
cookie 的使用需要用到两个第三方组件 dio_cookie_manager 和 cookie_jar
因为在我们平时的开发过程中，会碰到一种情况，在进行网络请求时，我们希望能正常访问到上次的数据，对于用户的体验比较好，而不是展示一个空白的页面，该缓存主要是 《Flutter实战》网络接口缓存 提供参考。
我们在程序退出后内存缓存将会消失，所以我们用 shared_preferences 进行磁盘缓存数据。
在我们用flutter进行抓包的时候需要配置 Dio 代理。由 DefaultHttpClientAdapter 提供了一个 onHttpClientCreate 回调来设置底层 HttpClient 的代理。
用于验证正在访问的网站是否真实。提供安全性，因为证书和域名绑定，并且由根证书机构签名确认。
日志打印主要是帮助我们开发时进行辅助排错
赠书|Flutter-dio封装，满足你的需要
作者 | 艾维码 地址 | juejin.im/post/5ee5d2c1e51d45788619dcc2
前言
dio是一个强大的Dart Http请求库，支持Restful API、FormData、拦截器、请求取消、Cookie管理、文件上传/下载、超时、自定义适配器等..
基本使用
添加依赖
dependencies:
dio: ^3.x.x // 请使用pub上3.0.0分支的最新版本
发起一个 GET 请求 :
Response response;
Dio dio = Dio();
response = await dio.get("/test?id=12&name=wendu")
print(response.data.toString());
// 请求参数也可以通过对象传递，上面的代码等同于：
response = await dio.get("/test", queryParameters: {"id": 12, "name": "wendu"});
print(response.data.toString());
发起一个 POST 请求 :
response = await dio.post("/test", data: {"id": 12, "name": "wendu"});
发起多个并发请求:
response = await Future.wait([dio.post("/info"), dio.get("/token")]);
下载文件:
response = await dio.download("https://www.google.com/", "./xx.html");
发送 FormData:
FormData formData = FormData.from({
"name": "wendux",
"age": 25,
});
response = await dio.post("/info", data: formData);
通过FormData上传多个文件:
FormData.fromMap({
"name": "wendux",
"age": 25,
"file": await MultipartFile.fromFile("./text.txt",filename: "upload.txt"),
"files": [
await MultipartFile.fromFile("./text1.txt", filename: "text1.txt"),
await MultipartFile.fromFile("./text2.txt", filename: "text2.txt"),
]
});
response = await dio.post("/info", data: formData);
封装Dio
为什么要封装 dio
上面看了dio的api，非常灵活和简单，那么为什么还要封装呢？因为我们开发需要统一的配置场景。比如：
全局token验证 自定义拦截器 缓存处理 统一封装业务错误逻辑 代理配置 重试机制 log输出
代理配置：
flutter抓包需要配置dio代理，所以我们实现一个代理配置,proxy.dart：
// 是否启用代理
const PROXY_ENABLE = false;
/// 代理服务IP
// const PROXY_IP = '192.168.1.105';
const PROXY_IP = '172.16.43.74';
/// 代理服务端口
const PROXY_PORT = 8866;
错误处理：
一般错误分为网络错误、请求错误、认证错误、服务器错误，所以实现统一的错误处理，认证错误需要登录等认证，所以单独一个类型，请求错误也单独设置一个类型，方便我们定位错误，app_exceptions.dart：
import 'package:dio/dio.dart';
/// 自定义异常
class AppException implements Exception {
final String _message;
final int _code;
AppException([
this._code,
this._message,
]);
String toString() {
return "$_code$_message";
}
factory AppException.create(DioError error) {
switch (error.type) {
case DioErrorType.CANCEL:
{
return BadRequestException(-1, "请求取消");
}
break;
case DioErrorType.CONNECT_TIMEOUT:
{
return BadRequestException(-1, "连接超时");
}
break;
case DioErrorType.SEND_TIMEOUT:
{
return BadRequestException(-1, "请求超时");
}
break;
case DioErrorType.RECEIVE_TIMEOUT:
{
return BadRequestException(-1, "响应超时");
}
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 BadRequestException(errCode, "请求语法错误");
}
break;
case 401:
{
return UnauthorisedException(errCode, "没有权限");
}
break;
case 403:
{
return UnauthorisedException(errCode, "服务器拒绝执行");
}
break;
case 404:
{
return UnauthorisedException(errCode, "无法连接服务器");
}
break;
case 405:
{
return UnauthorisedException(errCode, "请求方法被禁止");
}
break;
case 500:
{
return UnauthorisedException(errCode, "服务器内部错误");
}
break;
case 502:
{
return UnauthorisedException(errCode, "无效的请求");
}
break;
case 503:
{
return UnauthorisedException(errCode, "服务器挂了");
}
break;
case 505:
{
return UnauthorisedException(errCode, "不支持HTTP协议请求");
}
break;
default:
{
// return ErrorEntity(code: errCode, message: "未知错误");
return AppException(errCode, error.response.statusMessage);
}
}
} on Exception catch (_) {
return AppException(-1, "未知错误");
}
}
break;
default:
{
return AppException(-1, error.message);
}
}
}
}
/// 请求错误
class BadRequestException extends AppException {
BadRequestException([int code, String message]) : super(code, message);
}
/// 未认证异常
class UnauthorisedException extends AppException {
UnauthorisedException([int code, String message]) : super(code, message);
}
Error拦截器：
有了上面的异常类型，我们要把DioError变成自己定义的异常：
import 'package:dio/dio.dart';
import 'package:flutter/material.dart';
import 'app_exceptions.dart';
/// 错误处理拦截器
class ErrorInterceptor extends Interceptor {
@override
Future onError(DioError err) {
// error统一处理
AppException appException = AppException.create(err);
// 错误提示
debugPrint('DioError===: ${appException.toString()}');
err.error = appException;
return super.onError(err);
}
}
增加取消功能：
/*
* 取消请求
*
* 同一个cancel token 可以用于多个请求，当一个cancel token取消时，所有使用该cancel token的请求都会被取消。
* 所以参数可选
*/
void cancelRequests({CancelToken token}) {
token ?? _cancelToken.cancel("cancelled");
}
增加认证header：
/// 读取本地配置
Map<String, dynamic> getAuthorizationHeader() {
var headers;
String accessToken = Global.accessToken;
if (accessToken != null) {
headers = {
'Authorization': 'Bearer $accessToken',
};
}
return headers;
}
添加cookie和cache：
添加cookie管理：
cookie_jar: ^1.0.1
dio_cookie_manager: ^1.0.0
// Cookie管理
CookieJar cookieJar = CookieJar();
dio.interceptors.add(CookieManager(cookieJar));
// 加内存缓存
dio.interceptors.add(NetCache());
利用sp做磁盘缓存： shared_preferences: ^0.5.6+3
dio加入缓存：
// 加内存缓存
dio.interceptors.add(NetCacheInterceptor());
重试拦截器：
在网络断开的时候，监听网络，等重连的时候重试：
import 'dart:io';
import 'package:dio/dio.dart';
import 'package:flutter/cupertino.dart';
import 'connectivity_request_retrier.dart';
class RetryOnConnectionChangeInterceptor extends Interceptor {
final DioConnectivityRequestRetrier requestRetrier;
RetryOnConnectionChangeInterceptor({
@required this.requestRetrier,
});
@override
Future onError(DioError err) async {
if (_shouldRetry(err)) {
try {
return requestRetrier.scheduleRequestRetry(err.request);
} catch (e) {
return e;
}
}
return err;
}
bool _shouldRetry(DioError err) {
return err.type == DioErrorType.DEFAULT &&
err.error != null &&
err.error is SocketException;
}
}
添加重试拦截器：
if (Global.retryEnable) {
dio.interceptors.add(
RetryOnConnectionChangeInterceptor(
requestRetrier: DioConnectivityRequestRetrier(
dio: Dio(),
connectivity: Connectivity(),
),
),
);
}
使用
初始化：
void main() {
HttpUtils.init(
baseUrl: "https://gan.io/",
);
runApp(MyApp());
}
在model里写接口请求：
static Future<ApiResponse<CategoryEntity>> getCategories() async {
try {
final response = await HttpUtils.get(categories);
var data = CategoryEntity.fromJson(response);
return ApiResponse.completed(data);
} on DioError catch (e) {
return ApiResponse.error(e.error);
}
}
调用：
void getCategories() async {
ApiResponse<CategoryEntity> entity = await GanRepository.getCategories();
print(entity.data.data.length);
}
第十四期
今天联合机械工业出版社华章公司送出三本书籍《Flutter实战入门》
「推荐语」作者手把手带领读者进入Flutter开发世界，方法简单，效果明显，凝聚了作者多年的实际项目经验。
「自费购书链接」
以上是关于Flutter Dio源码分析(四)--封装的主要内容，如果未能解决你的问题，请参考以下文章