2. Spring Session 环境搭建

亦凉 2022-02-18 16:49 149阅读 0赞

Spring session 基于springboot 环境, 官方给的demo 也都是基于springboot, 因此笔者也创建一个springboot 项目来学习. 对于session的存储方式笔者选择redis.

## 1. 搭建项目 ##

### 1.1 引入依赖 ###

<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.session</groupId>
            <artifactId>spring-session-data-redis</artifactId>
        </dependency>
    
        
        <dependency>
            <groupId>io.lettuce</groupId>
            <artifactId>lettuce-core</artifactId>
        </dependency>
    
        
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
        </dependency>
    
    </dependencies>

### 1.2 配置文件 ###

配置文件主要配置的是spring 与redis 的集成信息.

server:
      port: 8180
    spring:
      redis:
        host: localhost
        port: 6379
      session:
        store-type: redis

### 1.3 配置redis ###

spring data redis 可以选择jedis 或luttuce 库来操作redis, 笔者选择luttuce, 使用luttuce 需要配置一个LuttuceConnectionFactory.

@Configuration
    public class RedisConfig { 
    
        @Bean
        public LettuceConnectionFactory connectionFactory() { 
            return new LettuceConnectionFactory();
        }
    }

### 1.4 配置session ###

*  笔者习惯于把session配置拆分为独立的配置文件, 纵使配置没有内容.
 *  @EnableRedisHttpSession 使用@Confinguration 注解修饰, 所以用@EnableRedisHttpSession修饰的类也时配置类. @EnableRedisHttpSession 有几个可选参数:
    
     *  redisNamespace: redis中key 前缀, 默认为spring:session
     *  redisFlushMode: 刷新默认, 有两种模式, 默认为RedisFlushMode.ON\_SAVE
     *  maxInactiveIntervalInSeconds: 其实就是session会话超时时间, 默认为1800秒(30分钟)
 *  @EnableRedisHttpSession 会向spring 容器中注入过滤器SessionRepositoryFilter, 拦截所有的请求.

@EnableRedisHttpSession(
            redisNamespace="sboot",
            redisFlushMode=RedisFlushMode.ON_SAVE,
            maxInactiveIntervalInSeconds=1800)
    public class SessionConfig { 
    }

### 1.5 编写测试接口 ###

笔者编写一个非Restful 风格的API, 因为Spring session 对RestfulAPI和非Restful 的处理方式不一致.

@Controller
    @RequestMapping("/hello")
    public class HelloController { 
    
        @ResponseBody
        @RequestMapping("/say.json")
        public String say(HttpServletRequest request, HttpSession session){ 
    
            // 换行分隔符
            String lineBreak = "<br/>";
    
            StringBuffer sb = new StringBuffer();
    
            // 解析cookies
            sb.append("******************** cookies ************************" + lineBreak);
            Cookie[] cookies = request.getCookies();
            if (cookies != null && cookies.length > 0) { 
                for (Cookie cookie : cookies) { 
                    sb.append("cookie-" + cookie.getName() + ":" + cookie.getValue() + lineBreak);
                }
            }
    
            // 解析header
            sb.append("******************** headers ************************" + lineBreak);
            Enumeration<String> headerNames = request.getHeaderNames();
            while (headerNames.hasMoreElements()) { 
                String headerName = headerNames.nextElement();
                String header = request.getHeader(headerName);
                sb.append("header-" + headerName + ":" + header+ lineBreak);
            }
    
            // 其它信息
            sb.append("********************************************" + lineBreak);
            sb.append("sessionId:" + session.getId() + lineBreak);
            sb.append("session.isNew:" + session.isNew() + lineBreak);
            sb.append("host:" + request.getLocalAddr() + ":" + request.getLocalPort() + lineBreak);
            sb.append("time:" + LocalDateTime.now() + lineBreak);
    
            return sb.toString();
        }
    
    }

## 2. 测试 ##

通常对于共享session的测试都需要借助于Nginx 或 Apache 来负载多个应用实例, 但是考虑到并非所有读者本地都有现成的Apache/Nginx 环境, 所以笔者就想了一种不借助于Nginx 和 Apache的测试方式. 其实搞清楚Session 创建的原理之后, 不借助于Nginx 和 Apache 也可以测试共享sessiond的.

