基于Redis优化验证码登录流程, 解决登录状态刷新问题

向右看齐 2024-03-22 03:29 48阅读 0赞

#### 文章目录 ####

*   *  1 问题: 多台Tomcat间session共享问题
     *  2 Redis代替session的业务流程分析
     *   *  2.1 设计key的结构
         *  2.2 设计Key的具体细节
         *  2.3 整体访问流程
     *  3 基于Redis实现短信登录
     *  4 解决状态登录刷新问题
     *   *  4.1 初始方案问题
         *  4.2 优化方案
         *  4.3 代码

### 1 问题: 多台Tomcat间session共享问题 ###

书接上回

每个tomcat中都有一份属于自己的session,假设用户第一次访问第一台tomcat，并且把自己的信息存放到第一台服务器的session中，但是第二次这个用户访问到了第二台tomcat，那么在第二台服务器上，肯定没有第一台服务器存放的session，所以此时 整个登录拦截功能就会出现问题，我们能如何解决这个问题呢？早期的方案是session拷贝，就是说虽然每个tomcat上都有不同的session，但是每当任意一台服务器的session修改时，都会同步给其他的Tomcat服务器的session，这样的话，就可以实现session的共享了

但是这种方案具有两个大问题

1、每台服务器中都有完整的一份session数据，服务器压力过大。

2、session拷贝数据时，可能会出现延迟

所以咱们后来采用的方案都是基于redis来完成，我们把session换成redis，redis数据本身就是共享的，就可以避免session共享的问题了

![7a8ec18435134e5f80bc745f0a6c7d91.png][]

### 2 Redis代替session的业务流程分析 ###

#### 2.1 设计key的结构 ####

首先我们要思考一下利用redis来存储数据，那么到底使用哪种结构呢？由于存入的数据比较简单，我们可以考虑使用String，或者是使用哈希，如下图，如果使用String，同学们注意他的value，用多占用一点空间，如果使用哈希，则他的value中只会存储他数据本身，如果不是特别在意内存，其实使用String就可以啦。

![ea03f520e4524c63939f3506e1dc207f.png][]

#### 2.2 设计Key的具体细节 ####

所以我们可以使用String结构，就是一个简单的key，value键值对的方式，但是关于key的处理，session他是每个用户都有自己的session，但是redis的key是共享的，咱们就不能使用code了

在设计这个key的时候，我们之前讲过需要满足两点

1、key要具有唯一性

2、key要方便携带

如果我们采用phone：手机号这个的数据来存储当然是可以的，但是如果把这样的敏感数据存储到redis中并且从页面中带过来毕竟不太合适，所以我们在后台生成一个随机串token，然后让前端带来这个token就能完成我们的整体逻辑了.

#### 2.3 整体访问流程 ####

当注册完成后，用户去登录会去校验用户提交的手机号和验证码，是否一致，如果一致，则根据手机号查询用户信息，不存在则新建，最后将用户数据保存到redis，并且生成token作为redis的key，当我们校验用户是否登录时，会去携带着token进行访问，从redis中取出token对应的value，判断是否存在这个数据，如果没有则拦截，如果存在则将其保存到`threadLocal`中，并且放行。

![1653319474181][]

### 3 基于Redis实现短信登录 ###

主要的不同就是验证码存Redis的String, 设置**自动过期**, Key是phone, Value是验证码.

Session替换成了

Key:		随机token(UUID)
    Value:		UserDTO

存Redis的Hash. 也设置**自动过期**

**UserServiceImpl代码**

