Redis实战1.短信登录

最新推荐文章于 2024-09-26 16:13:18 发布

Gus10124

最新推荐文章于 2024-09-26 16:13:18 发布

阅读量888

点赞数 30

文章标签： redis

本文链接：https://blog.csdn.net/Gus10124/article/details/139273735

版权

基于Session实现登录

session的原理是Cookie，每一个Session都会有一个唯一的SessionId，在访问Tomcat 时已经写到cookie中了，请求的时候就会带着该id

登录流程

发送验证码：

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

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

短信验证码登录、注册：

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

校验登录状态:

用户在请求时候，会从cookie中携带者JsessionId到后台，后台通过JsessionId从session中拿到用户信息，如果没有session信息，则进行拦截，如果有session信息，则将用户信息保存到ThreadLocal(线程内部创建一个map保存)中，并且放行

具体实现

发送短信验证码功能

请求路径和请求方式：

分析得出UserController:

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

IUserService

public interface IUserService extends IService<User> {

    /**
     * 发送手机验证码
     */
    Result sendCode(String phone, HttpSession session);
}

UserServiceImpl

继承的 ServiceImpl<UserMapper, User> 由 mybatis-plus 提供，帮助我们实现单表的增删改查

实体类: User && Mapper: UserMapper

@Service
@Slf4j
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements IUserService {
    @Override
    public Result sendCode(String phone, HttpSession session) {
        // 1.校验手机号
        if (RegexUtils.isPhoneInvalid(phone)) {
            // 2.如果不符合，返回错误信息
            return Result.fail("手机号格式错误！");
        }
        // 3.符合，生成验证码
        //Hutool工具类随机数生成
        String code = RandomUtil.randomNumbers(6);

        // 4.保存验证码到 session
        session.setAttribute("code",code);
        // 5.发送验证码
        //发送验证码涉及调用第三方平台，暂时不做，写个日志记录
        log.debug("发送短信验证码成功，验证码：{}", code);
        // 返回ok
        return Result.ok();
    }
}

校验手机号调用RegexUtils的方法

 /**
     * 是否是无效手机格式
     * @param phone 要校验的手机号
     * @return true:符合，false：不符合
     */
    public static boolean isPhoneInvalid(String phone){
        return mismatch(phone, RegexPatterns.PHONE_REGEX);
    }

    // 校验是否不符合正则格式
    private static boolean mismatch(String str, String regex){
        if (StrUtil.isBlank(str)) {
            return true;
        }
        return !str.matches(regex);
    }

手机号的正则表达式：

 /**
     * 手机号正则
     */
    public static final String PHONE_REGEX = "^1([38][0-9]|4[579]|5[0-3,5-9]|6[6]|7[0135678]|9[89])\\d{8}$";

小tips：

前端、后端都需要检验，因为前端的检验可以被绕过

短信验证码登录

UserController

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

UserServiceImpl

public Result login(LoginFormDTO loginForm, HttpSession session) {
        // 1.校验手机号
        String phone = loginForm.getPhone();
        if (RegexUtils.isPhoneInvalid(phone)) {
            // 2.如果不符合，返回错误信息
            return Result.fail("手机号格式错误！");
        }
        // 3.校验验证码
        Object cacheCode = session.getAttribute("code");
        String code = loginForm.getCode();
        if (cacheCode == null || !cacheCode.toString().equals(code)) {
            //3.不一致，报错
            return Result.fail("验证码错误");
        }
        //一致，根据手机号查询用户 select
        User user = query().eq("phone", phone).one();
        //query() == select * from tb_user
        //5.判断用户是否存在
        if (user == null) {
            //不存在，则创建
            user = createUserWithPhone(phone);
        }
        //7.保存用户信息到session中
        session.setAttribute("user", user);

        return Result.ok();
    }

    private User createUserWithPhone(String phone) {
        //1. 创建用户
        User user = new User();
        user.setPhone(phone);
        user.setNickName(SystemConstants.USER_NICK_NAME_PREFIX + RandomUtil.randomNumbers(10));
        //2. 保存用户信息到数据库
        save(user);
        return user;
    }

点击获取验证码按钮，控制台打印出生成的验证码

进行登录：

mybatis-plus小tips：

query() == select * from tb_user

① 表名是通过User实体类的注解 @TableName("tb_user") 知道的

② .one() 表示查一条数据，查多条是.list()

登录验证功能

问题：随着后续业务的开发，越来越多的业务需要校验用户登录。可以加入一个拦截器（springMVC实现的），将拦截器得到的信息传到Controller中。线程安全问题ThreadLocal解决，做到线程隔离，每个线程操作自己的一份数据。

拦截器 LoginInterceptor

public class LoginInterceptor implements HandlerInterceptor {
    //登录校验
    @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. 不存在，401未授权
            response.setStatus(401);
            return false;
        }
        //5. 存在，保存用户信息到ThreadLocal
        UserHolder.saveUser((UserDTO) user);
        //6. 放行
        return true;
    }

    //业务执行完毕，销毁信息避免泄露(弱引用问题，可网上搜索一下)
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        //移除用户
        UserHolder.removeUser();
    }
}

配置拦截器

@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"
                ).order(1);

    }
}

隐藏用户敏感信息

我们通过浏览器观察到此时用户的全部信息都在，这样极为不靠谱，所以我们应当在返回用户信息之前，将用户的敏感信息进行隐藏，采用的核心思路就是书写一个UserDto对象，这个UserDto对象就没有敏感信息了，我们在返回前，将有用户敏感信息的User对象转化成没有敏感信息的UserDto对象，那么就能够避免这个尴尬的问题了

在登录方法处修改

//7.保存用户信息到session中
session.setAttribute("user", BeanUtils.copyProperties(user,UserDTO.class));

