Spring Session - Spring Boot

本指南介紹瞭如何在使用 Spring Boot 時，利用 Spring Session 透明地使用關係型資料庫作為 Web 應用 HttpSession 的後端儲存。

您可以在 httpsession-jdbc-boot 示例應用中找到完整的指南。

更新依賴

在使用 Spring Session 之前，您必須更新您的依賴。我們假設您正在使用一個可工作的 Spring Boot Web 應用。如果您使用 Maven，則必須新增以下依賴：

pom.xml

<dependencies>
	<!-- ... -->

	<dependency>
		<groupId>org.springframework.session</groupId>
		<artifactId>spring-session-jdbc</artifactId>
	</dependency>
</dependencies>

Spring Boot 為 Spring Session 模組提供了依賴管理，因此您無需顯式宣告依賴版本。

Spring Boot 配置

新增所需的依賴後，我們可以建立 Spring Boot 配置。得益於一流的自動配置支援，只需新增依賴，Spring Boot 就會為我們設定由關係型資料庫支援的 Spring Session。

如果 classpath 中存在單個 Spring Session 模組，Spring Boot 會自動使用該儲存實現。如果您有多個實現，則必須選擇您希望用於儲存 Session 的 StoreType，如上所示。

底層，Spring Boot 應用的配置等同於手動新增 @EnableJdbcHttpSession 註解。這會建立一個名為 springSessionRepositoryFilter 的 Spring Bean。該 Bean 實現了 Filter。該 Filter 負責將 HttpSession 實現替換為由 Spring Session 支援的實現。

您可以使用 application.properties 進行進一步定製。以下清單展示瞭如何操作：

src/main/resources/application.properties

server.servlet.session.timeout= # Session timeout. If a duration suffix is not specified, seconds are used.
spring.session.jdbc.initialize-schema=embedded # Database schema initialization mode.
spring.session.jdbc.schema=classpath:org/springframework/session/jdbc/schema-@@platform@@.sql # Path to the SQL file to use to initialize the database schema.
spring.session.jdbc.table-name=SPRING_SESSION # Name of the database table used to store sessions.

更多資訊，請參閱 Spring Boot 文件中關於 Spring Session 的部分。

配置 `DataSource`

Spring Boot 會自動建立一個 DataSource，用於將 Spring Session 連線到嵌入式 H2 資料庫例項。在生產環境中，您需要更新配置，使其指向您的關係型資料庫。例如，您可以在 application.properties 中包含以下內容：

src/main/resources/application.properties

spring.datasource.url= # JDBC URL of the database.
spring.datasource.username= # Login username of the database.
spring.datasource.password= # Login password of the database.

更多資訊，請參閱 Spring Boot 文件中關於配置 DataSource 的部分。

Servlet 容器初始化

我們的Spring Boot 配置建立了一個名為 springSessionRepositoryFilter 的 Spring Bean，該 Bean 實現了 Filter。springSessionRepositoryFilter Bean 負責將 HttpSession 替換為由 Spring Session 支援的自定義實現。

為了讓我們的 Filter 發揮作用，Spring 需要載入我們的 Config 類。最後，我們需要確保我們的 Servlet 容器（即 Tomcat）為每個請求使用我們的 springSessionRepositoryFilter。幸運的是，Spring Boot 為我們處理了這兩個步驟。

`httpsession-jdbc-boot` 示例應用

httpsession-jdbc-boot 示例應用展示瞭如何在您使用 Spring Boot 時，利用 Spring Session 透明地使用 H2 資料庫作為 Web 應用 HttpSession 的後端儲存。

執行 `httpsession-jdbc-boot` 示例應用

您可以透過獲取原始碼並呼叫以下命令來執行此示例：

$ ./gradlew :spring-session-sample-boot-jdbc:bootRun

您現在應該可以透過 localhost:8080/ 訪問該應用。

探索安全示例應用

您現在可以嘗試使用該應用。為此，請輸入以下內容登入：

使用者名稱 user
密碼 password

現在點選登入按鈕。您應該會看到一條訊息，指示您已使用之前輸入的使用者名稱登入。使用者資訊儲存在 H2 資料庫中，而不是 Tomcat 的 HttpSession 實現中。

它是如何工作的？

我們不使用 Tomcat 的 HttpSession，而是將值持久化到 H2 資料庫中。Spring Session 用一個由關係型資料庫支援的實現替換了 HttpSession。當 Spring Security 的 SecurityContextPersistenceFilter 將 SecurityContext 儲存到 HttpSession 時，它隨後被持久化到 H2 資料庫中。

當建立一個新的 HttpSession 時，Spring Session 會在您的瀏覽器中建立一個名為 SESSION 的 cookie。該 cookie 包含您的 Session ID。您可以檢視 cookie（使用 Chrome 或 Firefox）。

您可以透過使用 H2 Web 控制檯來刪除 Session，該控制檯位於：localhost:8080/h2-console/（JDBC URL 請使用 jdbc:h2:mem:testdb）。

現在您可以訪問 localhost:8080/ 上的應用，您會看到我們不再處於認證狀態。