Spring Session 與 Spring Security
本指南介紹瞭如何將 Spring Session 與 Spring Security 一起使用。它假設您已經在您的應用程式中應用了 Spring Security。
| 您可以在 security 示例應用程式中找到完整的指南。 |
更新依賴
在使用 Spring Session 之前，您必須更新您的依賴。如果您使用 Maven，則必須新增以下依賴
<dependencies>
<!-- ... -->
<dependency>
<groupId>org.springframework.session</groupId>
<artifactId>spring-session-data-redis</artifactId>
<version>3.4.3</version>
<type>pom</type>
</dependency>
<dependency>
<groupId>io.lettuce</groupId>
<artifactId>lettuce-core</artifactId>
<version>6.3.2.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-web</artifactId>
<version>6.2.5</version>
</dependency>
</dependencies>Spring 配置
新增必要的依賴後，我們可以建立 Spring 配置。Spring 配置負責建立一個 Servlet 過濾器，該過濾器用 Spring Session 支援的實現替換 HttpSession 實現。為此，請新增以下 Spring 配置
@Configuration
@EnableRedisHttpSession (1)
public class Config {
@Bean
public LettuceConnectionFactory connectionFactory() {
return new LettuceConnectionFactory(); (2)
}
}| 1 | @EnableRedisHttpSession 註解會建立一個名為 springSessionRepositoryFilter 的 Spring Bean，該 Bean 實現了 Filter 介面。該過濾器負責將 HttpSession 的實現替換為由 Spring Session 支援的實現。在此示例中，Spring Session 由 Redis 支援。 |
| 2 | 我們建立一個 RedisConnectionFactory，用於將 Spring Session 連線到 Redis 伺服器。我們將連線配置為連線到 localhost 的預設埠 (6379)。有關配置 Spring Data Redis 的更多資訊，請參閱參考文件。 |
Servlet 容器初始化
我們的Spring 配置建立了一個名為 springSessionRepositoryFilter 的 Spring Bean，該 Bean 實現了 Filter 介面。springSessionRepositoryFilter Bean 負責將 HttpSession 替換為由 Spring Session 支援的自定義實現。
為了讓我們的 Filter 起作用，Spring 需要載入我們的 Config 類。由於我們的應用程式已經使用 SecurityInitializer 類載入 Spring 配置，我們可以將我們的配置類新增到其中。以下示例展示瞭如何實現
public class SecurityInitializer extends AbstractSecurityWebApplicationInitializer {
public SecurityInitializer() {
super(SecurityConfig.class, Config.class);
}
}最後，我們需要確保 Servlet 容器（例如 Tomcat）對每個請求都使用我們的 springSessionRepositoryFilter。Spring Session 的 springSessionRepositoryFilter 必須在 Spring Security 的 springSecurityFilterChain 之前呼叫，這一點至關重要。這可以確保 Spring Security 使用的 HttpSession 由 Spring Session 支援。幸運的是，Spring Session 提供了一個名為 AbstractHttpSessionApplicationInitializer 的實用類，這使得實現這一點變得容易。以下示例展示瞭如何實現
public class Initializer extends AbstractHttpSessionApplicationInitializer {
}| 我們的類名（Initializer）並不重要。重要的是我們繼承了 AbstractHttpSessionApplicationInitializer。 |
透過繼承 AbstractHttpSessionApplicationInitializer，我們確保名為 springSessionRepositoryFilter 的 Spring Bean 在 Spring Security 的 springSecurityFilterChain 之前註冊到我們的 Servlet 容器中，處理每個請求。
security 示例應用程式
本節介紹如何使用 security 示例應用程式。
執行 security 示例應用程式
您可以透過獲取原始碼並呼叫以下命令來執行示例
$ ./gradlew :spring-session-sample-javaconfig-security:tomcatRun
| 要使示例正常工作，您必須在 localhost 上安裝 Redis 2.8+ 並使用預設埠 (6379) 執行它。或者，您可以更新 RedisConnectionFactory 以指向另一個 Redis 伺服器。另一種選擇是使用Docker 在 localhost 上執行 Redis。有關詳細說明，請參閱Docker Redis 倉庫。 |
現在您應該能夠透過 localhost:8080/ 訪問該應用程式了
探索 security 示例應用程式
現在您可以使用該應用程式了。輸入以下內容進行登入
-
使用者名稱 user
-
密碼 password
現在點選 Login 按鈕。您應該看到一條訊息，指示您已使用之前輸入的使用者登入。使用者的會話資訊儲存在 Redis 中，而不是 Tomcat 的 HttpSession 實現中。
工作原理
我們不是使用 Tomcat 的 HttpSession，而是將值持久化到 Redis 中。Spring Session 用一個由 Redis 支援的實現替換了 HttpSession。當 Spring Security 的 SecurityContextPersistenceFilter 將 SecurityContext 儲存到 HttpSession 時，它隨後會被持久化到 Redis 中。
建立新的 HttpSession 時，Spring Session 會在您的瀏覽器中建立一個名為 SESSION 的 cookie。該 cookie 包含您的會話 ID。您可以檢視 cookie（使用 Chrome 或 Firefox）。
您可以使用 redis-cli 刪除會話。例如，在基於 Linux 的系統上，您可以輸入以下命令
$ redis-cli keys '*' | xargs redis-cli del
| Redis 文件提供了安裝 redis-cli 的說明。 |
或者，您也可以刪除特定的 key。在終端中輸入以下命令，請務必將 7e8383a4-082c-4ffe-a4bc-c40fd3363c5e 替換為您 SESSION cookie 的值
$ redis-cli del spring:session:sessions:7e8383a4-082c-4ffe-a4bc-c40fd3363c5e
現在您可以訪問 localhost:8080/ 檢視，您將不再處於認證狀態。
