《Redis实战篇》一短信登录

Posted 爱编程的大李子

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了《Redis实战篇》一短信登录相关的知识,希望对你有一定的参考价值。

1.1、导入黑马点评项目

1.1.1 、导入SQL

1.1.2、有关当前模型

手机或者app端发起请求,请求我们的nginx服务器,nginx基于七层模型走的事HTTP协议,可以实现基于Lua直接绕开tomcat访问redis,也可以作为静态资源服务器,轻松扛下上万并发, 负载均衡到下游tomcat服务器,打散流量,我们都知道一台4核8G的tomcat,在优化和处理简单业务的加持下,大不了就处理1000左右的并发, 经过nginx的负载均衡分流后,利用集群支撑起整个项目,同时nginx在部署了前端项目后,更是可以做到动静分离,进一步降低tomcat服务的压力,这些功能都得靠nginx起作用,所以nginx是整个项目中重要的一环。

在tomcat支撑起并发流量后,我们如果让tomcat直接去访问mysql,根据经验Mysql企业级服务器只要上点并发,一般是16或32 核心cpu,32 或64G内存,像企业级mysql加上固态硬盘能够支撑的并发,大概就是4000起~7000左右,上万并发, 瞬间就会让Mysql服务器的cpu,硬盘全部打满,容易崩溃,所以我们在高并发场景下,会选择使用mysql集群,同时为了进一步降低Mysql的压力,同时增加访问的性能,我们也会加入Redis,同时使用Redis集群使得Redis对外提供更好的服务。

1.1.3、导入后端项目

在资料中提供了一个项目源码:

1.1.4、导入前端工程

1.1.5 运行前端项目

1.2 、基于Session实现登录流程

发送验证码:

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

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

短信验证码登录、注册:

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

校验登录状态:

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

补充: 为什么要使用ThreadLocal?
ThreadLoal是线程独享的,每个进入Tomcat的请求都对应着一个线程,将来ThreadLocal会在线程内开辟一片空间来保存用户信息,这些线程互不干扰.。这样的话,不同的用户访问相同的Controller都有自己的线程,也就会有自己的ThreadLocal信息,大家互不干扰。
如何进行退出呢?
在拦截器的最后一个方法中,清空thread local的信息,第一可以做到退出登录,第二可以防止内存泄露

1.3 、实现发送短信验证码功能

页面流程

问题:为啥后端接口是8081,但是请求确实8080呢?

这里为了解决跨域问题请求位于8080的Nginx服务,Nginx的代理再去请求8081Tomcat服务器

具体代码如下

贴心小提示:

具体逻辑上文已经分析,我们仅仅只需要按照提示的逻辑写出代码即可。

  • 发送验证码
@Override
public Result sendCode(String phone, HttpSession session) 
    // 1.校验手机号
    if(RegexUtils.isPhoneInvalid(phone))
        // 2.如果不符合,返回错误信息
        return Result.fail("手机号格式错误");
    
    // 3.如果符合,生成验证码
    String code = RandomUtil.randomNumbers(6);

    // 4.保存验证码到session
    session.setAttribute("code"+phone,code);
    // 5.发送验证码
    String[] phoneNumber = new String[1];
    String[] templateParam = new String[2];
    phoneNumber[0] = phone;
    templateParam[0] = code;
    templateParam[1] = "5";
    SendSmsUtil.sendSms(phoneNumber,templateParam);
    return Result.ok();

  • 登录
@Override
public Result login(LoginFormDTO loginForm, HttpSession session) 
    // 1.验证手机号是否正确
    String code = loginForm.getCode();
    String phone = loginForm.getPhone();
    if(RegexUtils.isPhoneInvalid(phone))
        return Result.fail("手机号格式错误!");
    
    // 2.查询手机号对应的验证码是否一致(存在)
    String cacheCode = (String) session.getAttribute("code" + loginForm.getPhone());
    if(cacheCode != null && !cacheCode.equals(code))
        // 3.不一致,报错
        return Result.fail("验证码错误!");
    

    // 4.一致,根据手机号查询对应的用户
    User user = this.query().eq("phone", phone).one();
    // 5.判断用户是否存在
    if(user == null)
        // 6.不存在,则创建新用户,并保存到数据库
        user  = createUserWithPhone(phone);
    
    // 7.存在,则保存用户到session
    session.setAttribute("user",user);
    return Result.ok();

