话说那时候仍是学生,有一年春运,冒着风雪在北京北站买回家的票。悲催的是,特快车的票没买着,只买到了绿皮火车,L 打头的临时车。更悲催的是,本来33个小时的车程(特快不到20个小时),结果……走走停停超过了40多个小时,那煎熬,感受永无尽头!前端
换个别的方式吧!因而我提早下车了,下车到了出站口,车站检票人员瞄了一眼个人车牌,眼神有点奇怪,估计是在想这小伙子是否是傻。还好个人票到站点是更远的站,不须要补票。其余没票的,就被嚷嚷着补票了——那个时候为了能回家,多少人是偷偷混上车的啊! 之前是一把心酸一把泪,如今回忆起来那都是年少时可贵的经历啊!git
火车票就好像咱们后台的会话 Session同样,坐火车的这个过程就是咱们的会话过程。咱们须要先买票才能上车,下车出站票就失效了。本篇咱们就来介绍Dio如何使用会话Session保持登陆状态。首先请更新后台代码:gitee.com/island-code…,涉及到的接口以下:express
先拿 Postman 走一遍流程作一下接口自测(咱们的口号是真正的全栈:产品->设计->后端->前端->测试->运维一条龙服务)。过程见下图:json
能够看到整个会话过程以下:后端
sessionId
字段(字段名由后端定),这里就是登陆人的会话信息。这个过程对于咱们使用 Postman 是无感知的,就比如咱们用浏览器访问网页同样。可是对于 App 来讲就不同了。App自己是不会自动把登陆会话信息携带到其余接口的,也就是说若是咱们登陆成功后不作会话处理,那么其余涉及到须要会话信息的接口所有会失败!这就比如咱们买了张火车票,可是弄丢了,傻乎乎地跑到检票口才发现进不了站!!!api
怎么办?首先是在买票环节咱们要把票保存好,在咱们的 HttpUtil
中找一个严实的口袋保存车票,这个口袋就是 Dio 的 options.headers
。当咱们往 options 里存放信息时,每次请求都会携带这些信息到后端(除非请求自己将其参数覆盖)。数组
static void setCookie(String cookie) {
_dioInstance.options.headers['Cookie'] = cookie;
}
复制代码
options
是 Dio 的默认请求配置,是一个BaseOptions
对象,包括了不少属性,例如请求方法、响应类型、请求内容类型,链接超时时间、默认查询参数、请求头等等,经过设置 options 咱们能够设置不少默认的参数,从而避免处处设置。常见的设置有:浏览器
connectTimeout
,能够根据须要设置超时时长。contentType
,是一个字符串,默认是:application/json; charset=utf-8
。能够在 headers
里设置也能够指定。responseType
,是一个枚举,默认是 json
。queryParameters
,一个Map
对象,假设接口有默认的请求参数(如终端类型,版本号这类)能够加入到这里。headers
,也就是咱们今天的主角,能够设置请求的 cookie 信息或者其余参数(好比 JWT 的 token,后端要求传递的其余通用参数)。其中 cookie 固定使用 Cookie 字段存储,固然若是后端要自定义别的字段也是能够的。找着了口袋,咱们买完票后就须要把票存放起来,也就是登陆成功后要获取到后端设置的 cookie,这个是在响应头里,调试的时候能够打印出来整个 headers
查看,以下所示:bash
实际 cookie
存在response.headers.map['set-cookie']
中,注意这是一个数组,咱们这里由于只有一个 cookie
,所以取第一个元素再调用 HttpUtil
的 setCookie
便可。登陆处理业务逻辑以下:markdown
_handleSubmit(String username, String password) async {
EasyLoading.showInfo('请稍候...');
var response = await AuthService.login(username, password);
if (response != null && response.statusCode == 200) {
EasyLoading.showSuccess('登陆成功');
if (response.headers.map['set-cookie'] != null) {
HttpUtil.setCookie(response.headers.map['set-cookie'][0]);
}
Navigator.of(context).pop();
} else {
EasyLoading.showInfo(response.statusMessage);
}
EasyLoading.dismiss();
}
复制代码
这样,主要咱们不退出登陆,咱们就能够携带会话信息与后端友好地交互了——碰到查票的你也不用心慌了!
下车了,之前票默认是要回收的,可千万别只是返回到登陆页面哦!退出登陆时 调用后端的退出登陆接口,成功后须要清除掉本地的存储的session
。clearCookie
方法很简单,只是将 headers
的 Cookie
设置为 null
便可。
void _logout() async {
var response = await AuthService.logout();
if (response != null && response.statusCode == 200) {
HttpUtil.clearCookie();
EasyLoading.showSuccess('已退出登陆');
} else {
print('logout Failed');
}
}
复制代码
static void clearCookie() {
_dioInstance.options.headers['Cookie'] = null;
}
复制代码
有了这个,咱们就能够像乘务员那样验票了。验票这里只是调用了后端的一个须要会话信息的接口来验证。
void _checkSession() async {
var response = await AuthService.checkSession();
if (response != null && response.statusCode == 200) {
print(response.data);
EasyLoading.showSuccess('验票经过,持票人:' + response.data['loginUser']);
} else {
print('Request Failed');
}
}
复制代码
运行效果以下图:
本篇介绍了 Dio如何在登陆后携带会话信息,以免其余须要登陆鉴权的接口请求失败。须要注意的是,会话信息在退出登陆后须要及时清除,同时,会话信息可能还携带失效时间信息,能够根据失效时间来判断是否须要从新登陆。另外,Dio官方推荐的 Cookie 管理插件是dio_cookie_manager。dio_cookie_manager
使用拦截器来管理 Cookie,支持使用 CookieJar 来在内存存放 Cookie,或使用 PersistCookieJar持久化Cookie。