spring session通过redis存储，实现session共享

迈不过友情╰ 2022-05-15 00:05 514阅读 0赞

**目录**

前言

1 准备工作

1.1 spring框架的jar包

1.2 spring session的相关jar包

2 具体步骤

2.1 创建项目

2.2 spring mvc的配置

2.3 spring session的配置

2.4 web.xml的配置

3 测试

3.1 创建jsp测试文件

3.2 开始测试

--------------------

# 前言 #

web开发中session一直都是做分布式集群应用时需要解决的一个难题，前面写了tomcat服务器集群的文章，那么集群中怎么实现session共享呢？

让我们回顾一下，[Tomcat集群搭建(APACHE+MOD\_JK+TOMCAT配置)][Tomcat_APACHE_MOD_JK_TOMCAT]的session共享是直接通过tomcat自带的复制功能，即访问其中一台tomcat服务器就会在其他配置好的tomcat服务器上各复制一份session，这样的session共享可能会存在一定的延迟，同时若并发量一大的话也会有网络风暴的风险；而[Tomcat集群搭建(nginx+tomcat+redis)][Tomcat_nginx_tomcat_redis]的session共享是通过第三方redis来存储session来实现的，这种方式以前比较流行，但是这种也是需要依赖于tomcat（需要修改tomcat的context.xml的配置），而且现在官方也没去更新tomcat-redis-session-manager的jar包了（仍然停留在支持tomcat7上，一些自己修改的jar包除外）。

本文我要说的session共享，就是独立于servlet容器、session存储在第三方存储容器redis的spring session。它不用担心并发量大时的网络风暴；不用担心换容器运行时，又需要各种各样的配置；不用担心servlet容器（即这里的tomcat）停止服务了，session就不存在了，用户又得重新登陆的麻烦。因为spring session的实现是在项目的配置，以及代码中的。

在开始之前，让我们先了解一下spring session实现session共享，以及在spring框架中实现的原理。

spring session通过redis来实现多个服务器间的session共享的原理，其实就是将session独立出来不依赖原来的web容器，而是存放到与web容器没有耦合关系的redis容器中，这样即使是任何一台web容器挂了，也不会影响到其中的session，如下图所示：

![70][]

spring session在spring框架中的实现原理，其实就是在请求request上通过DelegatingFilterProxy代理过滤器封装了一层，将原来存储在容器缓存的session变成存储在redis的session，所以在web.xml中的此filter必须得是在所有filter的前面。具体的web容器加载过程，如下图所示：

![70 1][]

# 1 准备工作 #

这里的准备工作有几点，redis存储容器、spring框架的jar包（需要在spring框架的环境下）和spring session的相关jar包。其中redis存储容器，我就不多说了，网上有很多redis的安装教程，或者参考此处[redis的安装][redis]。

## 1.1 spring框架的jar包 ##

若你的项目原本就有spring框架的，忽略此准备工作。

注意：这里用的spring都是比较高版本的，最好用本文的相应版本，否则会出现一些版本不合的奇葩错误