在拦截器处：

//5.存在，保存用户信息到Threadlocal
UserHolder.saveUser((UserDTO) user);

在UserHolder处：将user对象换成UserDTO

集群的session共享问题

核心思路分析：

每个tomcat中都有一份属于自己的session,假设用户第一次访问第一台tomcat，并且把自己的信息存放到第一台服务器的session中，但是第二次这个用户访问到了第二台tomcat，那么在第二台服务器上，肯定没有第一台服务器存放的session，所以此时整个登录拦截功能就会出现问题，我们能如何解决这个问题呢？

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

基于Redis实现共享session登录

设计key

由于存入的数据比较简单，我们可以考虑使用String，就是一个简单的key，value键值对的方式，但是关于key的处理，session他是每个用户都有自己的session，但是redis的key是共享的，咱们就不能使用"code"了。用户信息选择哈希类型

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

整体访问流程

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

修改代码

UserServiceImpl

sendCode方法

保存验证码到session改为保存验证码到 redis

① 注入StringRedisTemplate 对象

    @Resource
    private StringRedisTemplate stringRedisTemplate;

@Resource 注解是 Java EE 平台提供的一种依赖注入方式，用于在代码中注入资源，如数据库连接、消息队列连接等。它提供了一种简单的方式来注入资源，而不需要像 @Autowired 或 @Inject 那样需要进行配置。

②修改

//4.保存验证码到 redis ，和其他业务区分开     key 设计有效期

stringRedisTemplate.opsForValue().set(RedisConstants.LOGIN_CODE_KEY + phone, code, RedisConstants.LOGIN_CODE_TTL, TimeUnit.MINUTES);

login方法

① 从redis获取验证码并校验

        // 3.从redis获取验证码并校验
        String cacheCode = stringRedisTemplate.opsForValue().get(RedisConstants.LOGIN_CODE_KEY + phone);
        String code = loginForm.getCode();
        if (cacheCode == null || !cacheCode.equals(code)) {
            //3.不一致，报错
            return Result.fail("验证码错误");
        }

②保存用户信息到redis中

        // 7.保存用户信息到 redis中
        // 7.1.随机生成token，作为登录令牌
        String token = UUID.randomUUID().toString(true);
        // 7.2.将User对象转为HashMap存储，可以一次性 put 到redis (.putAll())
        UserDTO userDTO = BeanUtil.copyProperties(user, UserDTO.class);
        Map<String, Object> userMap = BeanUtil.beanToMap(userDTO, new HashMap<>(),
                CopyOptions.create()
                        .setIgnoreNullValue(true)//忽略null值
                        .setFieldValueEditor((fieldName, fieldValue) -> fieldValue.toString()));//字段值修改器，拿到value后都转成字符串
        // 7.3.存储
        String tokenKey = RedisConstants.LOGIN_USER_KEY + token;
        stringRedisTemplate.opsForHash().putAll(tokenKey, userMap);
        // 7.4.设置token有效期
        stringRedisTemplate.expire(tokenKey, RedisConstants.LOGIN_USER_TTL, TimeUnit.MINUTES);

        // 8.返回token
        return Result.ok(token);

注：UserDTO中的id字段是Long，转成Map时会出问题：无法通过StringRedisSerializer存储到redis，因为使用的是 stringRedisTemplate，要求key value都是String。

解决方法：

①自己new一个map

②BeanUtil.beanToMap可以自定义，加入第二个参数 new HashMap<>()，第三个参数CopyOptions，通过set自定义

注：BeanUtil 是Hutool 工具类的

LoginInterceptor

①注入 StringRedisTemplate

    private StringRedisTemplate stringRedisTemplate;

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

这里注入不能使用@Autowired等注解，只能使用构造函数

因为 LoginInterceptor 类的对象是我们手动 new 出来的，不是通过Spring构建的

我们可以在使用到 StringRedisTemplate 的地方（MvcConfig）注入

②改写preHandle方法

 //1. 获取 请求头中的 token
        String token = request.getHeader("authorization");
        //"authorization"是根据前端得到的
        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;
        }
        //将查询到的hash数据转为UserDTO对象
        UserDTO userDTO = BeanUtil.fillBeanWithMap(userMap, new UserDTO(), false);
        //5. 存在，保存用户信息到ThreadLocal
        UserHolder.saveUser(userDTO);
        //刷新Token有效期
        stringRedisTemplate.expire(key,RedisConstants.LOGIN_USER_TTL, TimeUnit.MINUTES);

总结

Redis代替session需要考虑的问题：

1. 选择合适的数据结构

2. 选择合适的key，唯一性，方便找到，设置有效期

3. 选择合适的存储粒度，只保存不敏感、页面需要的数据，节省内存空间

解决登录刷新问题

初始方案小问题

我们想确保用户只要一直在操作，token就不会消失。目前做不到，因为这个拦截器拦截的不是一切路径。如果用户一直访问不需要登录的页面，如首页，token就不会刷新。

优化方案

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

复制 LoginInterceptor 改为 RefreshTokenInterceptor

判断环节不拦截全部放行

 if (StrUtil.isBlank(token)) {
            return true;
        }

if (userMap.isEmpty()) {
            return true;
        }

更新 LoginInterceptor 的 perhandle方法

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

配置MvcConfig 的 addInterceptors 方法

public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new LoginInterceptor())
                .excludePathPatterns(
                        "/shop/**",
                        "/voucher/**",
                        "/shop-type/**",
                        "/upload/**",
                        "/blog/hot",
                        "/user/code",
                        "/user/login"
                ).order(1);
        //拦所有的token 刷新拦截器，要求 先执行 -> order: 0 > 1
        registry.addInterceptor(new RefreshTokenInterceptor(stringRedisTemplate)).order(0);
    }