【黑马点评】基于Redis实现短信验证登录

仰望-星空~~

已于 2023-08-14 15:10:59 修改

阅读量252

点赞数

文章标签： redis 数据库缓存

于 2023-08-14 15:10:03 首次发布

本文链接：https://blog.csdn.net/weixin_65935065/article/details/132276010

版权

一、Redis代替session的业务流程

1️⃣修改sendCode方法——发送验证码

一、Redis代替session的业务流程

1、设计key的结构

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

2、设计key的细节

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

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

1、key要具有唯一性

2、key要方便携带

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

3、整体访问流程

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

二、代码实现

1、修改userServiceImpl

1️⃣修改sendCode方法——发送验证码

//redis客户端注入
@Resource
private StringRedisTemplate stringRedisTemplate;

//修改sendCode方法——保存验证码
//4、保存验证码到session
//session.setAttribute("code",code);
//4、保存验证码到redis
//设置key有效期2分钟
/*stringRedisTemplate.opsForValue().set("login:code"+phone,code,2, TimeUnit.MINUTES);*/
//声明常量后
stringRedisTemplate.opsForValue().set(LOGIN_CODE_KEY+phone,code,LOGIN_CODE_TTL, TimeUnit.MINUTES);

2️⃣修改login方法——登录校验

设置token时间：如果时间超过了30分钟，redis就会把你的登录剔除

@Override
    public Result login(LoginFormDTO loginForm, HttpSession session) {
        //1、校验手机号
        String phone= loginForm.getPhone();
        if (RegexUtils.isPhoneInvalid(phone)) {
            //2、如果不符合，返回错误信息
            return Result.fail("手机号格式错误！！！");
        }
        //2、校验验证码
        //取出redis中保存的验证码与表单中的输入的验证码吗进行比较
        //Object cachecode = session.getAttribute("code");
        String cachecode=stringRedisTemplate
            .opsForValue().get(LOGIN_CODE_KEY+phone);
        String code=loginForm.getCode();
        if(cachecode==null || !cachecode.equals(code)){
            //3、不一致：报错
            return Result.fail("验证码错误！！");
        }
        //4、一致：根据手机号数据库查询用户
        User user = query().eq("phone", phone).one();
        //5、判断用户是否存在
        if(user==null){
            //6、不存在，创建新用户并保存
            user=createUserWithPhone(phone);
        }
        //7、保存用户信息到redis中
        /*
          copyProperties:属性拷贝——把user中的属性字动拷贝到UserDTO中
          BeanUtils:使用的是包cn.hutool.core.bean下的工具类
         */
        /**
         * 保存用户信息到redis中
         * 1)随机生成token作为登陆令牌
         * 2)将user对象转为hash存储
         * 3)存储
         */
        //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);
        //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();
    }

登录校验修改较多

修改一：

修改二：

2、声明常量

为了避免这个key写错

新建工具类RedisConstants类

public class RedisConstants {
    public static final String LOGIN_CODE_KEY = "login:code:";
    public static final Long LOGIN_CODE_TTL = 2L;
    public static final String LOGIN_USER_KEY = "login:token:";
    public static final Long LOGIN_USER_TTL = 30L;
}

3、修改登录拦截器

public class LoginInterceptor implements HandlerInterceptor {
    /*
    这个类是我们手动创建的，所以只能用set注入，不能自动注入
     */
    private StringRedisTemplate stringRedisTemplate;

    public LoginInterceptor(StringRedisTemplate stringRedisTemplate) {
        this.stringRedisTemplate = stringRedisTemplate;
    }


    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        //1、获取请求头中的token
        String token=request.getHeader("authorization");//前端页面定义的请求头
        //1.1、判断token是否为空
        if (StrUtil.isBlank(token)) {
            //不存在，拦截，返回401状态码
            response.setStatus(401);
            return false;
        }
        //2、基于token获取redis中的用户
        String key=RedisConstants.LOGIN_USER_KEY + token;
        Map<Object, Object> userMap = stringRedisTemplate.opsForHash().entries(key);
        //3、判断用户是否存在
        if (userMap.isEmpty()) {
            //4、不存在，拦截:返回401状态码
            response.setStatus(401);
            return false;
        }
        //5、将查询到的hash数据转为userDTO对象
        UserDTO userDTO = BeanUtil.fillBeanWithMap(userMap, new UserDTO(), false);
        //6、存在，保存用户信息到ThreadLocal
        UserHolder.saveUser(userDTO);

        //7、刷新token有效期
        stringRedisTemplate.expire(key,RedisConstants.LOGIN_USER_TTL, TimeUnit.MINUTES);
        //8、放行
        return true;
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        //移除用户，避免内存蟹泄露
        //视图渲染完成后执行该方法，一次请求获取一次用户信息，用完立即释放
        UserHolder.removeUser();
    }
}

4、修改MvcConfig配置类

5、效果

发送验证码后，验证码需要存储在redis中，所以控制台得到的验证码和redis中得到的应该是一致的

控制台：

redis中得到

三、解决状态登录刷新问题

1、原始方案

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

2、优化方案

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

3、添加一个拦截器

复制登录拦截器，修改部分内容

public class RefreshTokenInterceptor implements HandlerInterceptor {
    /**
     * 前置拦截器
     * @param request
     * @param response
     * @param handler
     * @return
     * @throws Exception
     */
    /*
    这个类是我们手动创建的，所以只能用set注入，不能自动注入
     */
    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");//前端页面定义的请求头
        //1.1、判断token是否为空
        if (StrUtil.isBlank(token)) {
            return true;
        }
        //2、基于token获取redis中的用户
        String key=RedisConstants.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,RedisConstants.LOGIN_USER_TTL, TimeUnit.MINUTES);
        //不为空，放行
        return true;
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        //移除用户，避免内存蟹泄露
        //视图渲染完成后执行该方法，一次请求获取一次用户信息，用完立即释放
        UserHolder.removeUser();
    }
}

4、修改登录拦截器

删除afterCompletion方法

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;
        }
        //8、放行
        return true;
    }
}

5、修改mvcConfig配置类

对两个拦截器进行配置

@Configuration
public class MvcConfig implements WebMvcConfigurer {
    @Resource
    private StringRedisTemplate stringRedisTemplate;

    /**
     * 添加order,确保后面这个先执行，前面的拦截器后执行
     * @param registry
     */
    //登录拦截器
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new LoginInterceptor())
                //排除不需要拦截的路径——验证码和登录····
                .excludePathPatterns(
                        "/shop/**",
                        "/voucher/**",
                        "/shop-type/**",
                        "/upload/**",
                        "/blog/hot",
                        "/user/code",
                        "/user/login"
                ).order(1);
        //token刷新拦截器
        registry.addInterceptor(new RefreshTokenInterceptor(stringRedisTemplate))
                .addPathPatterns("/**").order(0);
    }
}

6、登录效果

五、解决重复登录问题

如果每次用户使用该软件时都需要登录获取验证码，太过麻烦

我们可以在第一次登陆时，将缓存中的token用户信息过期时间TTL设置为-1，

将缓存时间设置为-1表示永久缓存，即永不过期

这就意味这用户不需要再次登录，直到缓存被显式的清除或用户手动退出登录

我的分享到此结束，如果您觉得对您有所帮助，欢迎点赞、评论、关注！！！😁😁😁😁

我们下期见！

仰望-星空~~

关注

0
点赞
踩
2

收藏

觉得还不错? 一键收藏
0
评论
【黑马点评】基于Redis实现短信验证登录

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

扫一扫