### 2.1 打包 ###

mvn package -Dmaven.test.skip=true

### 2.2 清空redis 数据库 ###

笔者建议实现清空redis 数据库, 这样可以直观地看出redis 存入的key

$ redis-cli keys '*' | xargs redis-cli del

### 2.3 启动第一个实例 ###

java -jar learn-spring-session-0.0.1-SNAPSHOT.jar --server.port=8081

### 2.4 启动第二个实例 ###

java -jar learn-spring-session-0.0.1-SNAPSHOT.jar --server.port=8082

### 2.3 浏览器访问第一个实例, 第一次 ###

*  第一次访问时, 浏览器会生产一个SESSION, 存入cookie, 然后传给接口.
 *  访问地址: http://127.0.0.1:8081/hello/say.json
 *  session为: 8a28fd86-5ece-4491-9970-9ebfb0cbfc4b, 进行base64编码后: OGEyOGZkODYtNWVjZS00NDkxLTk5NzAtOWViZmIwY2JmYzRi

******************** cookies ************************
    cookie-SESSION:ZWYxMDgzZTQtODkzZi00YjllLWJhZmEtYzNkODMwNWY1MDFh
    ******************** headers ************************
    header-host:127.0.0.1:8081
    header-connection:keep-alive
    header-cache-control:max-age=0
    header-upgrade-insecure-requests:1
    header-user-agent:Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/72.0.3626.109 Safari/537.36
    header-accept:text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8
    header-accept-encoding:gzip, deflate, br
    header-accept-language:zh-CN,zh;q=0.9,en;q=0.8
    header-cookie:SESSION=ZWYxMDgzZTQtODkzZi00YjllLWJhZmEtYzNkODMwNWY1MDFh
    ********************************************
    sessionId:8a28fd86-5ece-4491-9970-9ebfb0cbfc4b
    session.isNew:true
    host:127.0.0.1:8081
    time:2019-04-17T11:27:32.604

### 2.4 浏览器访问第二个实例, 第二次 ###

*  第二次访问时, 浏览器传的cookie SESSION 不再是自己生成的了, 而是第一次请求返回的sessionId的base64 位编码
 *  访问地址: http://127.0.0.1:8081/hello/say.json

******************** cookies ************************
    cookie-SESSION:OGEyOGZkODYtNWVjZS00NDkxLTk5NzAtOWViZmIwY2JmYzRi
    ******************** headers ************************
    header-host:127.0.0.1:8081
    header-connection:keep-alive
    header-cache-control:max-age=0
    header-upgrade-insecure-requests:1
    header-user-agent:Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/72.0.3626.109 Safari/537.36
    header-accept:text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8
    header-accept-encoding:gzip, deflate, br
    header-accept-language:zh-CN,zh;q=0.9,en;q=0.8
    header-cookie:SESSION=OGEyOGZkODYtNWVjZS00NDkxLTk5NzAtOWViZmIwY2JmYzRi
    ********************************************
    sessionId:8a28fd86-5ece-4491-9970-9ebfb0cbfc4b
    session.isNew:false
    host:127.0.0.1:8081
    time:2019-04-17T11:27:35.198

### 2.5 浏览器访问第二个实例, 第一次 ###

*  第一次访问第二个实例, 会发现session id 和之前的一致, 而且session已经不是新的session了.
 *  访问地址: http://127.0.0.1:8082/hello/say.json

******************** cookies ************************
    cookie-SESSION:OGEyOGZkODYtNWVjZS00NDkxLTk5NzAtOWViZmIwY2JmYzRi
    ******************** headers ************************
    header-host:127.0.0.1:8082
    header-connection:keep-alive
    header-cache-control:max-age=0
    header-upgrade-insecure-requests:1
    header-user-agent:Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/72.0.3626.109 Safari/537.36
    header-accept:text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8
    header-accept-encoding:gzip, deflate, br
    header-accept-language:zh-CN,zh;q=0.9,en;q=0.8
    header-cookie:SESSION=OGEyOGZkODYtNWVjZS00NDkxLTk5NzAtOWViZmIwY2JmYzRi
    ********************************************
    sessionId:8a28fd86-5ece-4491-9970-9ebfb0cbfc4b
    session.isNew:false
    host:127.0.0.1:8082
    time:2019-04-17T11:27:37.586