《Redis实战篇》一、短信登录

阿里云国内75折 回扣 微信号:monov8
阿里云国际,腾讯云国际,低至75折。AWS 93折 免费开户实名账号 代冲值 优惠多多 微信号:monov8 飞机:@monov6

1.1、导入黑马点评项目

1.1.1 、导入SQL

1653057872536

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 核心cpu32 或64G内存像企业级mysql加上固态硬盘能够支撑的并发大概就是4000起~7000左右上万并发 瞬间就会让Mysql服务器的cpu硬盘全部打满容易崩溃所以我们在高并发场景下会选择使用mysql集群同时为了进一步降低Mysql的压力同时增加访问的性能我们也会加入Redis同时使用Redis集群使得Redis对外提供更好的服务。

1653059409865

1.1.3、导入后端项目

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

image-20221123234818386

1.1.4、导入前端工程

1.1.5 运行前端项目

image-20221123235538872

1.2 、基于Session实现登录流程

发送验证码

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

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

短信验证码登录、注册

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

校验登录状态:

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

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

image-20221123235626516

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

页面流程

1653067054461

问题为啥后端接口是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对应一个sessionIDsessionID会被自动放到Cookie下次请求时Cookie会带着JSessionID找到对应的session

1.4、实现登录拦截功能

温馨小贴士tomcat的运行原理

1653068196656

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

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

温馨小贴士关于threadlocal

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

为什么要使用拦截器呢

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

image-20221124003222322

1653068874258

拦截器代码

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

前端登录结果

image-20221124230507123

1.6、session共享问题

核心思路分析

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

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

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

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

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

1653069893050

1.7 Redis代替session的业务流程

1.7.1、设计key的结构

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

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

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

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

1653319261433

1.7.2、设计key的具体细节

所以我们可以使用String结构就是一个简单的keyvalue键值对的方式但是关于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中并且放行。

1653319474181

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

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

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

image-20221124235455820

image-20221125000104800

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令牌的存活时间但是现在这个拦截器他只是拦截需要被拦截的路径假设当前用户访问了一些不需要拦截的路径比如首页那么这个拦截器就不会生效所以此时令牌刷新的动作实际上就不会执行所以这个方案他是存在问题的

1653320822964

1.9.2 优化方案

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

1653320764547

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(UserHolder.getUser()==null){
            response.setStatus(401);
            return false;
        }
        // 用户已经登录则放行
        return true;
    }
}

总结Redis代替Session需要考虑的问题

  • 选择合适的数据结构
    • 比如为什么code选择用stringtoken选择用Hash
  • 选择合适的Key
    • 比如为什么验证码key是phone, token的key是一个随机字符串
  • 选择合适的存储力度
    • 比如我们存储的是UserDTO相对于User把其中敏感的信息去掉也可以节约内存空间
  • 选择合适的有效期
阿里云国内75折 回扣 微信号:monov8
阿里云国际,腾讯云国际,低至75折。AWS 93折 免费开户实名账号 代冲值 优惠多多 微信号:monov8 飞机:@monov6
标签: redis

“《Redis实战篇》一、短信登录” 的相关文章