Spring Session简介

Spring-Session介绍

Spring-Session使用的场景？

HttpSession是通过Servlet容器进行创建和管理的，在单机环境中。通过Http请求创建的Session信息是存储在Web服务器内存中，如Tomcat/Jetty。

假如当用户通过浏览器访问应用服务器，session信息中保存了用户的登录信息，并且session信息没有过期失，效那么用户就一直处于登录状态，可以做一些登录状态的业务操作！

但是现在很多的服务器都采用分布式集群的方式进行部署，一个Web应用，可能部署在几台不同的服务器上，通过LVS或者Nginx等进行负载均衡（一般使用Nginx+Tomcat实现负载均衡）。此时来自同一用户的Http请求将有可能被分发到不同的web站点中去（如：第一次分配到A站点，第二次可能分配到B站点）。那么问题就来了，如何保证不同的web站点能够共享同一份session数据呢？

假如用户在发起第一次请求时候访问了A站点，并在A站点的session中保存了登录信息，当用户第二次发起请求，通过负载均衡请求分配到B站点了，那么此时B站点能否获取用户保存的登录的信息呢？答案是不能的，因为上面说明，Session是存储在对应Web服务器的内存的，不能进行共享，此时Spring-session就出现了，来帮我们解决这个session共享的问题！

如何进行Session共享呢？

简单点说就是请求http请求经过Filter职责链，根据配置信息过滤器将创建session的权利由tomcat交给了Spring-session中的SessionRepository，通过Spring-session创建会话，并保存到对应的地方。

实际上实现Session共享的方案很多，其中一种常用的就是使用Tomcat、Jetty等服务器提供的Session共享功能，将Session的内容统一存储在一个数据库（如MySQL）或缓存（如Redis，Mongo）中，

而上面说的使用Nginx也可以，使用ip_hash策略。

【Nginx】实现负载均衡的几种方式

在使用Nginx的ip_hash策略时候，每个请求按访问ip的hash结果分配，这样每个访客固定访问一个后端服务器，也可以解决session的问题。

Spring官方介绍

Why Spring Session & HttpSession?

Spring会话提供了与HttpSession的透明集成,允许以应用程序容器（即Tomcat）中性的方式替换HttpSession，但是我们从中得到了什么好处呢?

集群会话——Spring会话使支持集群会话变得微不足道，而不需要绑定到应用程序容器的特定解决方案。
多个浏览器会话——Spring会话支持在单个浏览器实例中管理多个用户会话(也就是多个经过验证的帐户，类似于谷歌)。
RESTful api——Spring会话允许在header中提供会话id以使用RESTful api。
Spring Session & WebSockets的完美集成。

项目搭建

整个项目的整体骨架：

基于XML配置方式的Spring Session

本次只讲解xml配置方式，javaConfig配置可以参考官方文档：Spring Java Configuration

环境说明

本次项目需要用户Nginx和Redis，如果没有配置Nginx的请看这里： linux上Nginx的安装教程详解

没有配置Redis的请看这里：linux环境安装Redis

配置好了上面的环境，后下面开始正式的Spring-session搭建过程了！

创建项目：

1.添加项目依赖

首先新建一个Maven的Web项目，新建好之后在pom文件中添加下面的依赖：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>org.spring</groupId>
    <artifactId>learn-spring-session</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>war</packaging>
    <name>First Learn Spring Session</name>

    <properties>
      <jdk.version>1.8</jdk.version>
      <spring.version>4.3.4.RELEASE</spring.version>
      <spring-session.version>1.3.1.RELEASE</spring-session.version>
    </properties>

    <dependencies>
        <!-- https://mvnrepository.com/artifact/javax.servlet/servlet-api  -->
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>javax.servlet-api</artifactId>
            <version>3.0.1</version>
            <scope>provided</scope>
        </dependency>

        <dependency>
            <groupId>org.springframework.session</groupId>
            <artifactId>spring-session-data-redis</artifactId>
            <version>${spring-session.version}</version>
            <type>pom</type>
        </dependency>
        
       <dependency>
            <groupId>biz.paluch.redis</groupId>
            <artifactId>lettuce</artifactId>
            <version>3.5.0.Final</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-web</artifactId>
            <version>${spring.version}</version>
        </dependency>
    </dependencies>   

</project>

2.web.xml配置

<?xml version="1.0" encoding="UTF-8"?>
<web-app version="2.4" xmlns="http://java.sun.com/xml/ns/j2ee"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd">
	<display-name>springsession</display-name>
	<context-param>
		<param-name>contextConfigLocation</param-name>
		<param-value>classpath*:spring/application-session.xml</param-value>
	</context-param>

	<listener>
		<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
	</listener>

	<servlet>
		<servlet-name>SpringDispatcher</servlet-name>
		<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
		<init-param>
			<param-name>contextClass</param-name>
			<param-value>
				org.springframework.web.context.support.AnnotationConfigWebApplicationContext
			</param-value>
		</init-param>
		<init-param>
			<param-name>contextConfigLocation</param-name>
			<param-value>com.it</param-value>
		</init-param>
		<load-on-startup>1</load-on-startup>
	</servlet>
	<servlet-mapping>
		<servlet-name>SpringDispatcher</servlet-name>
		<url-pattern>/</url-pattern>
	</servlet-mapping>

	<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>
		<dispatcher>REQUEST</dispatcher>
		<dispatcher>ERROR</dispatcher>
	</filter-mapping>
	<session-config>
		<session-timeout>30</session-timeout>
	</session-config>
