共計(jì) 8255 個(gè)字符,預(yù)計(jì)需要花費(fèi) 21 分鐘才能閱讀完成。
本篇內(nèi)容介紹了“Redis 的共享 session 應(yīng)用如何實(shí)現(xiàn)短信登錄”的有關(guān)知識(shí),在實(shí)際案例的操作過(guò)程中,不少人都會(huì)遇到這樣的困境,接下來(lái)就讓丸趣 TV 小編帶領(lǐng)大家學(xué)習(xí)一下如何處理這些情況吧!希望大家仔細(xì)閱讀,能夠?qū)W有所成!
1. 基于 session 實(shí)現(xiàn)短信登錄 1.1 短信登錄流程圖
1.2 實(shí)現(xiàn)發(fā)送短信驗(yàn)證碼
前端請(qǐng)求說(shuō)明:
說(shuō)明請(qǐng)求方式 POST 請(qǐng)求路徑 /user/code 請(qǐng)求參數(shù) phone(電話號(hào)碼)返回值無(wú)
后端接口實(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ī)號(hào)
if(RegexUtils.isPhoneInvalid(phone)){
// 2. 如果不符合,返回錯(cuò)誤信息
return Result.fail( 手機(jī)號(hào)格式錯(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),通過(guò)日志記錄) log.debug(發(fā)送短信驗(yàn)證碼成功,驗(yàn)證碼:{} , code);
// 返回 ok
return Result.ok();
}
}
1.3 實(shí)現(xiàn)短信驗(yàn)證碼登錄、注冊(cè)
前端請(qǐng)求說(shuō)明
說(shuō)明請(qǐng)求方式 POST 請(qǐng)求路徑 /user/login 請(qǐng)求參數(shù) phone(電話號(hào)碼);code(驗(yàn)證碼)返回值無(wú)
后端接口實(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ī)號(hào)
String phone = loginForm.getPhone();
if(RegexUtils.isPhoneInvalid(phone)){
// 不一致,返回錯(cuò)誤信息
return Result.fail( 手機(jī)號(hào)格式錯(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ī)號(hào)查詢用戶(這里使用的 mybatis-plus) User user = query().eq( phone , phone).one();
// 5. 判斷用戶是否存在
if(user == null){
// 6. 不存在,創(chuàng)建新用戶并保存
user = createUserWithPhone(phone);
}
// 7. 保存用戶信息到 session 中(通過(guò) BeanUtil.copyProperties 方法將 user 中的信息過(guò)濾到 UserDTO 上,即用來(lái)隱藏部分信息) 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
);
}
}
前端請(qǐng)求說(shuō)明:
說(shuō)明請(qǐng)求方式 POST 請(qǐng)求路徑 /user/me 請(qǐng)求參數(shù)無(wú)返回值無(wú)
后端接口實(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 共享問(wèn)題
session 共享問(wèn)題:
多臺(tái) tomcat 并不共享 session 存儲(chǔ)空間,當(dāng)請(qǐng)求切換到不同 tomcat 服務(wù)時(shí)會(huì)導(dǎo)致數(shù)據(jù)丟失的問(wèn)題。
session 的替代方案應(yīng)該滿足以下條件:
數(shù)據(jù)共享(不同的 tomcat 都能夠訪問(wèn) Redis 中的數(shù)據(jù))
內(nèi)存存儲(chǔ)(Redis 通過(guò)內(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)證碼
前端請(qǐng)求說(shuō)明:
說(shuō)明請(qǐng)求方式 POST 請(qǐng)求路徑 /user/code 請(qǐng)求參數(shù) phone(電話號(hào)碼)返回值無(wú)
后端接口實(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ī)號(hào)
if (RegexUtils.isPhoneInvalid(phone)) {
// 2. 如果不符合,返回錯(cuò)誤信息
return Result.fail( 手機(jī)號(hào)格式錯(cuò)誤! }
// 3. 符合,生成驗(yàn)證碼(設(shè)置生成 6 位) String code = RandomUtil.randomNumbers(6);
// 4. 保存驗(yàn)證碼到 Redis(以手機(jī)號(hào)為 key,設(shè)置有效期為 2min) stringRedisTemplate.opsForValue().set( login:code: + phone, code, 2, TimeUnit.MINUTES);
// 5. 發(fā)送驗(yàn)證碼(這里并未實(shí)現(xiàn),通過(guò)日志記錄) log.debug(發(fā)送短信驗(yàn)證碼成功,驗(yàn)證碼:{} , code);
// 返回 ok
return Result.ok();
}
}
3.3 實(shí)現(xiàn)短信驗(yàn)證碼登錄、注冊(cè)
前端請(qǐng)求說(shuō)明:
說(shuō)明請(qǐng)求方式 POST 請(qǐng)求路徑 /user/login 請(qǐng)求參數(shù) phone(電話號(hào)碼);code(驗(yàn)證碼)返回值無(wú)
后端接口實(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ī)號(hào)
String phone = loginForm.getPhone();
if(RegexUtils.isPhoneInvalid(phone)){
// 不一致,返回錯(cuò)誤信息
return Result.fail( 手機(jī)號(hào)格式錯(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ī)號(hào)查詢用戶(這里使用的 mybatis-plus) User user = query().eq( phone , phone).one();
// 5. 判斷用戶是否存在
if(user == null){
// 6. 不存在,創(chuàng)建新用戶并保存
user = createUserWithPhone(phone);
}
// 7. 保存用戶信息到 session 中(通過(guò) BeanUtil.copyProperties 方法將 user 中的信息過(guò)濾到 UserDTO 上,即用來(lái)隱藏部分信息) 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è)攔截器對(duì)所有的請(qǐng)求進(jìn)行攔截,每次攔截刷新 token 的有效期,并將能查詢到的用戶信息保存到 ThreadLocal 中。第二個(gè)攔截器則進(jìn)行攔截功能,對(duì)需要登錄的路徑進(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. 獲取請(qǐng)求頭中的 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 對(duì)象
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);
}
}
前端請(qǐng)求說(shuō)明:
說(shuō)明請(qǐng)求方式 POST 請(qǐng)求路徑 /user/me 請(qǐng)求參數(shù)無(wú)返回值無(wú)
后端接口實(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 應(yīng)用如何實(shí)現(xiàn)短信登錄”的內(nèi)容就介紹到這里了,感謝大家的閱讀。如果想了解更多行業(yè)相關(guān)的知識(shí)可以關(guān)注丸趣 TV 網(wǎng)站,丸趣 TV 小編將為大家輸出更多高質(zhì)量的實(shí)用文章!