@Override
    public Result login(LoginFormDTO loginForm, HttpSession session) {
        
        // 1.校验手机号
        String phone = loginForm.getPhone();
        if (RegexUtils.isPhoneInvalid(phone)) {
        
            // 2.如果不符合，返回错误信息
            return Result.fail("手机号格式错误！");
        }
        // 3.从redis获取验证码并校验
        String cacheCode = stringRedisTemplate.opsForValue().get(LOGIN_CODE_KEY + phone);
        String code = loginForm.getCode();
        if (cacheCode == null || !cacheCode.equals(code)) {
        
            // 不一致，报错
            return Result.fail("验证码错误");
        }
    
        // 4.一致，根据手机号查询用户 select * from tb_user where phone = ?
        User user = query().eq("phone", phone).one();
    
        // 5.判断用户是否存在
        if (user == null) {
        
            // 6.不存在，创建新用户并保存
            user = createUserWithPhone(phone);
        }
    
        // 7.保存用户信息到 redis中
        // 7.1.随机生成token，作为登录令牌
        String token = UUID.randomUUID().toString(true);
        // 7.2.将User对象转为HashMap存储
        UserDTO userDTO = BeanUtil.copyProperties(user, UserDTO.class);
        Map<String, Object> userMap = BeanUtil.beanToMap(userDTO, new HashMap<>(),
                CopyOptions.create()
                        .setIgnoreNullValue(true)
                        .setFieldValueEditor((fieldName, fieldValue) -> fieldValue.toString()));
        // 7.3.存储
        String tokenKey = LOGIN_USER_KEY + token;
        stringRedisTemplate.opsForHash().putAll(tokenKey, userMap);
        // 7.4.设置token有效期
        stringRedisTemplate.expire(tokenKey, LOGIN_USER_TTL, TimeUnit.MINUTES);
    
        // 8.返回token
        return Result.ok(token);
    }

### 4 解决状态登录刷新问题 ###

#### 4.1 初始方案问题 ####

在这个方案中，他确实可以使用对应路径的拦截，同时刷新登录token令牌的存活时间，但是现在这个拦截器他只是拦截需要被拦截的路径，假设当前用户访问了一些不需要拦截的路径，那么这个拦截器就不会生效，所以此时令牌刷新的动作实际上就不会执行，所以这个方案他是存在问题的.  
![0ecdf0860695413289ffd3460b024e18.png][]

#### 4.2 优化方案 ####

既然之前的拦截器无法对不需要拦截的路径生效，那么我们可以添加一个新的拦截器，在第一个拦截器中拦截所有的路径，把第二个拦截器做的事情放入到第一个拦截器中，同时刷新令牌，因为第一个拦截器有了threadLocal的数据，所以此时第二个拦截器只需要判断拦截器中的user对象是否存在即可，完成整体刷新功能。

![020620ceb03449bca9485acb01cf60cc.png][]

#### 4.3 代码 ####

**RefreshTokenInterceptor**

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 key  = LOGIN_USER_KEY + token;
            Map<Object, Object> userMap = stringRedisTemplate.opsForHash().entries(key);
            // 3.判断用户是否存在
            if (userMap.isEmpty()) {
        
                return true;
            }
            // 5.将查询到的hash数据转为UserDTO
            UserDTO userDTO = BeanUtil.fillBeanWithMap(userMap, new UserDTO(), false);
            // 6.存在，保存用户信息到 ThreadLocal
            UserHolder.saveUser(userDTO);
            // 7.刷新token有效期
            stringRedisTemplate.expire(key, LOGIN_USER_TTL, TimeUnit.MINUTES);
            // 8.放行
            return true;
        }
    
        @Override
        public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        
            // 移除用户
            UserHolder.removeUser();
        }
    }

**LoginInterceptor**

public class LoginInterceptor implements HandlerInterceptor {
        
    
        @Override
        public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        
            // 1.判断是否需要拦截（ThreadLocal中是否有用户）
            if (UserHolder.getUser() == null) {
        
                // 没有，需要拦截，设置状态码
                response.setStatus(401);
                // 拦截
                return false;
            }
            // 有用户，则放行
            return true;
        }
    }

[7a8ec18435134e5f80bc745f0a6c7d91.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/e217203e109c4b94947dddd780697f35.png
[ea03f520e4524c63939f3506e1dc207f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/769b1a010cf644b1aa6407255acafb32.png
[1653319474181]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/dcd384fe7796416bb225a5dbfdaafb55.png
[0ecdf0860695413289ffd3460b024e18.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/3da6c82ee9dc439e8f02c6c0d38d2657.png
[020620ceb03449bca9485acb01cf60cc.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/b9b35689933b432a90f33db5582db9d4.png