Java – Redis案例 – 短信登陆

简介

本案例讲解如何使用 Redis 来代替 Session 进行保存用户登陆信息及用户登陆注册时的短信验证码临时保存功能。

项目前置

项目原理

客户端通过访问由 NGINX 静态服务器，通过Vue和Axios进行前后端分离访问，后端采用 SpringBoot 搭建服务器，原项目使用 Session 保存用户登陆信息，将改造为使用 Redis 来保存。

基于 Session 实现登陆流程

发送验证码：

用户在提交手机号后，会校验手机号是否合法，如果不合法，则要求用户重新输入手机号

如果手机号合法，后台此时生成对应的验证码，同时将验证码进行保存，然后再通过短信的方式将验证码发送给用户

短信验证码登录、注册：

用户将验证码和手机号进行输入，后台从session中拿到当前验证码，然后和用户输入的验证码进行校验，如果不一致，则无法通过校验，如果一致，则后台根据手机号查询用户，如果用户不存在，则为用户创建账号信息，保存到数据库，无论是否存在，都会将用户信息保存到session中，方便后续获得当前登录信息

校验登录状态:

用户在请求时候，会从cookie中携带者JsessionId到后台，后台通过JsessionId从session中拿到用户信息，如果没有session信息，则进行拦截，如果有session信息，则将用户信息保存到threadLocal中，并且放行

发送短信验证码功能实现

实现代码如下：

UserController:
    /**
     * 发送手机验证码
     */
    @PostMapping("code")
    public Result sendCode(@RequestParam("phone") String phone, HttpSession session) {

        return userService.sendCode(phone, session);
    }

sendCode 实现方法

