Redis 处理Spring Boot项目Session 共享问题

背景

Web 开发中，通过 Session 在服务端记录用户状态是很常见的操作。但是 Session 的机制对于单机应用是没问题的，但是对于集群环境，由于在将请求分配到另一台服务器时，新的服务器无法通过浏览器传入的 Cookie 值取到 Session，所以导致所有基于 Session 的操作都会失败，如：登录状态。
　　本文通过搭建一个非常简易的集群环境，来演示 Session 机制在集群环境中存在的问题，并通过 Redis 进行 Session 共享来解决该问题。

一、问题再现

1、测试环境

（1）App Server
使用 Spring Boot 写一个简单的 Web 应用，提供两个链接：

链接	功能
/set-session?sessionVal=21111	在session中指定sessionVal的值
/get-session	获取session中sessionVal的值

@RestController
public class TestController {

    @GetMapping("/set-session")
    public Object writeSession(String sessionVal, HttpSession httpSession) {
        System.out.println("Param 'sessionVal' = " + sessionVal);
        httpSession.setAttribute("sessionVal", sessionVal);
        return sessionVal;
    }

    @GetMapping("/get-session")
    public Object readSession(HttpSession httpSession) {
        Object obj = httpSession.getAttribute("sessionVal");
        System.out.println("'sessionVal' in Session = " + obj);
        return obj;
    }
}

单机测试通过。

idea中编辑启动项允许启动多个server

启动第一个之后，修改server.port=8081 然后启动第二个

验证session隔离

（2）通过 Nginx 做负载均衡
分别在 8080 和 8081 两个端口启动 App Server，然后通过 Nginx 配置负载均衡，配置如下：

worker_processes  1;
events {
    worker_connections  1024;
}


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

    keepalive_timeout  65;

	upstream  appserver {
       server    127.0.0.1:8080;
       server    127.0.0.1:8081;
	}

    server {
        listen       9090;
        server_name  localhost;

        location / {
            proxy_pass http://appserver;
        }
    }
}

注意： Tomcat8接受nginx upstream后面的名称不能包含下划线，否则会出现

java.lang.IllegalArgumentException: The character [_] is never valid in a do

设置sessionVal
http://localhost:9090/set-session?sessionVal=123

二、原因分析

主要是因为原来 A 服务器将其 Session 的标识 Cookie_for_Session_A 放入浏览器 Cookie，当下一次请求被分配到 B 服务器，B 服务器无法通过 Cookie_for_Session_A 获取到对应的 Session，导致失败。

解决的思路，主要是引入三方服务器，将 Session 保存到三方服务器，A、B 服务器共享三方服务器中的 Session 数据。

三、解决方案

引入 Redis 作为三方服务器存储 Session 数据。

1、引入 Redis 相关库

添加下面maven依赖

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

2、配置 Redis 连接

Centos7 安装Redis
测试连接

application.yml，这里为了演示清晰，只做了最简配置，正式使用请调整相关参数

spring:
redis:
host: 192.168.2.200
port: 6379

3、开启配置

创建一个配置类 SessionConfig，类名随意。

关键是两个注解

@Configuration
@EnableRedisHttpSession(maxInactiveIntervalInSeconds = 86400*30)

验证

另外一个服务获取session

redis中文件内容

代码地址