SpringBoot 整合 Spring-Session 實現分佈式會話項目實戰

Posted on by

Spring 提供瞭處理分佈式會話的解決方案：Spring-Session。Spring-Session 提供瞭對Redis、MongoDB、MySQL 等常用存儲的支持，Spring-Session 提供與 HttpSession 的透明整合，這意味著開發人員可以使用 Spring-Session 支持的實現方式，切換 HttpSession 至 Spring-Session。本文采用 Redis 作為第三方存儲，總結下 SpringBoot 整合 Spring-Session 實現分佈式會話的實戰方式及測試過程。

一、配置及開發

Step 1、添加依賴

在項目的 pom.xml 文件中添加 Redis 和 Spring-Session 的依賴包。

        <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>
        </dependency>

Step 2、配置 Redis 和 Spring-Session 持久化方式

筆者習慣使用 application.properties 作為 SpringBoot 的配置文件，也可以使用 application.yml 來配置。在 application.properties 配置文件中添加如下配置。

# 配置 Redis 服務器地址（此處是一個虛假地址）
spring.redis.host=10.211.12.6
# 配置 Redis 端口
spring.redis.port=6379
# 配置 Redis 密碼
spring.redis.password=123456
# 其他 Redis 的配置還有很多，例如 Redis 連接池的配置，此處暫時隻配置上述幾項關鍵點
# spring session 配置
spring.session.store-type=redis

Step 3、使用 JSON 序列化機制

Spring-Session 默認使用 JDK 序列化機制，要求類實現 Serializable 接口，序列化後是二進制字節數組，不易看懂。使用 JSON 序列化機制，序列化後的字符串容易看懂。

package com.test.conf;

import com.alibaba.fastjson.support.spring.GenericFastJsonRedisSerializer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.redis.serializer.RedisSerializer;

// spring session 使用 json 序列化機制
@Configuration
public class SessionConfig {
    @Bean
    public RedisSerializer<Object> springSessionDefaultRedisSerializer() {
        return new GenericFastJsonRedisSerializer();
    }
}

Step 4、在 SpringBoot 啟動類中添加 @EnableRedisHttpSession 註解，開啟 Spring-Session

package com.test;

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

@SpringBootApplication
// 開啟 Spring-Session
@EnableRedisHttpSession
// @EnableRedisHttpSession(maxInactiveIntervalInSeconds = 1800, redisNamespace = "test:session")
public class TestSessionAppApplication {

    public static void main(String[] args) {
        SpringApplication.run(TestSessionAppApplication.class, args);
    }
}

 打上 @EnableRedisHttpSession 註解即可開啟 Spring-Session。註解有幾個參數可以單獨設置，其中 maxInactiveIntervalInSeconds 表示 Session 過期時間，默認值是 30 分鐘；redisNamespace 表示 Session 在 Redis 中存儲時的命名空間，即 Session 在 Redis 中存儲的鍵名前綴，默認值是 “spring:session”，在實際項目中，可能不同的系統為瞭節約資源，會使用同一個 Redis，為瞭區分不同系統的 Session，可以為每個系統設置單獨的命名空間。

到此，項目關於 Spring-Session 的配置及開發已經基本完成，開發者可以像使用 HttpSession 的方式操作會話。下節是測試過程。

二、測試

2.1 controller 層編寫測試 demo

    @RequestMapping(value = "testSession")
    public String testSession(HttpServletRequest request) {
        HttpSession session = request.getSession();
        log.info("sessionId:[{}]", session.getId());
        session.setAttribute("name", "Lucy");
        session.setAttribute("age", "20");
        return session.getAttribute("name").toString();
    }

2.2 測試過程

同時以不同的端口 9001/9002 啟動 SpringBoot 項目，在本機電腦上模擬分佈式集群中的不同節點。用谷歌瀏覽器打開鏈接 http://localhost:9001/​testSession，服務端打印日志如下所示。

sessionId:[5c417104-4f6d-430d-b569-cbc1e19cdf02]

客戶端登錄 Redis 服務器，查看 Redis 中的 Session 內容。