sendCode 实现方法
/**
     * 生成验证码
     *
     * @param phone   手机号
     * @param session session
     * @return
     */
    @Override
    public Result sendCode(String phone, HttpSession session) {

        // 1.验证手机号是否合法
        if (RegexUtils.isPhoneInvalid(phone)) {
            return Result.fail("手机号不正确");
        }

        // 2.生成验证码
        String code = RandomUtil.randomNumbers(6);

        // 3.存到session中
        session.setAttribute("code", code);

        // 4.发送验证码短信（模拟）
        log.debug("验证码为: {}", code);

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

登陆功能实现：

/**
     * 登录功能
     *
     * @param loginForm 登录参数，包含手机号、验证码；或者手机号、密码
     */
    @PostMapping("/login")
    public Result login(@RequestBody LoginFormDTO loginForm, HttpSession session) {

        return userService.login(loginForm, session);
    }

login方法实现

/**
     * 用户手机登陆功能
     *
     * @param loginForm 登陆表单
     * @param session   session
     * @return
     */
    @Override
    public Result login(LoginFormDTO loginForm, HttpSession session) {
        // 1.验证手机号
        String phone = loginForm.getPhone();
        if (RegexUtils.isPhoneInvalid(phone)) {
            return Result.fail("手机号不正确");
        }

        // 2.验证码验证
        String cacheCode = loginForm.getCode();
        Object code = session.getAttribute("code");
        if (!code.toString().equals(cacheCode)) {
            return Result.fail("验证码不正确");
        }

        // 3.查询数据库取得用户信息
        User user = query().eq("phone", phone).one();


        // 4.如果数据库中不存在用户信息，则说明是新用户，需要创建用户
        if (user == null) {
            user = createNewUserByPhone(phone);
            save(user);
        }

        /**
         * 系统中线程保存登陆用户类型为UserDTO，所以只能在查询数据后转为UserDTO类型
         */
        UserDTO userDTO = BeanUtil.copyProperties(user, UserDTO.class);

        // 5.发送登陆结果到session
        session.setAttribute("user", userDTO);

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

至此登陆功能已完成，但是登陆后我们需要对系统中某一些页面进行权限验证，所以需要对登陆成功的用户保存在Session中，以便在用户访问需要登陆才能访问的接口上进行权限认证。

我们需要创建一个拦截器，对用户所有的请求都进行验证

实现登录拦截功能

拦截器代码如下：

/**
 * 对用户是否登陆进行拦截
 * 通过拦截请求，检查用户是否带有登陆信息，而判断是否允许用户继续访问下去
 */
public class LoginInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        HttpSession session = request.getSession();
        Object user = session.getAttribute("user");
        if (user == null){
            // 没有验证登陆
            response.setStatus(401);
            return false;
        }
        // 用于保存成功登陆的用户信息，提供给后面需要获取用户信息的实现类使用
        UserHolder.saveUser((UserDTO) user);

        return true;
    }

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

配置好拦截器后，需要把拦截器加入到SpringMVC中才能生效

@Configuration
public class SpringMVCConfig implements WebMvcConfigurer {

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

session共享问题

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

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

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

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

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

Redis 替代 Session 实现登陆功能

设计key的具体细节

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

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

1、key要具有唯一性

2、key要方便携带

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

整体访问流程

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

基于Redis实现短信登录

实现代码如下：

    /**
     * 生成验证码
     * 使用 Redis 进行存取
     *
     * @param phone 手机号
     * @return
     */
    @Override
    public Result sendCode(String phone) {

        // 1.验证手机号是否合法
        if (RegexUtils.isPhoneInvalid(phone)) {
            return Result.fail("手机号不正确");
        }

        // 2.生成验证码
        String code = RandomUtil.randomNumbers(6);

        // 3.存到Redis中
        stringRedisTemplate.opsForValue().set(LOGIN_CODE_KEY + phone, code, LOGIN_CODE_TTL, TimeUnit.MINUTES);

        // 4.发送验证码短信（模拟）
        log.debug("验证码为: {}", code);

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

登陆实现代码如下：

    /**
     * 用户手机登陆功能
     * 通过 Redis 取出验证码
     *
     * @param loginForm 登陆表单
     * @return
     */
    @Override
    public Result login(LoginFormDTO loginForm) {
        // 1.验证手机号
        String phone = loginForm.getPhone();
        if (RegexUtils.isPhoneInvalid(phone)) {
            return Result.fail("手机号不正确");
        }

        // 2.从Redis中取出验证码并验证
        String cacheCode = loginForm.getCode();
        String code = stringRedisTemplate.opsForValue().get(LOGIN_CODE_KEY + phone);
        if (!code.equals(cacheCode)) {
            return Result.fail("验证码不正确");
        }

        // 3.查询数据库取得用户信息
        User user = query().eq("phone", phone).one();


        // 4.如果数据库中不存在用户信息，则说明是新用户，需要创建用户
        if (user == null) {
            user = createNewUserByPhone(phone);
            save(user);
        }

        /**
         * 系统中线程保存登陆用户类型为UserDTO，所以只能在查询数据后转为UserDTO类型
         */
        UserDTO userDTO = BeanUtil.copyProperties(user, UserDTO.class);

        /**
         * 把UserDTO中的数据转换成HashMap
         * 注意：因为这里使用了 StringRedisTemplate 进行操作
         * 要求存到Redis中的所有数据，都必须是String类型的
         * 但是 UserDTO 中存在 成员为 Long 类型的数据（id）
         * 直接存到Redis中会提示无法将 Long 转为 String 类型错误
         * 此时，这里需要设置复制配置，把所有的数据类型，都转为String后再存储
         */
        Map<String, Object> userMap = BeanUtil.beanToMap(userDTO, new HashMap<>(),
                CopyOptions.create()
                        .setIgnoreNullValue(false)
                        .setFieldValueEditor((fieldName, fieldValue) -> fieldValue.toString()));

        // 5.发送登陆结果到Redis中
        String token = UUID.randomUUID().toString(true);
        stringRedisTemplate.opsForHash().putAll(LOGIN_USER_KEY + token, userMap);
        stringRedisTemplate.expire(LOGIN_USER_KEY + token, LOGIN_USER_TTL, TimeUnit.SECONDS);
        // 验证完成后删除短信验证码记录
        stringRedisTemplate.delete(LOGIN_CODE_KEY + phone);
        // 6.返回结果
        return Result.ok(token);
    }

    // 当手机用户没有注册过时，则注册一个
    private User createNewUserByPhone(String phone) {
        User user = new User();
        user.setPhone(phone);
        user.setNickName(USER_NICK_NAME_PREFIX + RandomUtil.randomString(10));
        return user;
    }

解决登陆状态刷新问题

因为Session可以设置当用户多久没有操作时，登陆信息就会自动过期功能，但是Redis中只有过期时间，不管用户是否进行了操作，但是过期时间依然不会变，我们需要做的是，当用户产生了访问时，应该要重置Redis中用户信息的过期时间。

要注意的是，我们应该对所有页面请求都需要实现重置过期时间的问题，而不是单单访问需要授权的请求才重置，所以我们需要再加一个拦截器，拦截所有的请求，让访问任意请求都触发Redis重置过期时间。

public class RefreshInterceptor implements HandlerInterceptor {

    private StringRedisTemplate stringRedisTemplate;

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

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

        String token = request.getHeader("authorization");

        if (StrUtil.isBlank(token)){
            // 如果没有传回 token,说明没有登陆
            return true;
        }

        // 通过 Redis 中获取 userDTO 数据
        Map<Object, Object> userMap = stringRedisTemplate.opsForHash().entries(LOGIN_USER_KEY + token);

        if (userMap.isEmpty()) {
            // 没有验证登陆
            return true;
        }

        // 把 Redis 中取出的数据转回Bean类型
        UserDTO userDTO = BeanUtil.fillBeanWithMap(userMap, new UserDTO(), false);
        UserHolder.saveUser(userDTO);
        // 并把过期时间刷新重置为1小时
        stringRedisTemplate.expire(LOGIN_USER_KEY + token, LOGIN_USER_TTL, TimeUnit.SECONDS);

        return true;
    }

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

对所有请求都进行刷新，但如果用户没有登陆时，则直接跳过。

public class LoginInterceptor implements HandlerInterceptor {

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

        // 对需要登陆才能访问的请求进行拦截
        UserDTO userDTO = UserHolder.getUser();

        if (userDTO == null){
            // 如果没有 userDTO,说明没有登陆
            response.setStatus(401);
            return false;
        }

        // 带有userDTO的就可以放行
        return true;
    }

}

经过上面第一个拦截器拦截后，解决了用户登陆时间过期的问题，但是如果遇到未登陆的用户访问需要授权的接口时，需要进行判断，如果没有登陆，则返回 401错误

如下图所示：

至此，使用Redis代替Session实现登陆注册功能完成。