commons-logging选择1.2版本：[http://commons.apache.org/proper/commons-logging/download\_logging.cgi][http_commons.apache.org_proper_commons-logging_download_logging.cgi]

spring-aop选择5.0.8版本：[http://www.mvnrepository.com/artifact/org.springframework/spring-aop][http_www.mvnrepository.com_artifact_org.springframework_spring-aop]

spring-beans选择5.0.8版本：[http://mvnrepository.com/artifact/org.springframework/spring-beans][http_mvnrepository.com_artifact_org.springframework_spring-beans]

spring-context选择5.0.8版本：[http://mvnrepository.com/artifact/org.springframework/spring-context][http_mvnrepository.com_artifact_org.springframework_spring-context]

spring-core选择5.0.8版本：[http://mvnrepository.com/artifact/org.springframework/spring-core][http_mvnrepository.com_artifact_org.springframework_spring-core]

spring-expression选择5.0.8版本：[http://mvnrepository.com/artifact/org.springframework/spring-expression][http_mvnrepository.com_artifact_org.springframework_spring-expression]

spring-web选择5.0.8版本：[http://mvnrepository.com/artifact/org.springframework/spring-web][http_mvnrepository.com_artifact_org.springframework_spring-web]

spring-webmvc选择5.0.8版本：[http://www.mvnrepository.com/artifact/org.springframework/spring-webmvc][http_www.mvnrepository.com_artifact_org.springframework_spring-webmvc]

spring-tx选择5.0.8版本：[http://mvnrepository.com/artifact/org.springframework/spring-tx][http_mvnrepository.com_artifact_org.springframework_spring-tx]

## 1.2 spring session的相关jar包 ##

注意：这里用的spring session都是比较高版本的，最好用本文的相应版本，否则会出现一些版本不合的奇葩错误

commons-pool2选择2.6.0版本：[http://commons.apache.org/proper/commons-pool/download\_pool.cgi][http_commons.apache.org_proper_commons-pool_download_pool.cgi]

jedis选择2.9.0版本：[http://central.maven.org/maven2/redis/clients/jedis/][http_central.maven.org_maven2_redis_clients_jedis]

spring-data-commons选择2.0.9版本：[https://repo.spring.io/libs-release/org/springframework/data/spring-data-commons/][https_repo.spring.io_libs-release_org_springframework_data_spring-data-commons]

spring-data-redis选择2.0.9版本：[https://repo.spring.io/libs-release/org/springframework/data/spring-data-redis/][https_repo.spring.io_libs-release_org_springframework_data_spring-data-redis]

spring-session-core选择2.0.5版本：[http://mvnrepository.com/artifact/org.springframework.session/spring-session-core][http_mvnrepository.com_artifact_org.springframework.session_spring-session-core]

spring-session-data-redis选择2.0.5版本：[https://repo.spring.io/libs-release/org/springframework/session/spring-session-data-redis/][https_repo.spring.io_libs-release_org_springframework_session_spring-session-data-redis]

# 2 具体步骤 #

## 2.1 创建项目 ##

（1）在eclipse中创建一个web项目，命名为SpringSession。

（2）将上面下载的jar包全放到项目中WEB-INF/lib目录下。

## 2.2 spring mvc的配置 ##

（1）在源码的src目录下创建config放置配置文件的包，以及创建com.sky.springsession放置java源码的包。

（2）在config包下创建applicationContext.xml文件，放置如下代码

这是spring mvc的最基本的配置，当然这些配置在这里其实也是可以免去的。

## 2.3 spring session的配置 ##

在config包下创建spring-session.xml文件，放置如下代码

> <?xml version="1.0" encoding="UTF-8"?>  
> <beans  
>     xmlns="http://www.springframework.org/schema/beans"  
>     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
>     xmlns:p="http://www.springframework.org/schema/p"  
>     xmlns:tx="http://www.springframework.org/schema/tx"  
>     xsi:schemaLocation="http://www.springframework.org/schema/beans   
>         http://www.springframework.org/schema/beans/spring-beans.xsd">  
>       
>     <bean id="jedisPoolConfig" class="redis.clients.jedis.JedisPoolConfig">  
>         <property name="maxIdle" value="10"/>  
>         <property name="maxTotal" value="20"/>  
>         <property name="blockWhenExhausted" value="true"/>  
>         <property name="maxWaitMillis" value="1000"/>  
>         <property name="testOnBorrow" value="true"/>  
>     </bean>  
>       
>       
>     <bean id="connectionFactory" class="org.springframework.data.redis.connection.jedis.JedisConnectionFactory"   
>         p:host-name="192.168.17.132" p:port="6379" p:password="123456" p:usePool="true" p:pool-config-ref="jedisPoolConfig">  
>     </bean>  
>       
>       
>     <bean class="org.springframework.session.data.redis.config.annotation.web.http.RedisHttpSessionConfiguration">  
>           
>         <property name="maxInactiveIntervalInSeconds" value="30"></property>  
>     </bean>  
> </beans>

注意，用了spring session后，在web.xml设置的session过期时间是无效。因为此session已经不是原来的存储在容器缓存内的session了，而是被封装多了一层后存储在redis的session。

## 2.4 web.xml的配置 ##

在web.xml文件添加如下代码

>   <context-param>  
>     <param-name>contextConfigLocation</param-name>  
>     <param-value>classpath:config/\*.xml</param-value>  
>   </context-param>  
>     
>   <listener>  
>     <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>  
>   </listener>  
>   
> 
>     
>   <filter>  
>     <filter-name>springSessionRepositoryFilter</filter-name>  
>     <filter-class>org.springframework.web.filter.DelegatingFilterProxy</filter-class>  
>   </filter>  
>   <filter-mapping>  
>     <filter-name>springSessionRepositoryFilter</filter-name>  
>     <url-pattern>/\*</url-pattern>  
>   </filter-mapping>  
>     
>     
>   <servlet>  
>     <servlet-name>springmvc</servlet-name>  
>     <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>  
>       
>     <init-param>  
>         <param-name>contextConfigLocation</param-name>  
>         <param-value>classpath:config/applicationContext.xml</param-value>  
>     </init-param>  
>     <load-on-startup>1</load-on-startup>  
>   </servlet>  
>   <servlet-mapping>  
>     <servlet-name>springmvc</servlet-name>  
>     <url-pattern>/</url-pattern>  
>   </servlet-mapping>

配置至此，就能够实现spring session通过存储到redis的session共享了。

# 3 测试 #

## 3.1 创建jsp测试文件 ##

（1）在WebContent目录下创建index.jsp，放置如下代码

> <%@ page language="java" contentType="text/html; charset=UTF-8"  
>     pageEncoding="UTF-8"%>  
> <%@ page import="java.util.Date" %>  
> <!DOCTYPE html>  
> <html>  
> <head>  
> <meta charset="UTF-8">  
> <title>spring session</title>  
> </head>  
> <body>  
> <%  
> System.out.println(new Date()+"=============tomcat1=================");  
> session.setAttribute("tomcat1", "I am tomcat1");  
> %>
> 
> <h1>hello world!</h1><br>  
> <p><%=session.getId()%>======<%=new Date()%></p>  
> <p>tomcat1======<%=session.getAttribute("tomcat1")%></p>  
> <p>tomcat2======<%=session.getAttribute("tomcat2")%></p>  
> </body>  
> </html>

（2）在WebContent目录下创建result.jsp，放置如下代码

> <%@ page language="java" contentType="text/html; charset=UTF-8"  
>     pageEncoding="UTF-8"%>  
> <%@ page import="java.util.Date" %>  
> <!DOCTYPE html>  
> <html>  
> <head>  
> <meta charset="UTF-8">  
> <title>spring session</title>  
> </head>  
> <body>  
> <h1>result tomcat1</h1><br>  
> <p><%=session.getId()%>======<%=new Date()%></p>  
> <p>tomcat1======<%=session.getAttribute("tomcat1")%></p>  
> <p>tomcat2======<%=session.getAttribute("tomcat2")%></p>  
> </body>  
> </html>

## 3.2 开始测试 ##

（1）打开浏览器，输入url：[http://localhost:8080/SpringSession/][http_localhost_8080_SpringSession]

![70 2][]

（2）打开第二个标签页

![70 3][]

（3）待30秒过后，刷新第二个标签页，发现tomcat1已经为null，说明上面的spring session的过期时间设置是有效的。

![70 4][]

（4）当然想要看下spring session是否真的存在了redis，也可以到redis客户端上查看。

![70 5][]

[Tomcat_APACHE_MOD_JK_TOMCAT]: https://blog.csdn.net/qq_15092079/article/details/81479606
[Tomcat_nginx_tomcat_redis]: https://blog.csdn.net/qq_15092079/article/details/81539889
[70]: /images/20220515/71946a2b774649e8a1e82d1123840cb6.png
[70 1]: /images/20220515/18994eed777f4963a289b4686e605116.png
[redis]: https://blog.csdn.net/qq_15092079/article/details/81539889#2.3%20redis%E5%AE%89%E8%A3%85
[http_commons.apache.org_proper_commons-logging_download_logging.cgi]: http://commons.apache.org/proper/commons-logging/download_logging.cgi
[http_www.mvnrepository.com_artifact_org.springframework_spring-aop]: http://www.mvnrepository.com/artifact/org.springframework/spring-aop
[http_mvnrepository.com_artifact_org.springframework_spring-beans]: http://mvnrepository.com/artifact/org.springframework/spring-beans
[http_mvnrepository.com_artifact_org.springframework_spring-context]: http://mvnrepository.com/artifact/org.springframework/spring-context
[http_mvnrepository.com_artifact_org.springframework_spring-core]: http://mvnrepository.com/artifact/org.springframework/spring-core
[http_mvnrepository.com_artifact_org.springframework_spring-expression]: http://mvnrepository.com/artifact/org.springframework/spring-expression
[http_mvnrepository.com_artifact_org.springframework_spring-web]: http://mvnrepository.com/artifact/org.springframework/spring-web
[http_www.mvnrepository.com_artifact_org.springframework_spring-webmvc]: http://www.mvnrepository.com/artifact/org.springframework/spring-webmvc
[http_mvnrepository.com_artifact_org.springframework_spring-tx]: http://mvnrepository.com/artifact/org.springframework/spring-tx
[http_commons.apache.org_proper_commons-pool_download_pool.cgi]: http://commons.apache.org/proper/commons-pool/download_pool.cgi
[http_central.maven.org_maven2_redis_clients_jedis]: http://central.maven.org/maven2/redis/clients/jedis/
[https_repo.spring.io_libs-release_org_springframework_data_spring-data-commons]: https://repo.spring.io/libs-release/org/springframework/data/spring-data-commons/
[https_repo.spring.io_libs-release_org_springframework_data_spring-data-redis]: https://repo.spring.io/libs-release/org/springframework/data/spring-data-redis/
[http_mvnrepository.com_artifact_org.springframework.session_spring-session-core]: http://mvnrepository.com/artifact/org.springframework.session/spring-session-core
[https_repo.spring.io_libs-release_org_springframework_session_spring-session-data-redis]: https://repo.spring.io/libs-release/org/springframework/session/spring-session-data-redis/
[http_localhost_8080_SpringSession]: http://localhost:8080/SpringSession/
[70 2]: /images/20220515/4f05ecad53a54dfd958346f3cbcb5a1b.png
[70 3]: /images/20220515/72cf45ce70af4c48be0a8c6be628e193.png
[70 4]: /images/20220515/b238749cab8842b0b6268cab0c7a7e1e.png
[70 5]: /images/20220515/03491d7b728e4a3fb1fe9cbfcb62eb2b.png