[testuser@vm ~]$ redis-cli -h 10.211.12.6 -p 6379
10.211.12.6:6379> auth 123456
OK
10.211.12.6:6379> keys *
1) "spring:session:expirations:1658127780000"
2) "spring:session:sessions:5c417104-4f6d-430d-b569-cbc1e19cdf02"
3) "spring:session:sessions:expires:5c417104-4f6d-430d-b569-cbc1e19cdf02"

Redis 會為每個 RedisSession 存儲三個鍵值對（以下簡稱 key-value）：

  • 第一個 key-value 存儲這個 Session 的 Id，是一個 Set 類型的 Redis 數據結構。這個 key 中的最後的 1658127780000 值是一個時間戳，根據這個 Session 過期時刻滾動至下一分鐘而計算得出。
  • 第二個 key-value 用來存儲 Session 的詳細信息，是一個 Hash 類型的 Redis 數據結構，包括 Session 的最近訪問時間（lastAccessedTime）、過期時間間隔（maxInactiveInterval，默認是 30 分鐘，這裡保存的秒值）、創建時間（creationTime）、sessionAttr 等等。
  • 第三個 key-value 用來表示 Session 在 Redis 中的過期時間，是一個 String 類型的 Redis 數據結構。這個 key-value 不存儲任何有用數據，隻是為表示 Session 過期而設置。這個 key 在 Redis 中的過期時間即為 Session 的過期時間間隔，可以用 ttl 命令查看該 key 的過期時間，即為 Session 的過期時間。

本次測試時，Redis 中的數據詳情如下所示。

10.211.12.6:6379> type spring:session:expirations:1658127780000
set
10.211.12.6:6379> smembers spring:session:expirations:1658127780000
1) "\"expires:5c417104-4f6d-430d-b569-cbc1e19cdf02\""
10.211.12.6:6379>
10.211.12.6:6379> type spring:session:sessions:5c417104-4f6d-430d-b569-cbc1e19cdf02
hash
10.211.12.6:6379> hgetall spring:session:sessions:5c417104-4f6d-430d-b569-cbc1e19cdf02
 1) "lastAccessedTime"
 2) "1658125969794"
 3) "maxInactiveInterval"
 4) "1800"
 5) "creationTime"
 6) "1658125925139"
 7) "sessionAttr:age"
 8) "\"20\""
 9) "sessionAttr:name"
10) "\"Lucy\""
10.211.12.6:6379>
10.211.12.6:6379> type spring:session:sessions:expires:5c417104-4f6d-430d-b569-cbc1e19cdf02
string
10.211.12.6:6379> get spring:session:sessions:expires:5c417104-4f6d-430d-b569-cbc1e19cdf02
""
10.201.42.26:6379>

查看瀏覽器 Cookie，此時瀏覽器已經有瞭一個正在使用的 Cookie，見下圖。

刷新瀏覽器，後端打印的 SessionId 不變，Redis 中的 Session 內容未新增，瀏覽器正常返回內容。說明本節點操作 Session 正常。

同一瀏覽器，打開另外一個測試端口鏈接 http://localhost:9002/​testSession，瀏覽器自動攜帶 Cookie，後端打印內容相同，Redis 內容相同（過期時間已更新），說明集群節點之間共享瞭 Session。

三、Spring-Session 的缺點

雖然 Spring-Session 提供瞭一種簡單易用，近乎透明的集成方式，使得支持集群會話變得微不足道，但是實際上 Spring-Session 是有些缺陷的。

  • 無法做到 Session 的過期以及銷毀事件的實時發佈；
  • 序列化方式可能對一些特定類型的會話，支持的不是很好；
  • Redis 存儲一個會話需要 3 個 鍵值，占用空間稍微大些；
  • 在高並發場景下，Session 因為不是 CAS(Compare And Set) 操作，所以可能存在一些並發問題（小問題）。

雖然 Spring-Session 存在一些缺點，但整體來說還是可用性很高的。此外自己可以寫一套過濾器，優化 Spring-Session 的缺點，實現分佈式會話。

文章參考：

認證–SpringSession(實戰)

到此這篇關於SpringBoot 整合 Spring-Session 實現分佈式會話項目實戰的文章就介紹到這瞭,更多相關SpringBoot Spring-Session分佈式會話內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：