【SpringBoot框架篇】19.集成spring-session利用redis来实现session共享

灰太狼 2023-01-07 12:27 145阅读 0赞

### 文章目录 ###

*  简介
 *  引入依赖
 *  application.yml配置
 *  编写session拦截器
 *  启用RedisHttpSession和注册拦截器
 *  测试
 *   *  测试用的Model类
     *  测试用的接口
     *  测试流程
 *  项目配套代码

# 简介 #

单机部署web应用的时候session是唯一的,但是如果水平扩展后,通过nginx负载访问,就会出现session不一致的情况,  
例如在A节点登录的用户,后续的操作请求访问到B节点的接口,但是B节点session中没有用户身份信息,就会导致重新跳转到登录页的情况。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21pbmcxOTk1MTIyNA_size_16_color_FFFFFF_t_70]

解决session几种方式,还有其它的就不全列举出来了

*  **session复制**：例如Tomcat的广播机制
 *  **session持久化**：把session信息放入sql数据库或者nosql数据库中,例如放入redis中
 *  **反向代理hash一致性**：四层hash和七层hash都可以做，保证一个用户的请求落在一台web-server上,如nginx配置如下即可解决session不一致的问题.

#七层 hash 
    upstream tomcatServer{ 
    ip_hash;
    server 192.168.31.139:8080;
    server 192.168.31.138:8080; 
    }

**ip\_hash**保证每个访客固定访问一个后端服务器,nginx配置这块可以参考我的博客【[Nginx从入门到应用][Nginx]】

此文使用**SpringBoot**\+**Spring-session**\+**Redis**实现Session的共享

# 引入依赖 #

<dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            
            
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-data-redis</artifactId>
                <version>2.3.0.RELEASE</version>
            </dependency>
    
            
            <dependency>
                <groupId>org.springframework.session</groupId>
                <artifactId>spring-session-data-redis</artifactId>
            </dependency>

# application.yml配置 #

spring:
      session:
      	#session存储方式
        store-type: redis
      redis:
        host: 127.0.0.1
        port: 6379
        #redis的超时时间
        timeout: 3000
        #设置会话操作后立即更新到redis中,默认是等服务器请求结束后再将变化的值同步到redis中
        flush-mode: immediate
        pool:
          # 连接池中的最大空闲连接
          min-idle: 0
          # 连接池中的最大空闲连接
          max-idle: 8
          # 连接池最大连接数（使用负值表示没有限制）
          max-active: 8
          # 连接池中的最小空闲连接
          max-wait: -1

# 编写session拦截器 #

*  1.查看session中的user是否为null
 *  2.根据用户名去redis查询对应的sessionId信息
 *  3.如果查询的为null或者取出来的sessionId和当前会话的sessionId不一致,则拦截,否则放行

@Component
    public class RedisSessionInterceptor implements HandlerInterceptor { 
    
        @Autowired
        private StringRedisTemplate redisTemplate;
    
        @Override
        public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { 
            HttpSession session = request.getSession();
            if (session.getAttribute("user") != null) { 
                try { 
                    User user = (User) session.getAttribute("user");
                    //验证当前请求的session是否是已登录的session
                    String loginSessionId = redisTemplate.opsForValue().get("loginUser:" + user.getUsername());
                    if (loginSessionId != null && loginSessionId.equals(session.getId())) { 
                        return true;
                    }
                } catch (Exception e) { 
                    e.printStackTrace();
                }
            }
            response401(response);
            return false;
        }
    
        private void response401(HttpServletResponse response) { 
            response.setCharacterEncoding("UTF-8");
            response.setContentType("application/json; charset=utf-8");
            try { 
                response.getWriter().print("用户未登录或登陆超时！");
            } catch (IOException e) { 
                e.printStackTrace();
            }
        }
    }

# 启用RedisHttpSession和注册拦截器 #

对除了登录接口的所有以\*\*/api\*\*开头的接口进行拦截.

@EnableRedisHttpSession(maxInactiveIntervalInSeconds = 20)//session过期时间(秒)
    @Configuration
    public class RedisSessionConfig implements WebMvcConfigurer { 
        @Autowired
        RedisSessionInterceptor redisSessionInterceptor;
        @Override
        public void addInterceptors(InterceptorRegistry registry)
        { 
            //所有已api开头的访问都要进入RedisSessionInterceptor拦截器进行登录验证;
            registry.addInterceptor(redisSessionInterceptor).addPathPatterns("/api/**").excludePathPatterns("/api/login/**");
        }
    }

# 测试 #

## 测试用的Model类 ##

public class User implements Serializable { 
        private String username;
        private String loginSessionId;
        //省略 get,set 方法 ...
    }

存放到session的model必须实现Serializable接口,不然会出现**org.springframework.data.redis.serializer.SerializationException**序列化异常,如下  
![在这里插入图片描述][20210117222352300.png]

## 测试用的接口 ##

@RestController
    @RequestMapping("/api")
    public class UserController { 
    
        @Autowired
        private StringRedisTemplate redisTemplate;
    
        @GetMapping("/login/{username}")
        public User login(HttpSession session, @PathVariable String username){ 
            User user=new User();
            user.setUsername(username);
            user.setLoginSessionId(session.getId());
            session.removeAttribute("user");
            session.setAttribute("user",user);
            redisTemplate.opsForValue().set("loginUser:"+username, session.getId());
            return user;
        }
    
        @GetMapping("/index")
        public User index(HttpSession session){ 
            User user=(User) session.getAttribute("user");
            return user;
        }
    }

## 测试流程 ##

**1.首先启动应用2次,端口例如8020,8021**

