Spring - Spring Session Redis 共享

前言

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

让我们回顾一下，Tomcat集群搭建(APACHE+MOD_JK+TOMCAT配置)的session共享是直接通过tomcat自带的复制功能，即访问其中一台tomcat服务器就会在其他配置好的tomcat服务器上各复制一份session，这样的session共享可能会存在一定的延迟，同时若并发量一大的话也会有网络风暴的风险；而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，如下图所示：

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

准备工作

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

spring框架的jar包

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

commons-logging选择1.2版本：http://commons.apache.org/proper/commons-logging/download_logging.cgi

spring-aop选择5.0.8版本：http://www.mvnrepository.com/artifact/org.springframework/spring-aop

spring-beans选择5.0.8版本：http://mvnrepository.com/artifact/org.springframework/spring-beans

spring-context选择5.0.8版本：http://mvnrepository.com/artifact/org.springframework/spring-context

spring-core选择5.0.8版本：http://mvnrepository.com/artifact/org.springframework/spring-core

spring-expression选择5.0.8版本：http://mvnrepository.com/artifact/org.springframework/spring-expression

spring-web选择5.0.8版本：http://mvnrepository.com/artifact/org.springframework/spring-web

spring-webmvc选择5.0.8版本：http://www.mvnrepository.com/artifact/org.springframework/spring-webmvc

spring-tx选择5.0.8版本：http://mvnrepository.com/artifact/org.springframework/spring-tx

spring session的相关jar包

commons-pool2选择2.6.0版本：http://commons.apache.org/proper/commons-pool/download_pool.cgi

jedis选择2.9.0版本：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/

spring-data-redis选择2.0.9版本：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

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

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

具体步骤

创建项目

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

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

spring mvc的配置

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

（2）在config包下创建applicationContext.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:aop="http://www.springframework.org/schema/aop"
    xmlns:tx="http://www.springframework.org/schema/tx"
    xmlns:context="http://www.springframework.org/schema/context"    
    xsi:schemaLocation="http://www.springframework.org/schema/beans 
        http://www.springframework.org/schema/beans/spring-beans.xsd 
        http://www.springframework.org/schema/aop 
        http://www.springframework.org/schema/aop/spring-aop.xsd 
        http://www.springframework.org/schema/tx 
        http://www.springframework.org/schema/tx/spring-tx.xsd 
        http://www.springframework.org/schema/context
        http://www.springframework.org/schema/context/spring-context.xsd">

    <context:component-scan base-package="com.sky.springsession"/>
    
    <context:annotation-config/>

</beans>

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"/><!-- 最大空闲连接数, 默认8个 -->
        <property name="maxTotal" value="20"/><!-- 最大连接数, 默认8个 -->
        <property name="blockWhenExhausted" value="true"/><!-- 连接耗尽时是否阻塞, false报异常,ture阻塞直到超时, 默认true -->
        <property name="maxWaitMillis" value="1000"/><!-- 获取连接时的最大等待毫秒数(如果设置为阻塞时BlockWhenExhausted),如果超时就抛异常, 小于零:阻塞不确定的时间,  默认-1 -->
        <property name="testOnBorrow" value="true"/><!-- 在获取连接的时候检查有效性, 默认false -->
    </bean>
    
    <!-- redis连接配置，依次为主机ip，端口，密码，是否使用池，连接池配置引用 -->
    <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>
    
    <!-- 配置spring-session -->
    <bean class="org.springframework.session.data.redis.config.annotation.web.http.RedisHttpSessionConfiguration">
        <!-- session过期时间,单位是秒 -->
        <property name="maxInactiveIntervalInSeconds" value="30"></property>
    </bean>
</beans>

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

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>
  

  <!-- spring session的过滤器配置，注意此过滤器必须放在其他过滤器之前 -->
  <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>
  
  <!-- springmvc配置 -->
  <servlet>
    <servlet-name>springmvc</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <!-- 通过初始化参数，指定xml文件的位置 -->
    <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>

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

创建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>