How to implement SMS login in Redis shared session application
Jun 03, 2023 pm 03:11 PM
1. Implement SMS login based on session
1.1 SMS login flow chart
1.2 Implementation of sending SMS verification code
Front-end request instructions:
| POST | |
| /user/code | |
| phone (phone number) | |
| None |
@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. 符合，生成驗證碼（設(shè)置生成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 Implement SMS verification code login and registrationFront-end request instructions| POST | |
| / user/login | |
| phone (phone number); code (verification code) | |
| None |
@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 Implement login verification interceptorLogin verification interceptor Implementation: 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 class implementation: This class defines a static ThreadLocalpublic 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 interceptor: @Configuration
public class MvcConfig implements WebMvcConfigurer {
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new LoginInterceptor())
.excludePathPatterns(
"/user/login",
"/user/code"
);
}
}Front-end request description: | POST | |
| /user/me | |
| None | |
| None |
@Slf4j
@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements IUserService {
@Override
public Result me() {
UserDTO user = UserHolder.getUser();
return Result.ok(user);
}
}2. Cluster session sharing problemsession sharing problem : Multiple tomcats do not share session storage space. When the request is switched to different tomcat services, it will cause data loss. Session alternatives should meet the following conditions: - Data sharing (different tomcats can access data in Redis)
- Memory storage (Redis stores through memory)
- key, value structure (Redis is a key-value structure)
3.1 Redis implements shared session login flow chart
##3.2 Implement sending SMS verification code
Front-end request instructions:
Instructions | |
|---|---|
| POST | |
| /user/code | |
| phone(phone number) | |
| None |
@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. 符合，生成驗證碼（設(shè)置生成6位）
String code = RandomUtil.randomNumbers(6);
// 4. 保存驗證碼到 Redis（以手機號為 key，設(shè)置有效期為 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 Implement SMS verification code login and registration
Front-end request instructions:
Description | |
|---|---|
| POST | |
| /user/login | |
| phone (phone number); code (verification code) | ##Return value |
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;
}
}Login verification interceptor implementation: 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 class implementation: This class defines a static 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();
}
}Configure interceptor: @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);
}
} Front-end request description: | Description | Request method |
|---|---|
| Request path | |
| Request parameters | |
| Return value | |
