Spring Boot/Cloud 之SpringSession

一、 HttpSession 回顾

1. 什么是 HttpSession
   是 JavaWeb 服务端提供的用来建立与客户端会话状态的对象。

二、 Session 共享

1. 什么是 Session 共享
   是指在一个浏览器访问多个 Web 服务时，服务端的 Session 数据需要共享。

2. Session 共享应用场景

   •  List item单点登录
   •  Web 服务器集群等场景

3. Session 共享常见的解决方案

   Session 复制
   通过对应用服务器的配置开启服务器的 Session 复制功能，在集群中的几台服务器之间同步 Session 对象，使得每台服务器上都保存所有的 Session 信息，这样任何一台宕机都不会导致 Session 的数据丢失，服务器使用 Session 时，直接从本地获取。这种方式的缺点也比较明显。因为 Session 需要时时同步，并且同步过程是有应用服务器来完成，由此对服务器的性能损耗也比较大。

   Session 绑定
   利用 hash 算法，比如 nginx 的 ip_hash,使得同一个 Ip 的请求分发到同一台服务器上。 这种方式不符合对系统的高可用要求，因为一旦某台服务器宕机，那么该机器上的 Session 也就不复存在了，用户请求切换到其他机器后么有 Session，无法完成业务处理。

   利用 Cookie 记录 Session
   Session 记录在客户端，每次请求服务器的时候，将 Session 放在请求中发送给服务器， 服务器处理完请求后再将修改后的 Session 响应给客户端。这里的客户端就是 cookie。 利用 cookie 记录 Session 的也有缺点，比如受 cookie 大小的限制，能记录的信息有限， 安全性低，每次请求响应都需要传递 cookie，影响性能，如果用户关闭 cookie，访问就不正常。

   Session 服务器
   Session 服务器可以解决上面的所有的问题，利用独立部署的 Session 服务器统一管理 Session，服务器每次读写 Session 时，都访问 Session 服务器。 对于 Session 服务器，我们可以使用 Redis 或者 MongoDB 等内存数据库来保存 Session 中的数据，以此替换掉服务中的 HttpSession。达到 Session 共享的效果。

三、SpringSession的简介

Spring Session 是 Spring 的项目之一。Spring Session 提供了一套创建和管理 Servlet HttpSession 的方案，默认采用外置的 Redis 来存储 Session 数据，以此来解决 Session 共享的 问题。

四、 SpringSession 的使用

安装Redis单机版

点击查看单机版安装

共享简单数据

搭建案例环境

项目简单介绍,创建了一个父项目,两个聚合模块的子项目
父项目为pom项目
子项目为jar项目

1.创建父项目

创建项目 ,修改pom文件

注 :需要继承SpringBoot父项目的启动器,添加项目运行环境,相关的jar

<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>
  	<!-- SpringBoot父项目的启动器 -->
  	   <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.7.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
     </parent>
  <groupId>ah.szxy.springsession</groupId>
  <artifactId>01-SpringSession</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <packaging>pom</packaging>


 <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.session</groupId>
            <artifactId>spring-session-core</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <!--Spring session data redis-->
        <dependency>
            <groupId>org.springframework.session</groupId>
            <artifactId>spring-session-data-redis</artifactId>
            <!--<version>2.1.4.RELEASE</version>-->
        </dependency>
        <!--Lettuce是 一 个 基 于 Netty的 NIO方 式 处 理 Redis的 技 术 -->
        <dependency>
            <groupId>io.lettuce</groupId>
            <artifactId>lettuce-core</artifactId>
        </dependency>
    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

2.创建两个子项目

session_service1,session_service2

1、pom文件(二者除名称外相同)

<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>
  <parent>
    <groupId>ah.szxy.springsession</groupId>
    <artifactId>01-SpringSession</artifactId>
    <version>0.0.1-SNAPSHOT</version>
  </parent>
  <artifactId>session_service1</artifactId>


<properties>
	<java.version>1.8</java.version>
	<maven-jar-plugin.version>3.1.1</maven-jar-plugin.version>
</properties>
</project>

注意 :在添加properties内的代码后,即可解决pom文件第一行报异常的问题

2、全局配置文件(除应用名, 端口号外相同)

spring:
  application:
    name: Spring-Session-Servlet1
  redis:
    #redis单机配置
    host: 192.168.179.131
    port: 6379
    # 选择redis的数据库的分库
    database: 5
    #redis连接池配置
    jedis:
      pool:
        max-idle: 10
        min-idle: 5
        max-active: 100
        max-wait: 3000
        timeout: 6005
        
server:
  port: 8081
  

3、启动类(相同)

package ah.szxy;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.session.data.redis.config.annotation.web.http.EnableRedisHttpSession;

/**
 * @EnableRedisHttpSession开启redis对SpringSession的支持
 * @author chy
 *
 */
