Redis实战—验证码登录注册

无问青秋

已于 2024-05-15 21:54:13 修改

阅读量633

点赞数 7

分类专栏： Redis实战文章标签： redis 数据库缓存 java

于 2024-05-15 20:01:48 首次发布

本文链接：https://blog.csdn.net/qq_73181349/article/details/138914715

版权

Redis实战专栏收录该内容

11 篇文章 0 订阅

订阅专栏

基于Session

Controller层

    /**
     * 发送手机验证码
     */
    @PostMapping("code")
    public Result sendCode(@RequestParam("phone") String phone, HttpSession session) {
        // TODO 发送短信验证码并保存验证码
        return userService.sendCode(phone,session);
    }


    /**
     * 登录功能,不存在用户则自动创建用户
     * @param loginForm 登录参数，包含手机号、验证码；或者手机号、密码
     * @RequestBody注解用于把前端的json数据转换成DTO对象
     */
    @PostMapping("/login")
    public Result login(@RequestBody LoginFormDTO loginForm, HttpSession session){
    //将请求体中的数据转换为特定的对象或数据类型绑定到方法的参数上
        // TODO 实现登录功能
        return userService.login(loginForm,session);
    }

Service层

   Result sendCode(String phone, HttpSession session);

   Result login(LoginFormDTO loginForm, HttpSession session);

ServiceImpl层

   
    //登录
    @Override
    public Result login(LoginFormDTO loginForm, HttpSession session) {

        //发送验证码和登录是两次不同的请求，要对手机号做二次校验
        //1.再次获取手机号并再次校验手机号
        String phone = loginForm.getPhone();
        if(RegexUtils.isPhoneInvalid(phone)){
            //2.不符合返回错误信息
            return Result.fail("手机号格式错误");
        }

        //3.手机号校验成功，校验验证码，验证码从session获取
        String code = session.getAttribute("code");//发送的验证码
        String logincode = loginForm.getCode();//用户填写的验证码
        if (code==null||!code.toString().equals(logincode)){
            //4.验证码错误，返回信息
            return Result.fail("验证码错误");
        }

        //5.验证码一致，查询是否存在用户
        //query()是Mybatis-Plus提供的，本类继承了extends ServiceImpl<UserMapper, User>
        User user = query().eq("phone", phone).one();
        if (user==null){
            //6.用户不存在则创建新用户，新用户信息要保存到session，所以这里把新建的user返回
            user=createUserWithPhone(phone);
        }

        // 7.保存用户信息到session
        //user信息过多，不易直接保存到session，会加大内存负载，此处转化成userDTO,还可以隐藏用户敏感信息
        UserDTO userDTO = BeanUtil.copyProperties(user, UserDTO.class);
        session.setAttribute("user",userDTO);


        //访问tomcat时。sessionID自动写到了cookie中作为以后的登录凭证
        return Result.ok();
    }


    //自动注册用户
    private User createUserWithPhone(String phone) {
        User user=new User();
        user.setPhone(phone);
        //生成随机用户名
        user.setNickName("user_"+RandomUtil.randomString(5));
        save(user);//保存用户到数据库,mybatis-plus提供的
        return user;
    }


    //发送验证码
    @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.info("验证码发送成功：{}",code);

        //6.返回
        return Result.ok();
    }

校验登录状态

上面完成了短信验证码的发送及登录注册，用户如果登陆成功就要进入个人主页，但是进入个人主页需要验证用户的登录状态，接下来使用拦截器和ThreadLocal完成登录状态校验

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

登录拦截器

//这是一个自定义的拦截器类，用于校验登陆状态
//需要在config中添加到拦截器中才会生效
public class LoginInterceptor implements HandlerInterceptor {

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        UserHolder.removerUser();
    }

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {

    //1.获取session
    HttpSession session=request.getSession();

    //2.获取session中的用户
    Object user=session.getAttribute("user");

    //3.判断用户是否存在
    if(user=null){
    //4.不存在，拦截
        response.setStatus(401);
        return false;   
    }

    //5.存在，保存到ThreadLocal，并放行
    UserHolder.saveUSer(user);

    return true;

    }
}

添加拦截器到Config