注意:这里是否需要返回登录成功的凭证信息呢?
不需要,因为登录或注册后会在session中存放user,一个session对应一个sessionID,sessionID会被自动放到Cookie,下次请求时,Cookie会带着JSessionID找到对应的session

1.4、实现登录拦截功能

温馨小贴士:tomcat的运行原理

当用户发起请求时,会访问我们像tomcat注册的端口,任何程序想要运行,都需要有一个线程对当前端口号进行监听,tomcat也不例外,当监听线程知道用户想要和tomcat连接连接时,那会由监听线程创建socket连接,socket都是成对出现的,用户通过socket像互相传递数据,当tomcat端的socket接受到数据后,此时监听线程会从tomcat的线程池中取出一个线程执行用户请求,在我们的服务部署到tomcat后,线程会找到用户想要访问的工程,然后用这个线程转发到工程中的controller,service,dao中,并且访问对应的DB,在用户执行完请求后,再统一返回,再找到tomcat端的socket,再将数据写回到用户端的socket,完成请求和响应

通过以上讲解,我们可以得知 每个用户其实对应都是去找tomcat线程池中的一个线程来完成工作的, 使用完成后再进行回收,既然每个请求都是独立的,所以在每个用户去访问我们的工程时,我们可以使用threadlocal来做到线程隔离,每个线程操作自己的一份数据

温馨小贴士:关于threadlocal

如果小伙伴们看过threadLocal的源码,你会发现在threadLocal中,无论是他的put方法和他的get方法, 都是先从获得当前用户的线程,然后从线程中取出线程的成员变量map,只要线程不一样,map就不一样,所以可以通过这种方式来做到线程隔离

为什么要使用拦截器呢?

如图:如果没有拦截器,那么对于每个Controller都需要一个校验用户是否登录的逻辑代码,代码冗余较大。所有的请求到Controller之前可以被拦截器或者过滤器 拦截,这样的话只要我们在拦截器这一步进行校验就不用再进入Controller了,大大减少了性能损耗

拦截器代码

/**
 * @author lxy
 * @version 1.0
 * @Description 登录拦截器
 * @date 2022/11/24 1:12
 */
public class LoginInterceptor implements HandlerInterceptor 

    /**
     * 在进入Controller之前会被执行
     */
    @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.如果用户不存在,则拦截,返回401状态码
        if(user == null)
            response.setStatus(401);
            return false;
        

        // 4.如果存在,则保存到ThreadLocal
        UserHolder.saveUser((User) user);
        // 5.放行
        return true;
    

    /**
     * 在执行完Controller里面的逻辑后执行下面代码
     */
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception 
        // 移除用户
        UserHolder.removeUser();
    

让拦截器生效

/**
 * @author lxy
 * @version 1.0
 * @Description MVC配置类
 * @date 2022/11/24 1:22
 */
@Configuration
public class MvcConfig implements WebMvcConfigurer 
    @Override
    public void addInterceptors(InterceptorRegistry registry) 
        // 增加登录拦截器,并对不必要的请求路径排除拦截
        registry.addInterceptor(new LoginInterceptor()).excludePathPatterns(
                "/user/login",
                "/user/code",
                "/blog/hot",
                "/shop/**",
                "/shop-type/**",
                "/upload/**",
                "/voucher/**"
        );
    

1.5、隐藏用户敏感信息

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

在登录方法处修改

// 7.存在,则保存用户到session
session.setAttribute("user", BeanUtil.copyProperties(user,UserDTO.class));

在拦截器处:

// 4.如果存在,则保存到ThreadLocal
UserHolder.saveUser((UserDTO) user);

在UserHolder处:将user对象换成UserDTO

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

前端登录结果:

1.6、session共享问题