</web-app>

DelegatingFilterProxy将通过springSessionRepositoryFilter的名称查找Bean并将其转换为过滤器。对于调用DelegatingFilterProxy的每个请求，也将调用springSessionRepositoryFilter。

3.Xml的配置

添加了必要的依赖之后，我们需要创建相应的Spring配置。Spring配置是要创建一个Servlet过滤器，它用Spring Session支持的HttpSession实现来替换容器本身HttpSession实现。这一步也是Spring Session的核心。在resources 下面新建一个xml，名词为 application-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:context="http://www.springframework.org/schema/context"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
           http://www.springframework.org/schema/beans/spring-beans-4.3.xsd
           http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.3.xsd">

    <context:annotation-config/>
    
    <bean class="org.springframework.session.data.redis.config.annotation.web.http.RedisHttpSessionConfiguration"/>
   
    <bean class="org.springframework.data.redis.connection.lettuce.LettuceConnectionFactory"/>

</beans>

上述代码注释：

LettuceConnectionFactory实例是配置Redis的ConnectionFactory，查看源代码可以看到，默认的Redis链接配置为：

因此，如果有自己的Redis配置，请修改，例如下边的配置：

<bean class="org.springframework.data.redis.connection.lettuce.LettuceConnectionFactory"> 
<property name="hostName" value="192.168.1.149"/> 
<property name="port" value="6379"/> 
<property name="password" value="123456"/>
</bean>

4、springmvc配置文件

package com.it.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.ViewResolver;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
import org.springframework.web.servlet.view.InternalResourceViewResolver;

@Configuration
@ComponentScan(basePackages="com.it")
@EnableWebMvc
public class MvcConfiguration extends WebMvcConfigurerAdapter{

	@Bean
	public ViewResolver getViewResolver(){
		InternalResourceViewResolver resolver = new InternalResourceViewResolver();
		resolver.setPrefix("/WEB-INF/views/");
		resolver.setSuffix(".jsp");
		return resolver;
	}
	
	@Override
	public void addResourceHandlers(ResourceHandlerRegistry registry) {
		registry.addResourceHandler("/resources/**").addResourceLocations("/resources/");
	}

	
}

5.测试代码

新建 SpringSessionController.java

@Controller
@RequestMapping(value = "/spring/session")
public class SpringSessionController {

    @RequestMapping(value = "/")
    public ModelAndView test(HttpServletResponse response) throws IOException {
        return new ModelAndView("home");
    }

    @RequestMapping(value = "/setSession.do", method = RequestMethod.GET)
    public void setSession(HttpServletRequest request, HttpServletResponse response) {
        String name = request.getParameter("name");
        String value = request.getParameter("value");
        request.getSession().setAttribute(name, value);
    }

    @RequestMapping(value = "/getSession.do", method = RequestMethod.GET)
    public void getInterestPro(HttpServletRequest request, HttpServletResponse response) {
        String name = request.getParameter("name");
        System.out.println("------" + request.getSession().getAttribute(name));
    }

    @RequestMapping(value = "/removeSession.do", method = RequestMethod.GET)
    public void removeSession(HttpServletRequest request, HttpServletResponse response) {
        String name = request.getParameter("name");
        request.getSession().removeAttribute(name);
    }

}

效果演示

1.启动Redis，默认端口6379就行！

2.配置Nginx，启动Nginx

Nginx的配置，权重方式（或轮询）：

#user  nobody;
worker_processes  1;

events {
    worker_connections  1024;
}

http {
    include       mime.types;
    default_type  application/octet-stream;

    sendfile        on;
    
    keepalive_timeout  65;

    #gzip  on;
     upstream local_tomcat {
     server localhost:8080 weight=1;
     server localhost:8090 weight=1;  
    }
    server {
        listen       80;
        server_name  localhost:8080;

        location / {
           proxy_pass http://local_tomcat;
          
        }

3.启动Tomcat1和Tomcat2

将上面搭建好的项目放入两个Tomcat中，分别启动。

http://192.168.0.147:8090/springsession/spring/session/getSession

http://192.168.0.147:8080/springsession/spring/session/getSession

保证两个tomcat能正常访问

4、使用Nginx负载均衡均验证Session是否共享成功,

直接访问Nginx路径：http://192.168.0.147/springsession/spring/session/getSession，

刷新页面，变成8090服务器，值可以取到，sessionid值不变

如何在Redis中查看Session数据,可以使用命令，或者在Windows的RedisDesktopManager中查看！

key的简单介绍说明：


# 存储 Session 数据,数据类型hash
Key：spring:session:sessions:XXXXXXX

# Redis TTL触发Session 过期。(Redis 本身功能)，数据类型：String
Key：spring:session:sessions:expires:XXXXX

#执行 TTL key ，查看剩余生存时间


#定时Job程序触发Session 过期。(spring-session 功能)，数据类型：Set
Key：spring:session:expirations:XXXXX

验证成功！