@SpringBootApplication
@EnableRedisHttpSession
public class SpringSessionApp {
	public static void main(String[] args) {
		SpringApplication.run(SpringSessionApp.class, args);
	}
}

4、session_service1 :Controller

@RestController
@RequestMapping("service1")
public class WebController {
	
	@RequestMapping("setMsg")
	public String  getMsg(HttpSession session) {
		
		session.setAttribute("msg", "Hello SpringSession!");
		return "ok";
	}
}

5、session_service2 :Controller

@RestController
@RequestMapping("service2")
public class WebController {
	
	@RequestMapping("getMsg")
	public String  getMsg(HttpSession session) {
		
		String msg=(String) session.getAttribute("msg");
		return msg;
	}
}

3.测试结果
访问session_service1的controller查看结果

查看redis数据库是否存放了session数据

默认的保存的时间约为2100s

访问session_service2 的controller查看结果

共享自定义对象

在上面的案例中进行修改

1.两个子模块都添加实体类

因为涉及对象类型数据传输到redis,故需要实现序列化接口

package ah.szxy.domain;

import java.io.Serializable;

public class Users implements Serializable{
	
	private String username;
	private String userpwd;
	public String getUsername() {
		return username;
	}
	public void setUsername(String username) {
		this.username = username;
	}
	public String getUserpwd() {
		return userpwd;
	}
	public void setUserpwd(String userpwd) {
		this.userpwd = userpwd;
	}
	@Override
	public String toString() {
		return "Users [username=" + username + ", userpwd=" + userpwd + "]";
	}
	public Users() {
		super();
	}
	public Users(String username, String userpwd) {
		super();
		this.username = username;
		this.userpwd = userpwd;
	}
	
	
}

2.子模块1的controller

@RequestMapping("addUser")
	public String addUser(HttpSession session,Users user) {
		
		session.setAttribute("user", user);
		return "addUser Success!!!";
	}

3.测试结果

访问session_service1的controller查看结果
查看redis数据库是否存放了session数据
访问session_service2 的controller查看结果

SpringSession 的 Redis 存储结构

spring:session:expirations:(Set 结构)

用户 ttl 过期时间记录 , 这个 key中的值是一个时间戳，
根据这个 Session 过期时刻滚动至下一分钟而计算得出。
这个 key 的过期时间为 Session 的最大过期时间 +5 分钟(再此为2100s)。

spring:session:sessions:(Hash 结构)
maxInactiveInterval：过期时间间隔
creationTime：创建时间
lastAccessedTime：最后访问时间
sessionAttr：Attributes 中的数据存储 Session 的详细信息，包括 Session 的过期时间间隔、最后的访问时间、attributes 的值。这个 key 的过期时间为 Session 的最大过期时间 +5 分钟。

spring:session:sessions:expires:(String 结构)

过期时间记录 : 这个 k-v 不存储任何有用数据，只是表示 Session 过期而设置。
这个 key 在 Redis 中的过期时间即为 Session 的过期时间间隔

设置session的失效时间

修改启动类的@EnableRedisHttpSession注解

@SpringBootApplication
/**
 * 设置超时时限
 * 需要两端同步,单位秒
 */
@EnableRedisHttpSession(maxInactiveIntervalInSeconds=20)
@SpringBootApplication
public class SessionServlet1Application {
    public static void main(String[] args) {
        SpringApplication.run(SessionServlet1Application.class, args);
    }
}

@EnableRedisHttpSession注解中相关属性讲解

点击注解即可进入相应的注解接口 ,可以看到其中有四个属性

属性	作用
maxInactiveIntervalInSeconds	设置 Session 的失效时间，单位为秒。默认(1800 秒)30 分钟。
redisNamespace	为键定义唯一的命名空间。该值用于通过更改前缀与默认 spring:session 隔离会话
redisFlushMode	Redis 会话的刷新模式。默认值为“保存”
cleanupCron	过期会话清理作业的 cron 表达式。默认值(“0 *****”)每分钟运行一次。

更换 SpringSession 的序列化器

SpringSession 中默认的序列化器为 jdk 序列化器，该序列化器效率低下，内存再用大。
我们可以根据自己的需要更换其他序列化器，如 GenericJackson2JsonRedisSerializer 序列化器。
使用配置类跟换序列器

/**
 * 1.需要两端都添加这个配置类
 * 2.同时允许关联对象的添加
 *
 */
@Configuration
public class SpringSessionConfig {
	
	/**
     * 更换序列化器
     * @return
     */
    @Bean("springSessionDefaultRedisSerializer")
    public RedisSerializer setSerializer(){
        return new GenericJackson2JsonRedisSerializer();
    }
    
}

注意 :
1.如果在项目中使用序列化器,建议使用这里推荐的序列化器序列化器的配置类
2.将原来的数据清空
3.不要额外导入jar, 上面添加的坐标包含的jar足够

配置前

配置后