核心思路分析:

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

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

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

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

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

1.7 Redis代替session的业务流程

1.7.1、设计key的结构

首先我们要思考一下利用redis来存储数据,那么到底使用哪种结构呢?由于存入的数据比较简单,我们可以考虑使用String,或者是使用哈希,如下图。

  • 如果使用String,注意他的value,会多占用一点空间(比如标点,括号等),而且字段修改,只能对Value整体修改,然后再设置进去

  • 如果使用哈希,则他的value中只会存储数据本身,而且可以做到精确的修改Value中的某个字段(name,age)

    如果不是特别在意内存,其实使用String就可以啦。

1.7.2、设计key的具体细节

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

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

1、key要具有唯一性

2、key要方便携带

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

1.7.3、整体访问流程

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

session和Redis 验证用户登录原理的区别

  • 之前我们使用session进行登录的时候,当把User存到session后,会自动把SessionID存到Cookie中,下次发送请求的时候会携带着。通过SessionId便可知道用户是否登录。

  • 当我们使用Redis后,key == 》token:随机字符串,value是User。这时 为了让用户下次发送请求携带着key,就需要前端特殊处理了~

1.8 基于Redis实现短信登录

这里具体逻辑就不分析了,之前咱们已经重点分析过这个逻辑啦。

UserServiceImpl代码

@Override
public Result login(LoginFormDTO loginForm, HttpSession session) 
    // 1.验证手机号是否正确
    String code = loginForm.getCode();
    String phone = loginForm.getPhone();
    if (RegexUtils.isPhoneInvalid(phone)) 
        return Result.fail("手机号格式错误!");
    
    // 2.查询手机号对应的验证码是否一致(存在)
    String cacheCode = (String) stringRedisTemplate.opsForValue().get(RedisConstants.LOGIN_CODE_KEY + phone);
    if (cacheCode != null && !cacheCode.equals(code)) 
        // 3.不一致,报错
        return Result.fail("验证码错误!");
    

    // 4.一致,根据手机号查询对应的用户
    User user = this.query().eq("phone", phone).one();
    // 5.判断用户是否存在
    if (user == null) 
        // 6.不存在,则创建新用户,并保存到数据库
        user = createUserWithPhone(phone);
    

    // 7.存在,则保存用户到Redis
    // 7.1 随机生成token,作为登录令牌   参数:生成一段没有连接符的随机数
    String token = UUID.randomUUID().toString(true);
    // 7.2 准备用户基本信息
    UserDTO userDTO = BeanUtil.copyProperties(user, UserDTO.class);
    //注意:这里如果直接这样写 BeanUtil.beanToMap(userDTO) 会报错: Long cannot be cast to String。
    //     因为我们使用的是stringRedisTemplate,里面存的map的key和value都必须是String.
    //解决办法:1.不使用该方法,而是手动把userDTO放入Map<String,String>,该转换的手动转
    //        2.自定义value的转换规则,可以通过 BeanUtil.beanToMap(obj,map,copyOptions)
    Map <String, Object> map = BeanUtil.beanToMap(userDTO, new HashMap <>(), CopyOptions.create()
                                                  .setIgnoreNullValue(true)
                                                  .setFieldValueEditor((fieldName, fieldValue) -> fieldValue.toString()));
    // 7.3 保存到Redis  (这里也可使用put(),但是Value中的key和value是分开放的,需要多次和数据库交互~)
    String tokenKey = RedisConstants.LOGIN_USER_KEY + token;
    stringRedisTemplate.opsForHash().putAll(tokenKey, map);
    // 7.4 设置token有效期
    stringRedisTemplate.expire(tokenKey, RedisConstants.LOGIN_USER_TTL, TimeUnit.MINUTES);

    // 8.把token返回给前端
    return Result.ok(token);

LoginInterceptor代码

/**
 * @author lxy
 * @version 1.0
 * @Description 登录拦截器
 * @date 2022/11/24 1:12
 */
