Redis的共享session應用實現(xiàn)短信登錄
更新時間：2022年08月17日 08:45:30 作者：吞吞吐吐大魔王
本文主要介紹了Redis的共享session應用實現(xiàn)短信登錄，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧
1. 基于 session 實現(xiàn)短信登錄
1.1 短信登錄流程圖
1.2 實現(xiàn)發(fā)送短信驗證碼
前端請求說明：
| 說明 | |
|---|---|
| 請求方式 | POST |
| 請求路徑 | /user/code |
| 請求參數(shù) | phone（電話號碼） |
| 返回值 | 無 |
后端接口實現(xiàn)：
@Slf4j
@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements IUserService {
@Override
public Result sendCode(String phone, HttpSession session) {
// 1. 校驗手機號
if(RegexUtils.isPhoneInvalid(phone)){
// 2. 如果不符合，返回錯誤信息
return Result.fail("手機號格式錯誤！");
}
// 3. 符合，生成驗證碼（設置生成6位）
String code = RandomUtil.randomNumbers(6);
// 4. 保存驗證碼到 session
session.setAttribute("code", code);
// 5. 發(fā)送驗證碼（這里并未實現(xiàn)，通過日志記錄）
log.debug("發(fā)送短信驗證碼成功，驗證碼：{}", code);
// 返回 ok
return Result.ok();
}
}
1.3 實現(xiàn)短信驗證碼登錄、注冊
前端請求說明
| 說明 | |
|---|---|
| 請求方式 | POST |
| 請求路徑 | /user/login |
| 請求參數(shù) | phone（電話號碼）；code（驗證碼） |
| 返回值 | 無 |
后端接口實現(xiàn)：
@Slf4j
@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements IUserService {
@Override
public Result login(LoginFormDTO loginForm, HttpSession session) {
// 1. 校驗手機號
String phone = loginForm.getPhone();
if(RegexUtils.isPhoneInvalid(phone)){
// 不一致，返回錯誤信息
return Result.fail("手機號格式錯誤！");
}
// 2. 校驗驗證碼
String cacheCode = (String) session.getAttribute("code");
String code = loginForm.getCode();
if(cacheCode == null || !cacheCode.equals(cacheCode)){
// 不一致，返回錯誤信息
return Result.fail("驗證碼錯誤！");
}
// 4. 一致，根據(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 實現(xiàn)登錄校驗攔截器
登錄校驗攔截器實現(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 未授權
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 類的實現(xiàn)： 該類中定義了一個靜態(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ù) | 無 |
| 返回值 | 無 |
后端接口實現(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 共享問題：
多臺 tomcat 并不共享 session 存儲空間，當請求切換到不同 tomcat 服務時會導致數(shù)據(jù)丟失的問題。
session 的替代方案應該滿足以下條件：
- 數(shù)據(jù)共享（不同的 tomcat 都能夠訪問 Redis 中的數(shù)據(jù)）
- 內(nèi)存存儲（Redis 通過內(nèi)存存儲）
- key、value 結構（Redis 是 key-value 結構）
3. 基于 Redis 實現(xiàn)共享 session 登錄
3.1 Redis 實現(xiàn)共享 session 登錄流程圖
3.2 實現(xiàn)發(fā)送短信驗證碼
前端請求說明：
| 說明 | |
|---|---|
| 請求方式 | POST |
| 請求路徑 | /user/code |
| 請求參數(shù) | phone（電話號碼） |
| 返回值 | 無 |
后端接口實現(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. 校驗手機號
if (RegexUtils.isPhoneInvalid(phone)) {
// 2. 如果不符合，返回錯誤信息
return Result.fail("手機號格式錯誤！");
}
// 3. 符合，生成驗證碼（設置生成6位）
String code = RandomUtil.randomNumbers(6);
// 4. 保存驗證碼到 Redis（以手機號為 key，設置有效期為 2min）
stringRedisTemplate.opsForValue().set("login:code:" + phone, code, 2, TimeUnit.MINUTES);
// 5. 發(fā)送驗證碼（這里并未實現(xiàn)，通過日志記錄）
log.debug("發(fā)送短信驗證碼成功，驗證碼：{}", code);
// 返回 ok
return Result.ok();
}
}
3.3 實現(xiàn)短信驗證碼登錄、注冊
前端請求說明：
| 說明 | |
|---|---|
| 請求方式 | POST |
| 請求路徑 | /user/login |
| 請求參數(shù) | phone（電話號碼）；code（驗證碼） |
| 返回值 | 無 |
后端接口實現(xiàn)：
@Slf4j
@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements IUserService {
@Override
public Result login(LoginFormDTO loginForm, HttpSession session) {
// 1. 校驗手機號
String phone = loginForm.getPhone();
if(RegexUtils.isPhoneInvalid(phone)){
// 不一致，返回錯誤信息
return Result.fail("手機號格式錯誤！");
}
// 2. 校驗驗證碼
String cacheCode = (String) session.getAttribute("code");
String code = loginForm.getCode();
if(cacheCode == null || !cacheCode.equals(cacheCode)){
// 不一致，返回錯誤信息
return Result.fail("驗證碼錯誤！");
}
// 4. 一致，根據(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 實現(xiàn)登錄校驗攔截器
這里將原有的一個攔截器分成兩個攔截器，第一個攔截器對所有的請求進行攔截，每次攔截刷新 token 的有效期，并將能查詢到的用戶信息保存到 ThreadLocal 中。第二個攔截器則進行攔截功能，對需要登錄的路徑進行攔截。
刷新 token 攔截器實現(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;
}
}
登錄校驗攔截器實現(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 未授權
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 類的實現(xiàn)： 該類中定義了一個靜態(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ù) | 無 |
| 返回值 | 無 |
后端接口實現(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);
}
}
到此這篇關于Redis的共享session應用實現(xiàn)短信登錄的文章就介紹到這了,更多相關Redis session 短信登錄內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！
相關文章
Redisson實現(xiàn)Redis分布式鎖的幾種方式
本文在講解如何使用Redisson實現(xiàn)Redis普通分布式鎖，以及Redlock算法分布式鎖的幾種方式的同時，也附帶解答這些同學的一些疑問，感興趣的可以了解一下2021-08-08
在本篇文章里小編給大家整理了關于怎么提高redis緩存命中率的相關知識點內(nèi)容，有興趣的朋友們跟著學習下。2019-06-06
這篇文章主要介紹了關于Redis中bitmap的原理和使用詳解,BitMap即位圖，使用每個位表示某種狀態(tài)，適合處理整型的海量數(shù)據(jù),本質(zhì)上是哈希表的一種應用實現(xiàn),需要的朋友可以參考下2023-05-05
這篇文章主要介紹了Redis的LRU機制介紹,Redis會按LRU算法刪除設置了過期時間但還沒有過期的key,而對于沒有設置過期時間的key,Redis是永遠保留的,需要的朋友可以參考下2015-06-06
這篇文章主要介紹了推薦幾款 Redis 可視化工具,小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2021-04-04
在工作中,有時候需要實現(xiàn)排行榜功能，本文主要介紹了redis中zSet實現(xiàn)排行榜的使用示例，具有一定的參考價值，感興趣的可以了解一下2023-10-10
Redis 在持久化時，給我們提供了兩種方式，這兩種方式就是 RDB 與 AOF，那這兩種方式有什么區(qū)別呢，本文就帶大家詳細的了解一下二者的區(qū)別,需要的朋友可以參考下2023-06-06
在項目使用Redis過程中,當數(shù)據(jù)更新時,我們要保證緩存和數(shù)據(jù)庫的一致性,否則會導致很多臟數(shù)據(jù)出現(xiàn),此時我們就要思考如何去進行數(shù)據(jù)更新,本文就給大家講講關于redis的讀寫一致問題,需要的朋友可以參考下2023-08-08
這篇文章主要為大家介紹了Redisson 主從一致性問題詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪2022-08-08
這篇文章主要介紹了Redis教程(八)：事務詳解,本文講解了,本文講解了事務概述、相關命令列表、命令使用示例、WATCH命令和基于CAS的樂觀鎖等內(nèi)容,需要的朋友可以參考下2015-04-04