Redis学习之路(五) 短信登录功能

1、整体流程

2、第一步实现短信发送

// 校验手机号
        if(RegexUtils.isPhoneInvalid(phone)){
            // 如果不符合返回错误信息
            return Result.fail("手机号格式错误");
        }
        // 符合？生成验证码到redis中
        // RandomUtil.randomNumbers 为工具类，生成6位随机数
        String code = RandomUtil.randomNumbers(6);
        // 保存验证码到redis中
        // LOGIN_CODE_KEY + phone 作为key
        stringRedisTemplate.opsForValue().set(LOGIN_CODE_KEY+phone,code,LOGIN_CODE_TTL, TimeUnit.MINUTES);
        // 发送验证码
        // 此处需要自己替换，配置发送短信的平台接口，这里就在控制台打印了
        log.debug("发送验证码成功:"+code);
        // 返回ok
        return Result.ok();

3、前台输入验证码后 进行登录

// 1、校验提交时表单的手机号
        String phone = loginForm.getPhone();
        if(RegexUtils.isPhoneInvalid(phone)){
            // 如果不符合返回错误信息
            return Result.fail("手机号格式错误");
        }
        // 2、从Redis数据库中获取校验验证码
        String  cacheCode = stringRedisTemplate.opsForValue().get(LOGIN_CODE_KEY+phone);
        String code = loginForm.getCode();
        // 3 不一致返回验证码错误
        if(cacheCode==null){
            return  Result.fail("验证码已过期");
        }else if(!cacheCode.equals(code)){
            return  Result.fail("验证码错误");
        }
        //4、根据手机号查询用户
        User user = query().eq("phone", phone).one();

        //5、用户不存在则直接创建新用户
        if (user == null){
           user =  createUserWithPhone(phone);
        }
        //6、保存用户在Redis 中
        // 由于User类中存在密码，电话等信息，不能直接返回给前台，将user中的值 赋值给 userDTO对象
        // userDTO 对象中有  用用户ID 用户名 用户头像地址信息
        UserDTO userDTO = BeanUtil.copyProperties(user, UserDTO.class);
        // 由于在往 Redis 存储 UserDTO 对象登录信息时，部分属性 不为 String 类型  需要转换为String 类型，并且将userDTO对象转化为HashMap存储
        Map<String, Object> userMap = BeanUtil.beanToMap(userDTO,new HashMap<>(),
                CopyOptions.create().setIgnoreNullValue(true).setFieldValueEditor((fieldName,fieldValue)->(fieldValue.toString())));
        // 随机生成token 作为登录令牌
        String token = UUID.randomUUID().toString(true);
        // 存储
        stringRedisTemplate.opsForHash().putAll(LOGIN_USER_KEY+token,userMap);
        // 设置数据有效时长
        stringRedisTemplate.expire(LOGIN_USER_KEY+token,LOGIN_USER_TTL,TimeUnit.MINUTES);
        // 返回Token
        return Result.ok(token);

4、配置拦截器

		由于部分功能，例如：首页、商品信息等，不需要进行登录，所以访问这些资源时我们无需进行拦截。
	但是在登录后，访问的这些不进行拦截的页面，导致我们不能及时的刷新用户的token在Redis 库数据中的有效时长，
	造成用户在使用过程中，出现登陆状态超时，需要重新登录的问题。
		因此，我们需要再添加一个拦截器，对所有的请求进行拦截，并刷新Redis中用户信息存在的时长。

1、配置拦截器，使拦截器生效

@Configuration
public class MvcConfig implements WebMvcConfigurer {

    // 通过spring 注入 stringRedisTemplate 并传给拦截器
    @Resource
    private StringRedisTemplate stringRedisTemplate;

    // 添加拦截器
    @Override
    public void addInterceptors(InterceptorRegistry registry) {

        // token 刷新拦截器
        // order 为执行的先后顺序。0为最先执行
        registry.addInterceptor(new RefreshTokenInterceptor(stringRedisTemplate)).addPathPatterns("/**").order(0);
        // 登录拦截器
        // excludePathPatterns 排除参数，参数中的请求不需要拦截
        registry.addInterceptor(new LoginInterceptor())
                .excludePathPatterns("/user/code",
                                    "/shop/**",
                                    "/shop-type/**",
                                    "/blog/hot",
                                    "/uplocad/**",
                                    "/voucher/**",
                                    "/user/login"
                ).order(1);
    }
}

2、配置Token 拦截器

public class RefreshTokenInterceptor implements HandlerInterceptor {

    // 通过构造函数获取stringRedisTemplate
    private StringRedisTemplate stringRedisTemplate;

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

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 获取token
        String token = request.getHeader("authorization");
        if(StrUtil.isBlank(token)){
            return true;
        }
        String key = RedisConstants.LOGIN_USER_KEY + token;
        // 基于token获取redis中的用户
        Map<Object, Object> userMap = stringRedisTemplate.opsForHash().entries(key);

        // 判断用户是否存在
        if(userMap.isEmpty()){
            return true;
        }
        // 将查询到的数据转化为UserDto对象
        // 如果不存在，则保存的对象为NULL
        UserDTO userDTO = BeanUtil.fillBeanWithMap(userMap, new UserDTO(), false);
        UserHolder.saveUser(userDTO);

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

3、登陆验证，编写请求拦截器

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