public class LoginInterceptor implements HandlerInterceptor 

    /**
     * 因为LoginInterceptor是new 出来的,并没有交给Spring容器管理,所以我们不能使用Autowire或者@Resource注入,
     * 这里可以使用构造函数,在使用到拦截器的时候,传入需要的对象
     */
    private StringRedisTemplate stringRedisTemplate;

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

    /**
     * 在进入Controller之前会被执行
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception 
        // 1.获取请求头中的token
        String token = request.getHeader("authorization");
        if (StrUtil.isBlank(token)) 
            // 不存在
            response.setStatus(401);
            return false;
        

        // 2.根据token获取用户信息
        Map <Object, Object> userMap = stringRedisTemplate.opsForHash().entries(RedisConstants.LOGIN_USER_KEY+token);
        if(userMap==null)
            response.setStatus(401);
            return false;
        

        // 3.如果存在,则保存到ThreadLocal
        UserDTO userDTO = BeanUtil.fillBeanWithMap(userMap, new UserDTO(), false);
        UserHolder.saveUser(userDTO);

        // 4.刷新用户token的有效时间 (只要用户在这段时间内用户在线,那么就不会过期)
        String tokenKey = RedisConstants.LOGIN_USER_KEY+token;
        stringRedisTemplate.expire(tokenKey,RedisConstants.LOGIN_USER_TTL, TimeUnit.MINUTES);

        // 5.放行
        return true;
    

    /**
     * 在执行完Controller里面的逻辑后执行下面代码
     */    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception 
        // 移除用户
        UserHolder.removeUser();
    

1.9 解决状态登录刷新问题

1.9.1 初始方案思路总结:

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

1.9.2 优化方案

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

1.9.3 代码

RefreshTokenInterceptor

/**
 * @author lxy
 * @version 1.0
 * @Description 登录拦截器
 * @date 2022/11/24 1:12
 */
public class RefreshTokenInterceptor implements HandlerInterceptor 

    /**
     * 因为RefreshTokenInterceptor是new 出来的,并没有交给Spring容器管理,所以我们不能使用Autowire或者@Resource注入,
     * 这里可以使用构造函数,在使用到拦截器的时候,传入需要的对象
     */
    private StringRedisTemplate stringRedisTemplate;

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

    /**
     * 在进入Controller之前会被执行
     */
    @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是对的,若return false,第一次访问登录页面时就会被拦截;
            // 若return true,第一次访问登录页会进入Login拦截器,由于登录页为放行路径,放行~
            return true;
        

        // 2.根据token获取用户信息
        Map <Object, Object> userMap = stringRedisTemplate.opsForHash().entries(RedisConstants.LOGIN_USER_KEY+token);
        if(userMap==null)
            return true;
        

        // 3.如果存在,则保存到ThreadLocal
        UserDTO userDTO = BeanUtil.fillBeanWithMap(userMap, new UserDTO(), false);
        UserHolder.saveUser(userDTO);

        // 4.刷新用户token的有效时间 (只要用户在这段时间内用户在线,那么就不会过期)
        String tokenKey = RedisConstants.LOGIN_USER_KEY+token;
        stringRedisTemplate.expire(tokenKey,RedisConstants.LOGIN_USER_TTL, TimeUnit.MINUTES);

        // 5.放行
        return true;
    

    /**
     * 在执行完Controller里面的逻辑后执行下面代码
     */    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception 
        // 移除用户
        UserHolder.removeUser();
    

LoginInterceptor

/**
 * @author lxy
 * @version 1.0
 * @Description 登录拦截器
 * @date 2022/11/24 1:12
 */
public class LoginInterceptor implements HandlerInterceptor 

    /**
     * 在进入Controller之前会被执行
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception 
        // 如果没有登录则拦截
        if以上是关于《Redis实战篇》一短信登录的主要内容,如果未能解决你的问题,请参考以下文章

Redis 02-实战篇Redis

短信验证登录实现流程

springboot整合redis之发送手机验证码注册登录

Redis实战之使用Lua脚本保证原子性

RedisRedis 的共享 session 应用(短信登录)

RedisRedis 的共享 session 应用(短信登录)