idea中同一个项目启动2次操作如下  
![在这里插入图片描述][20210117222516354.png]  
勾选Allow Paraller run，让idea支持同一个项目启动多次  
![在这里插入图片描述][20210117222529306.png]  
启动完第1个端口的时候,把配置文件的端口修改成8021,然后再次启动即可。

**2.打开浏览器访问: http://localhost:8020/api/login/test**

![在这里插入图片描述][20210117223514270.png]

**3.再打开一个窗口访问: http://localhost:8021/api/index**  
![在这里插入图片描述][20210117223524711.png]

可以看到上面2个图片返回的sessionId是一致的,表示着操作已经成功了,

**4.测试session拦截器是否有效**  
@EnableRedisHttpSession(maxInactiveIntervalInSeconds = 20)

由于我上面配置的session超时时间是**20**秒,所以等20秒后再访问/api/index接口就可以看到请求已经被成功拦截了。  
![在这里插入图片描述][20210117223751370.png]

到此该博客的任务已经完成,是不是配置起来很简单呢,感兴趣的小伙伴可以自己试试。

# 项目配套代码 #

[github地址][github]

创作不易,要是觉得我写的对你有点帮助的话,麻烦在github上帮我点下 **Star**

【SpringBoot框架篇】其它文章如下,后续会继续更新。

*  [1.搭建第一个springboot项目][1._springboot]
 *  [2.Thymeleaf模板引擎实战][2.Thymeleaf]
 *  [3.优化代码,让代码更简洁高效][3.]
 *  [4.集成jta-atomikos实现分布式事务][4._jta-atomikos]
 *  [5.分布式锁的实现方式][5.]
 *  [6.docker部署,并挂载配置文件到宿主机上面][6.docker]
 *  [7.项目发布到生产环境][7.]
 *  [8.搭建自己的spring-boot-starter][8._spring-boot-starter]
 *  [9.dubbo入门实战][9.dubbo]
 *  [10.API接口限流实战][10.API]
 *  [11.Spring Data Jpa实战][11.Spring Data Jpa]
 *  [12.使用druid的monitor工具查看sql执行性能][12._druid_monitor_sql]
 *  [13.使用springboot admin对springboot应用进行监控][13._springboot admin_springboot]
 *  [14.mybatis-plus实战][14.mybatis-plus]
 *  [15.使用shiro对web应用进行权限认证][15._shiro_web]
 *  [16.security整合jwt实现对前后端分离的项目进行权限认证][16.security_jwt]
 *  [17.使用swagger2生成RESTful风格的接口文档][17._swagger2_RESTful]
 *  [18.使用Netty加websocket实现在线聊天功能][18._Netty_websocket]
 *  [19.使用spring-session加redis来实现session共享][19._spring-session_redis_session]
 *  [20.自定义@Configuration配置类启用开关][20._Configuration]
 *  [21.对springboot框架编译后的jar文件瘦身][21._springboot_jar]
 *  [22.集成RocketMQ实现消息发布和订阅][22._RocketMQ]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21pbmcxOTk1MTIyNA_size_16_color_FFFFFF_t_70]: /images/20221119/05b8d491cd0e4ba680726a8b72582f86.png
[Nginx]: https://blog.csdn.net/ming19951224/article/details/110950886
[20210117222352300.png]: https://img-blog.csdnimg.cn/20210117222352300.png
[20210117222516354.png]: https://img-blog.csdnimg.cn/20210117222516354.png
[20210117222529306.png]: https://img-blog.csdnimg.cn/20210117222529306.png
[20210117223514270.png]: https://img-blog.csdnimg.cn/20210117223514270.png
[20210117223524711.png]: https://img-blog.csdnimg.cn/20210117223524711.png
[20210117223751370.png]: https://img-blog.csdnimg.cn/20210117223751370.png
[github]: https://github.com/Dominick-Li/springboot-master
[1._springboot]: https://blog.csdn.net/ming19951224/article/details/106159309
[2.Thymeleaf]: https://blog.csdn.net/ming19951224/article/details/106160322
[3.]: https://blog.csdn.net/ming19951224/article/details/106173840
[4._jta-atomikos]: https://blog.csdn.net/ming19951224/article/details/105753333
[5.]: https://blog.csdn.net/ming19951224/article/details/106205332
[6.docker]: https://blog.csdn.net/ming19951224/article/details/105923548
[7.]: https://blog.csdn.net/ming19951224/article/details/106212271
[8._spring-boot-starter]: https://blog.csdn.net/ming19951224/article/details/106224172
[9.dubbo]: https://blog.csdn.net/ming19951224/article/details/106225928
[10.API]: https://blog.csdn.net/ming19951224/article/details/106227451
[11.Spring Data Jpa]: https://blog.csdn.net/ming19951224/article/details/106308544
[12._druid_monitor_sql]: https://blog.csdn.net/ming19951224/article/details/106317893
[13._springboot admin_springboot]: https://blog.csdn.net/ming19951224/article/details/107138845
[14.mybatis-plus]: https://blog.csdn.net/ming19951224/article/details/107145780
[15._shiro_web]: https://blog.csdn.net/ming19951224/article/details/107192585
[16.security_jwt]: https://blog.csdn.net/ming19951224/article/details/107733689
[17._swagger2_RESTful]: https://blog.csdn.net/ming19951224/article/details/107741541
[18._Netty_websocket]: https://blog.csdn.net/ming19951224/article/details/108555917
[19._spring-session_redis_session]: https://blog.csdn.net/ming19951224/article/details/112758560
[20._Configuration]: https://blog.csdn.net/ming19951224/article/details/112759717
[21._springboot_jar]: https://dominick-li.blog.csdn.net/article/details/119024251
[22._RocketMQ]: https://dominick-li.blog.csdn.net/article/details/119523197