這是一種有關記住我功能的新實現(xiàn)方式
在傳統(tǒng)的前后端不分離項目中,大家在登錄界面應該經常能看到記住我這個功能,這個功能本質上是為了讓用戶能在一段較長時間內不再重復登錄,在以前的實現(xiàn)方案中,大家多使用 cookie 實現(xiàn),本文給大家介紹在引入了 spring-session-redis 的項目中,使用一種新的實現(xiàn)方式,直接設置 redis 中用戶 session 的有效期來實現(xiàn)。
本文使用 newbeepro 項目作為示例,給大家演示記住我功能的具體實現(xiàn)。項目地址:https://github.com/wayn111/newbee-mall-pro
本文大綱如下,
圖片
1. spring-session 的 yml 配置
圖片
在使用 spring-session 后,我們可以在 spring 的 yml 文件中設置 session 在 redis 中的 key 前綴,在 newbeepro 項目中,我們設置為 newbee_mall,然后我們設置過期時間 3600 秒,也就是一小時。
2. spring-session 的默認序列化方式
@Configuration
public class CacheConfig implements CachingConfigurer {
/**
* 指定spring-session的默認序列化方式
*
* @return RedisSerializer
*/
@Bean("springSessionDefaultRedisSerializer")
public RedisSerializer<Object> redisSerializer() {
return valueSerializer();
}
private RedisSerializer<Object> valueSerializer() {
return new GenericFastJsonRedisSerializer();
}
}
添加 RedisSerializer 類的 bean 實例,并且設置 bean 名稱是 springSessionDefaultRedisSerializer。注意 bean 名稱必須是 springSessionDefaultRedisSerializer。
這一步不是必須的,作用是可以設置 spring-session-redis 的默認序列化實現(xiàn)。當我們設置為 fastjson 的序列化方式時,就可以讓我們方便查看 redis 客戶端。
3. 打開登錄頁面
圖片
當用戶打開 newbeepro 項目前端頁面時,用戶 session 就已經在 redis 中保存了下來,這一點我們通過查看 redis 客戶端發(fā)現(xiàn),此時用戶的 session 信息已經存在,并且有效期是 3600 秒與我們 yml 配置的過期時間是一致的。
圖片
4. 后端登錄接口如何實現(xiàn)記住我
@ResponseBody
@PostMapping("/login")
public R doLogin(MallUserVO mallUserVO,
@RequestParam("destPath") String destPath,
HttpSession session) {
R success = R.success();
MallUser user = mallUserService.getOne(Wrappers.<MallUser>lambdaQuery()
.eq(MallUser::getLoginName, mallUserVO.getLoginName())
.eq(MallUser::getPasswordMd5, Md5Utils.hash(mallUserVO.getPassword())));
if (user == null) {
return R.error("賬戶名稱或者密碼錯誤");
}
if (user.getLockedFlag() == 1) {
return R.error("該賬戶已被禁用");
}
BeanUtils.copyProperties(user, mallUserVO);
session.setAttribute(Constants.MALL_USER_SESSION_KEY, mallUserVO);
String namespace = environment.getProperty("spring.session.redis.namespace");
String sessionKey = namespace + ":sessions:" + session.getId()
int timeout = Integer.parseInt(environment.getProperty("spring.session.timeout"));
if (mallUserVO.isRememberme()) {
redisCache.setCacheMapValue(sessionKey, "maxInactiveInterval", timeout * 24 * 7);
} else {
redisCache.setCacheMapValue(sessionKey, "maxInactiveInterval", timeout);
}
if (StringUtils.isNotEmpty(destPath) && StringUtils.contains(destPath, "=")) {
success.add("destPath", destPath.split("=")[1].substring(1));
}
return success;
}
在登錄接口中,我們可以通過 mallUserVO.isRememberme() 方法來判斷用戶是否點擊了記住我按鈕,在前面的第三步中,我們可以看到用戶的 session 在 redis 中 的 key 名稱是 newbee_mall:sessions:c3fd288e-c9c2-47e6-961b-a5e1e0a3205e。
這里給大家講解一下這個 key 的拼接邏輯。
圖片
OK,根據(jù)這個拼接邏輯,我們拼接 session key 的實現(xiàn)代碼就是,
String namespace = environment.getProperty("spring.session.redis.namespace");
String sessionKey = namespace + ":sessions:" + session.getId()
然后大家在用戶 session key 的 hash 內容里可以發(fā)現(xiàn)有一個 hashKey 名稱是 maxInactiveInterval,它就是用戶 session 的有效期屬性,我們可以通過改變 maxInactiveInterval 的屬性值來延長用戶 session 的有效期,以此來實現(xiàn)記住我功能。
圖片
那我們就可以通過 redisCache 實例來直接設置用戶 session 的有效期,代碼如下,
redisCache.setCacheMapValue(sessionKey, "maxInactiveInterval", timeout * 24 * 7)
5. 登錄成功
當用戶勾選了記住我按鈕,登錄成功后,我們來看下 redis 客戶端,
圖片
OK,大功告成。
總結一下
本文給大家講解了在使用 spring-session-redis 的項目中,如何通過延長用戶 session 的有效期來達到記住我功能的一致效果。
大家在學習本文后,也可以把記住我功能應用到自己的項目中,本文實例代碼都在 newbeepro 項目中可以找到。