Redis的共享session應(yīng)用實(shí)現(xiàn)短信登錄
1. 基于 session 實(shí)現(xiàn)短信登錄
1.1 短信登錄流程圖
1.2 實(shí)現(xiàn)發(fā)送短信驗(yàn)證碼
前端請求說明:
說明 | |
---|---|
請求方式 | POST |
請求路徑 | /user/code |
請求參數(shù) | phone(電話號碼) |
返回值 | 無 |
后端接口實(shí)現(xiàn):
@Slf4j @Service public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements IUserService { @Override public Result sendCode(String phone, HttpSession session) { // 1. 校驗(yàn)手機(jī)號 if(RegexUtils.isPhoneInvalid(phone)){ // 2. 如果不符合,返回錯(cuò)誤信息 return Result.fail("手機(jī)號格式錯(cuò)誤!"); } // 3. 符合,生成驗(yàn)證碼(設(shè)置生成6位) String code = RandomUtil.randomNumbers(6); // 4. 保存驗(yàn)證碼到 session session.setAttribute("code", code); // 5. 發(fā)送驗(yàn)證碼(這里并未實(shí)現(xiàn),通過日志記錄) log.debug("發(fā)送短信驗(yàn)證碼成功,驗(yàn)證碼:{}", code); // 返回 ok return Result.ok(); } }
1.3 實(shí)現(xiàn)短信驗(yàn)證碼登錄、注冊
前端請求說明
說明 | |
---|---|
請求方式 | POST |
請求路徑 | /user/login |
請求參數(shù) | phone(電話號碼);code(驗(yàn)證碼) |
返回值 | 無 |
后端接口實(shí)現(xiàn):
@Slf4j @Service public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements IUserService { @Override public Result login(LoginFormDTO loginForm, HttpSession session) { // 1. 校驗(yàn)手機(jī)號 String phone = loginForm.getPhone(); if(RegexUtils.isPhoneInvalid(phone)){ // 不一致,返回錯(cuò)誤信息 return Result.fail("手機(jī)號格式錯(cuò)誤!"); } // 2. 校驗(yàn)驗(yàn)證碼 String cacheCode = (String) session.getAttribute("code"); String code = loginForm.getCode(); if(cacheCode == null || !cacheCode.equals(cacheCode)){ // 不一致,返回錯(cuò)誤信息 return Result.fail("驗(yàn)證碼錯(cuò)誤!"); } // 4. 一致,根據(jù)手機(jī)號查詢用戶(這里使用的 mybatis-plus) User user = query().eq("phone", phone).one(); // 5. 判斷用戶是否存在 if(user == null){ // 6. 不存在,創(chuàng)建新用戶并保存 user = createUserWithPhone(phone); } // 7. 保存用戶信息到 session 中(通過 BeanUtil.copyProperties 方法將 user 中的信息過濾到 UserDTO 上,即用來隱藏部分信息) session.setAttribute("user", BeanUtil.copyProperties(user, UserDTO.class)); return Result.ok(); } private User createUserWithPhone(String phone) { // 1. 創(chuàng)建用戶 User user = new User(); user.setPhone(phone); user.setNickName("user_" + RandomUtil.randomString(10)); // 2. 保存用戶(這里使用 mybatis-plus) save(user); return user; } }
1.4 實(shí)現(xiàn)登錄校驗(yàn)攔截器
登錄校驗(yàn)攔截器實(shí)現(xiàn):
public class LoginInterceptor implements HandlerInterceptor { @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { // 1. 獲取 session HttpSession session = request.getSession(); // 2. 獲取 session 中的用戶 UserDTO user = (UserDTO) session.getAttribute("user"); // 3. 判斷用戶是否存在 if(user == null){ // 4. 不存在,攔截,返回 401 未授權(quán) response.setStatus(401); return false; } // 5. 存在,保存用戶信息到 ThreadLocal UserHolder.saveUser(user); // 6. 放行 return true; } @Override public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { // 移除用戶,避免內(nèi)存泄露 UserHolder.removeUser(); } }
UserHolder 類的實(shí)現(xiàn): 該類中定義了一個(gè)靜態(tài)的 ThreadLocal
public class UserHolder { private static final ThreadLocal<UserDTO> tl = new ThreadLocal<>(); public static void saveUser(UserDTO user){ tl.set(user); } public static UserDTO getUser(){ return tl.get(); } public static void removeUser(){ tl.remove(); } }
配置攔截器:
@Configuration public class MvcConfig implements WebMvcConfigurer { @Override public void addInterceptors(InterceptorRegistry registry) { registry.addInterceptor(new LoginInterceptor()) .excludePathPatterns( "/user/login", "/user/code" ); } }
前端請求說明:
說明 | |
---|---|
請求方式 | POST |
請求路徑 | /user/me |
請求參數(shù) | 無 |
返回值 | 無 |
后端接口實(shí)現(xiàn):
@Slf4j @Service public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements IUserService { @Override public Result me() { UserDTO user = UserHolder.getUser(); return Result.ok(user); } }
2. 集群的 session 共享問題
session 共享問題:
多臺(tái) tomcat 并不共享 session 存儲(chǔ)空間,當(dāng)請求切換到不同 tomcat 服務(wù)時(shí)會(huì)導(dǎo)致數(shù)據(jù)丟失的問題。
session 的替代方案應(yīng)該滿足以下條件:
- 數(shù)據(jù)共享(不同的 tomcat 都能夠訪問 Redis 中的數(shù)據(jù))
- 內(nèi)存存儲(chǔ)(Redis 通過內(nèi)存存儲(chǔ))
- key、value 結(jié)構(gòu)(Redis 是 key-value 結(jié)構(gòu))
3. 基于 Redis 實(shí)現(xiàn)共享 session 登錄
3.1 Redis 實(shí)現(xiàn)共享 session 登錄流程圖
3.2 實(shí)現(xiàn)發(fā)送短信驗(yàn)證碼
前端請求說明:
說明 | |
---|---|
請求方式 | POST |
請求路徑 | /user/code |
請求參數(shù) | phone(電話號碼) |
返回值 | 無 |
后端接口實(shí)現(xiàn):
@Slf4j @Service public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements IUserService { @Resource private StringRedisTemplate stringRedisTemplate; @Override public Result sendCode(String phone, HttpSession session) { // 1. 校驗(yàn)手機(jī)號 if (RegexUtils.isPhoneInvalid(phone)) { // 2. 如果不符合,返回錯(cuò)誤信息 return Result.fail("手機(jī)號格式錯(cuò)誤!"); } // 3. 符合,生成驗(yàn)證碼(設(shè)置生成6位) String code = RandomUtil.randomNumbers(6); // 4. 保存驗(yàn)證碼到 Redis(以手機(jī)號為 key,設(shè)置有效期為 2min) stringRedisTemplate.opsForValue().set("login:code:" + phone, code, 2, TimeUnit.MINUTES); // 5. 發(fā)送驗(yàn)證碼(這里并未實(shí)現(xiàn),通過日志記錄) log.debug("發(fā)送短信驗(yàn)證碼成功,驗(yàn)證碼:{}", code); // 返回 ok return Result.ok(); } }
3.3 實(shí)現(xiàn)短信驗(yàn)證碼登錄、注冊
前端請求說明:
說明 | |
---|---|
請求方式 | POST |
請求路徑 | /user/login |
請求參數(shù) | phone(電話號碼);code(驗(yàn)證碼) |
返回值 | 無 |
后端接口實(shí)現(xiàn):
@Slf4j @Service public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements IUserService { @Override public Result login(LoginFormDTO loginForm, HttpSession session) { // 1. 校驗(yàn)手機(jī)號 String phone = loginForm.getPhone(); if(RegexUtils.isPhoneInvalid(phone)){ // 不一致,返回錯(cuò)誤信息 return Result.fail("手機(jī)號格式錯(cuò)誤!"); } // 2. 校驗(yàn)驗(yàn)證碼 String cacheCode = (String) session.getAttribute("code"); String code = loginForm.getCode(); if(cacheCode == null || !cacheCode.equals(cacheCode)){ // 不一致,返回錯(cuò)誤信息 return Result.fail("驗(yàn)證碼錯(cuò)誤!"); } // 4. 一致,根據(jù)手機(jī)號查詢用戶(這里使用的 mybatis-plus) User user = query().eq("phone", phone).one(); // 5. 判斷用戶是否存在 if(user == null){ // 6. 不存在,創(chuàng)建新用戶并保存 user = createUserWithPhone(phone); } // 7. 保存用戶信息到 session 中(通過 BeanUtil.copyProperties 方法將 user 中的信息過濾到 UserDTO 上,即用來隱藏部分信息) session.setAttribute("user", BeanUtil.copyProperties(user, UserDTO.class)); return Result.ok(); } private User createUserWithPhone(String phone) { // 1. 創(chuàng)建用戶 User user = new User(); user.setPhone(phone); user.setNickName("user_" + RandomUtil.randomString(10)); // 2. 保存用戶(這里使用 mybatis-plus) save(user); return user; } }
3.4 實(shí)現(xiàn)登錄校驗(yàn)攔截器
這里將原有的一個(gè)攔截器分成兩個(gè)攔截器,第一個(gè)攔截器對所有的請求進(jìn)行攔截,每次攔截刷新 token 的有效期,并將能查詢到的用戶信息保存到 ThreadLocal 中。第二個(gè)攔截器則進(jìn)行攔截功能,對需要登錄的路徑進(jìn)行攔截。
刷新 token 攔截器實(shí)現(xiàn):
public class RefreshTokenInterceptor implements HandlerInterceptor { private StringRedisTemplate stringRedisTemplate; public RefreshTokenInterceptor(StringRedisTemplate stringRedisTemplate){ this.stringRedisTemplate = stringRedisTemplate; } @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { // 1. 獲取請求頭中的 token String token = request.getHeader("authorization"); if (StrUtil.isBlank(token)) { return true; } // 2. 基于 token 獲取 redis 中的用戶 String tokenKey = "login:token:" + token; Map<Object, Object> userMap = stringRedisTemplate.opsForHash().entries(tokenKey); // 3. 判斷用戶是否存在 if (userMap.isEmpty()) { return true; } // 5. 將查詢到的 Hash 數(shù)據(jù)轉(zhuǎn)為 UserDTO 對象 UserDTO user = BeanUtil.fillBeanWithMap(userMap, new UserDTO(), false); // 6. 存在,保存用戶信息到 ThreadLocal UserHolder.saveUser(user); // 7. 刷新 token 有效期 30 min stringRedisTemplate.expire(tokenKey, 30, TimeUnit.MINUTES); // 8. 放行 return true; } }
登錄校驗(yàn)攔截器實(shí)現(xiàn):
public class LoginInterceptor implements HandlerInterceptor { @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { // 1. 獲取 session HttpSession session = request.getSession(); // 2. 獲取 session 中的用戶 UserDTO user = (UserDTO) session.getAttribute("user"); // 3. 判斷用戶是否存在 if(user == null){ // 4. 不存在,攔截,返回 401 未授權(quán) response.setStatus(401); return false; } // 5. 存在,保存用戶信息到 ThreadLocal UserHolder.saveUser(user); // 6. 放行 return true; } @Override public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { // 移除用戶,避免內(nèi)存泄露 UserHolder.removeUser(); } }
UserHolder 類的實(shí)現(xiàn): 該類中定義了一個(gè)靜態(tài)的 ThreadLocal
public class UserHolder { private static final ThreadLocal<UserDTO> tl = new ThreadLocal<>(); public static void saveUser(UserDTO user){ tl.set(user); } public static UserDTO getUser(){ return tl.get(); } public static void removeUser(){ tl.remove(); } }
配置攔截器:
@Configuration public class MvcConfig implements WebMvcConfigurer { @Resource private StringRedisTemplate stringRedisTemplate; @Override public void addInterceptors(InterceptorRegistry registry) { registry.addInterceptor(new RefreshTokenInterceptor(stringRedisTemplate)) .addPathPatterns("/**").order(0); registry.addInterceptor(new LoginInterceptor()) .excludePathPatterns( "/user/login", "/user/code" ).order(1); } }
前端請求說明:
說明 | |
---|---|
請求方式 | POST |
請求路徑 | /user/me |
請求參數(shù) | 無 |
返回值 | 無 |
后端接口實(shí)現(xiàn):
@Slf4j @Service public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements IUserService { @Override public Result me() { UserDTO user = UserHolder.getUser(); return Result.ok(user); } }
到此這篇關(guān)于Redis的共享session應(yīng)用實(shí)現(xiàn)短信登錄的文章就介紹到這了,更多相關(guān)Redis session 短信登錄內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
Redisson實(shí)現(xiàn)Redis分布式鎖的幾種方式
本文在講解如何使用Redisson實(shí)現(xiàn)Redis普通分布式鎖,以及Redlock算法分布式鎖的幾種方式的同時(shí),也附帶解答這些同學(xué)的一些疑問,感興趣的可以了解一下2021-08-08redis中zSet實(shí)現(xiàn)排行榜的使用示例
在工作中,有時(shí)候需要實(shí)現(xiàn)排行榜功能,本文主要介紹了redis中zSet實(shí)現(xiàn)排行榜的使用示例,具有一定的參考價(jià)值,感興趣的可以了解一下2023-10-10