Redis的共用session應用實現簡訊登入

2022-08-17 14:03:25

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（電話號碼）
返回值	無

後端介面實現：

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

3.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;
    }
}

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

登入校驗攔截器實現：

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 {

    @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
請求引數	無
返回值	無

後端介面實現：

@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應用實現簡訊登入的文章就介紹到這了,更多相關Redis session 簡訊登入內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！