@Configuration
public class MvcConfig implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 登录拦截器
        registry.addInterceptor(new LoginInterceptor())
                .excludePathPatterns(
                        "/shop/**",
                        "/voucher/**",
                        "/shop-type/**",
                        "/upload/**",
                        "/blog/hot",
                        "/user/code",
                        "/user/login"
                );

    }
}

Controller层实现


    //登录校验状态
    @GetMapping("/me")
    //个人主页
    public Result me(){
        // TODO 获取当前登录的用户并返回
        //在拦截器LoginInterceptor中已经把用户保存到localthread
        UserDTO user = UserHolder.getUser();
        return Result.ok(user);
    }

基于Redis

接下来在上面代码的基础上修改serviceImpl和拦截器及config

ServiceImpl

    //注入stringRedisTemplate
    @Resource
    private StringRedisTemplate stringRedisTemplate;

 
    @Override
    public Result login(LoginFormDTO loginForm, HttpSession session) {
        
        //1.校验手机号
        String phone = loginForm.getPhone();
        if(RegexUtils.isPhoneInvalid(phone)){
            //2.不符合返回错误信息
            return Result.fail("手机号格式错误");
        }

        //3.手机号校验成功，校验验证码，验证码从redis中获取
        String code = stringRedisTemplate.opsForValue().get("login:code:"+phone);
        String logincode = loginForm.getCode();
        if (code==null||!code.toString().equals(logincode)){
            //4.验证码错误
            return Result.fail("验证码错误");
        }

        //5.验证码一致，查询是否存在用户
        //query()是mp提供的，本类继承了extends ServiceImpl<UserMapper, User>
        User user = query().eq("phone", phone).one();
        if (user==null){
            //6.不存在用户，创建新用户
            user=createUserWithPhone(phone);
        }
        
        //7.用户存在，生成用户的token作为登录凭证
        String token = UUID.randomUUID().toString(true);
        
        //8.存入redis时用的hash存储，因此这里要把userDto转换成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()));

        //9.token存入redis并设置token有效期
        stringRedisTemplate.opsForHash().putAll("login:token:"+token,userMap);     
        stringRedisTemplate.expire("login:token:",30,TimeUnit.MINUTES);
        
        return Result.ok(token);
    }    


    @Override
    public Result sendCode(String phone, HttpSession session) {
        //1.校验手机号
        if(RegexUtils.isPhoneInvalid(phone)){
            //2.不符合返回错误信息
            return Result.fail("手机号格式错误");
        }
        
        //2.符合生成验证码
        String code = RandomUtil.randomNumbers(6);
        
        
        //3.保存到redis中,设置有效期1分钟
        stringRedisTemplate.opsForValue().set("login:code:"+phone,code,1L, TimeUnit.MINUTES);

        //4.发送验证码给客户
        log.info("验证码发送成功：{}",code);

        //返回
        return Result.ok();
    }

新增刷新拦截器

用于刷新Token有效期，这里做了拦截器的优化。在第一个拦截器会获取token，根据token去redis查询用户，如果查到就说明用户已经登陆过了，此时只需要刷新token有效期并保存到threadlocal然后放行。如果没有查到说明是未登录用户或者登录已经过期，那么token也是null的，也直接放行，所以第一个拦截器虽然拦截一切路径，但不论如何最后都会放行，其主要作用是对已登录用户刷新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 key  = "login:token" + token;
        Map<Object, Object> userMap = stringRedisTemplate.opsForHash().entries(key);
        // 3.判断用户是否存在
        if (userMap.isEmpty()) {
            return true;
        }
        // 5.将查询到的hash数据转为UserDTO
        UserDTO user = BeanUtil.fillBeanWithMap(userMap, new UserDTO(), false);
        // 6.存在，保存用户信息到 ThreadLocal
        UserHolder.saveUser(user);
        // 7.刷新token有效期
        stringRedisTemplate.expire(key, 30L, TimeUnit.MINUTES);
        // 8.放行
        return true;
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        // 移除用户
        UserHolder.removeUser();
    }
}

添加拦截器到Config

@Configuration
public class MvcConfig implements WebMvcConfigurer {

    @Resource
    private StringRedisTemplate stringRedisTemplate;

    @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);
        //后注册的拦截器先执行
    }
}