Redis的共享session應用實現短信登錄

本篇文章主要介紹了Redis的相關知識，主要介紹了Redis的共享session應用實現短信登錄，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，希望對大家有幫助。

推薦學習：Redis影片教學

#1. 基於session 實作簡訊登入

1.1簡訊登入流程圖

1.2 實作傳送簡訊驗證碼

前端請求說明：

## 傳回值#無

	說明
#請求方式	POST
請求路徑	/user/code
請求參數	phone（電話號碼）

後端介面實作：

@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. 发送验证码（这里并未实现，通过日志记录）
        log.debug("发送短信验证码成功，验证码：{}", code);
        // 返回 ok
        return Result.ok();
    }
}

1.3 實作簡訊驗證碼登入、註冊

前端請求說明

# 說明#請求方式POST請求路徑/user/login請求參數phone（電話號碼）；code（驗證碼）傳回值無後端介面實作：

@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. 一致，根据手机号查询用户（这里使用的 mybatis-plus）
        User user = query().eq("phone", phone).one();
        // 5. 判断用户是否存在
        if(user == null){
            // 6. 不存在，创建新用户并保存
            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. 创建用户
        User user = new User();
        user.setPhone(phone);
        user.setNickName("user_" + RandomUtil.randomString(10));
        // 2. 保存用户（这里使用 mybatis-plus）
        save(user);
        return user;
    }
}

1.4 實作登入校驗攔截器

登入校驗攔截器實作：

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 {
        // 移除用户，避免内存泄露
        UserHolder.removeUser();
    }
}

UserHolder 類別的實作： 在該類別中定義了一個靜態的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#請求參數#無

傳回值

無

後端介面實作：

• @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 服務時會導致資料遺失的問題。

session 的替代方案應該滿足以下條件：

資料共享（不同的tomcat 都能夠存取Redis 中的資料）

記憶體儲存（Redis 透過內存儲存）

key、value 結構（Redis 是key-value 結構）

3. 基於Redis 實作共用session 登入

3.1 Redis 實作共用session 登入流程圖

3.2 實作傳送簡訊驗證碼前端請求說明： 請求方式請求路徑#請求參數

說明
POST
/user/code

phone（電話號碼）

傳回值

無#後端介面實作：3.3 實作簡訊驗證碼登入、註冊前端請求說明： 請求方式請求路徑請求參數

	@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. 发送验证码（这里并未实现，通过日志记录） log.debug("发送短信验证码成功，验证码：{}", code); // 返回 ok return Result.ok(); } }
說明
POST
/user/login

phone（電話號碼）；code（驗證碼）

#傳回值

#無

後端介面實作：

@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. 一致，根据手机号查询用户（这里使用的 mybatis-plus）
        User user = query().eq("phone", phone).one();
        // 5. 判断用户是否存在
        if(user == null){
            // 6. 不存在，创建新用户并保存
            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. 创建用户
        User user = new User();
        user.setPhone(phone);
        user.setNickName("user_" + RandomUtil.randomString(10));
        // 2. 保存用户（这里使用 mybatis-plus）
        save(user);
        return user;
    }
}

3.4 實作登入校驗攔截器

這裡將原有的一個攔截器分成兩個攔截器，第一個攔截器對所有的請求進行攔截，每次攔截刷新token 的有效期限，並將能查詢到的使用者資訊儲存到ThreadLocal 中。第二個攔截器則進行攔截功能，對需要登入的路徑進行攔截。

刷新token 攔截器實作：

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 数据转为 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;
    }
}

登入校驗攔截器實作：UserHolder 類別的實作： 在該類別中定義了一個靜態的ThreadLocal設定攔截器：

@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);
    }
}

前端請求說明： ##說明

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 { // 移除用户，避免内存泄露 UserHolder.removeUser(); } }	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(); } }

請求方式POST

#########請求路徑######/user/me############請求參數######無############傳回值######無###############後端介面實作：## #

@Slf4j
@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements IUserService {

    @Override
    public Result me() {
        UserDTO user = UserHolder.getUser();
        return Result.ok(user);
    }
}

###推薦學習：###Redis影片教學#######

以上是Redis的共享session應用實現短信登錄的詳細內容。更多資訊請關注PHP中文網其他相關文章！