Spring Session 和 Spring Security 與 Hazelcast 整合

本指南描述了當您使用 Hazelcast 作為資料儲存時，如何將 Spring Session 與 Spring Security 一起使用。它假設您已經在應用程式中應用了 Spring Security。

您可以在 Hazelcast Spring Security 示例應用程式中找到完整的指南。

更新依賴項

在使用 Spring Session 之前，您必須更新您的依賴項。如果您使用 Maven，您必須新增以下依賴項

pom.xml

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

	<dependency>
		<groupId>com.hazelcast</groupId>
		<artifactId>hazelcast</artifactId>
		<version>5.4.0</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 配置

@EnableHazelcastHttpSession (1)
@Configuration
public class HazelcastHttpSessionConfig {

	@Bean
	public HazelcastInstance hazelcastInstance() {
		Config config = new Config();
		AttributeConfig attributeConfig = new AttributeConfig()
			.setName(HazelcastIndexedSessionRepository.PRINCIPAL_NAME_ATTRIBUTE)
			.setExtractorClassName(PrincipalNameExtractor.class.getName());
		config.getMapConfig(HazelcastIndexedSessionRepository.DEFAULT_SESSION_MAP_NAME) (2)
			.addAttributeConfig(attributeConfig)
			.addIndexConfig(
					new IndexConfig(IndexType.HASH, HazelcastIndexedSessionRepository.PRINCIPAL_NAME_ATTRIBUTE));
		SerializerConfig serializerConfig = new SerializerConfig();
		serializerConfig.setImplementation(new HazelcastSessionSerializer()).setTypeClass(MapSession.class);
		config.getSerializationConfig().addSerializerConfig(serializerConfig); (3)
		return Hazelcast.newHazelcastInstance(config); (4)
	}

}

1	`@EnableHazelcastHttpSession` 註解建立一個名為 `springSessionRepositoryFilter` 的 Spring bean，該 bean 實現了 `Filter`。該過濾器負責替換由 Spring Session 支援的 `HttpSession` 實現。在此示例中，Spring Session 由 Hazelcast 支援。
2	為了支援透過主體名稱索引檢索會話，需要註冊一個適當的 `ValueExtractor`。Spring Session 為此目的提供了 `PrincipalNameExtractor`。
3	為了高效地序列化 `MapSession` 物件，需要註冊 `HazelcastSessionSerializer`。如果未設定此項，Hazelcast 將使用原生 Java 序列化方式序列化會話。
4	我們建立一個將 Spring Session 連線到 Hazelcast 的 `HazelcastInstance`。預設情況下，應用程式啟動並連線到 Hazelcast 的嵌入式例項。有關配置 Hazelcast 的更多資訊，請參閱參考文件。

如果首選 HazelcastSessionSerializer，則需要在所有 Hazelcast 叢集成員啟動之前為其進行配置。在 Hazelcast 叢集中，所有成員應使用相同的會話序列化方法。此外，如果使用 Hazelcast 客戶端/伺服器拓撲，則成員和客戶端都必須使用相同的序列化方法。可以透過 ClientConfig 註冊序列化器，使用與成員相同的 SerializerConfiguration。

Servlet 容器初始化

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

為了讓我們的 Filter 發揮作用，Spring 需要載入我們的 SessionConfig 類。由於我們的應用程式已經使用 SecurityInitializer 類載入 Spring 配置，我們可以將 SessionConfig 類新增到其中。以下清單展示瞭如何實現

src/main/java/sample/SecurityInitializer.java

public class SecurityInitializer extends AbstractSecurityWebApplicationInitializer {

	public SecurityInitializer() {
		super(SecurityConfig.class, SessionConfig.class);
	}

}

最後，我們需要確保我們的 Servlet 容器（即 Tomcat）對每個請求都使用我們的 springSessionRepositoryFilter。極其重要的是，Spring Session 的 springSessionRepositoryFilter 必須在 Spring Security 的 springSecurityFilterChain 之前被呼叫。這樣做可以確保 Spring Security 使用的 HttpSession 由 Spring Session 支援。幸運的是，Spring Session 提供了一個名為 AbstractHttpSessionApplicationInitializer 的實用類，使得實現這一點變得容易。以下示例展示瞭如何實現

src/main/java/sample/Initializer.java

public class Initializer extends AbstractHttpSessionApplicationInitializer {

}

我們的類名（Initializer）並不重要。重要的是我們擴充套件了 AbstractHttpSessionApplicationInitializer。

透過擴充套件 AbstractHttpSessionApplicationInitializer，我們可以確保名為 springSessionRepositoryFilter 的 Spring Bean 在 Spring Security 的 springSecurityFilterChain 之前為每個請求註冊到我們的 Servlet 容器中。

Hazelcast Spring Security 示例應用程式

本節描述瞭如何使用 Hazelcast Spring Security 示例應用程式。

執行示例應用程式

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

$ ./gradlew :spring-session-sample-javaconfig-hazelcast:tomcatRun

預設情況下，Hazelcast 以嵌入模式與您的應用程式一起執行。但是，如果您想連線到獨立的例項，可以按照參考文件中的說明進行配置。

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

探索安全示例應用程式

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

使用者名稱 user
密碼 password

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

它是如何工作的？

我們不是使用 Tomcat 的 HttpSession，而是將值持久化到 Hazelcast 中。Spring Session 將 HttpSession 替換為一個由 Hazelcast 中的 Map 支援的實現。當 Spring Security 的 SecurityContextPersistenceFilter 將 SecurityContext 儲存到 HttpSession 時，它就會被持久化到 Hazelcast 中。

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

與資料儲存互動

您可以透過使用 Java 客戶端、其他客戶端之一，或管理中心來移除會話。

使用控制檯

例如，連線到您的 Hazelcast 節點後，使用管理中心控制檯移除會話，執行以下命令

	default> ns spring:session:sessions
	spring:session:sessions> m.clear

Hazelcast 文件中包含有關控制檯的說明。

或者，您也可以刪除顯式鍵。在控制檯中輸入以下內容，請務必將 7e8383a4-082c-4ffe-a4bc-c40fd3363c5e 替換為您 SESSION cookie 的值

	spring:session:sessions> m.remove 7e8383a4-082c-4ffe-a4bc-c40fd3363c5e

現在訪問 localhost:8080/ 上的應用程式，並觀察到您已不再處於認證狀態。

使用 REST API

如文件中介紹其他客戶端的部分所述，Hazelcast 節點提供了一個REST API。

例如，您可以如下刪除單個鍵（請務必將 7e8383a4-082c-4ffe-a4bc-c40fd3363c5e 替換為您 SESSION cookie 的值）

	$ curl -v -X DELETE https://:xxxxx/hazelcast/rest/maps/spring:session:sessions/7e8383a4-082c-4ffe-a4bc-c40fd3363c5e

Hazelcast 節點的埠號會在啟動時列印到控制檯。將 xxxxx 替換為埠號。

現在您可以看到，使用此會話，您已不再處於認證狀態。