| 
         对于最新的稳定版本,请使用 Spring Session 3.4.0!  | 
    
使用 Hazelcast 的 Spring Session 和 Spring Security
本指南介绍了在使用 Hazelcast 作为数据存储时,如何将 Spring Session 与 Spring Security 一起使用。 它假定您已经将 Spring Security 应用于您的应用程序。
| 您可以在 Hazelcast Spring Security 示例应用程序中找到完整的指南。 | 
更新依赖项
在使用 Spring Session 之前,您必须更新依赖项。 如果您使用 Maven,则必须添加以下依赖项:
<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.1.14</version>
	</dependency>
</dependencies>
Spring 配置
添加所需的依赖项后,我们可以创建 Spring 配置。
Spring 配置负责创建一个 servlet 过滤器,该过滤器将HttpSessionimplementation 替换为 Spring Session 支持的 implementation。
为此,请添加以下 Spring Configuration:
@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 | 这@EnableHazelcastHttpSessionannotation 会创建一个名为springSessionRepositoryFilter实现Filter.
过滤器负责替换HttpSession实现,由 Spring Session 支持。
在这种情况下,Spring Session 由 Hazelcast 提供支持。 | 
| 2 | 为了支持按主体名称索引检索会话,适当的ValueExtractor需要注册。
Spring Session 提供PrincipalNameExtractor为此目的。 | 
| 3 | 为了序列化MapSession对象,HazelcastSessionSerializer需要注册。如果此
未设置,则 Hazelcast 将使用本机 Java 序列化序列化会话。 | 
| 4 | 我们创建一个HazelcastInstance将 Spring Session 连接到 Hazelcast。
默认情况下,应用程序启动并连接到 Hazelcast 的嵌入式实例。
有关配置 Hazelcast 的更多信息,请参阅参考文档。 | 
如果HazelcastSessionSerializer是首选的,则需要在启动之前为所有 Hazelcast 集群成员配置它。
在 Hazelcast 集群中,所有成员都应为会话使用相同的序列化方法。此外,如果 Hazelcast 客户端/服务器拓扑
,则成员和客户端都必须使用相同的序列化方法。序列化程序可以通过ClientConfig替换为相同的SerializerConfiguration的成员。 | 
Servlet 容器初始化
我们的 Spring 配置创建了一个名为springSessionRepositoryFilter实现Filter.
这springSessionRepositoryFilterbean 负责将HttpSession使用由 Spring Session 支持的自定义实现。
为了我们的Filter为了发挥它的魔力,Spring 需要加载我们的SessionConfig类。
由于我们的应用程序已经使用我们的SecurityInitializer类,我们可以添加SessionConfig类。
下面的清单显示了如何做到这一点:
public class SecurityInitializer extends AbstractSecurityWebApplicationInitializer {
	public SecurityInitializer() {
		super(SecurityConfig.class, SessionConfig.class);
	}
}
最后,我们需要确保我们的 Servlet 容器(即 Tomcat)使用我们的springSessionRepositoryFilter对于每个请求。
Spring Session 的springSessionRepositoryFilter在 Spring Security 的springSecurityFilterChain.
这样做可以确保HttpSessionSpring Security 使用的 Spring Session 支持。
幸运的是,Spring Session 提供了一个名为AbstractHttpSessionApplicationInitializer这使得这变得如此简单。
以下示例显示了如何执行此作:
public class Initializer extends AbstractHttpSessionApplicationInitializer {
}
我们类的名称 (Initializer) 无关紧要。重要的是,我们扩展AbstractHttpSessionApplicationInitializer. | 
通过扩展AbstractHttpSessionApplicationInitializer中,我们确保名为springSessionRepositoryFilter在我们的 servlet 容器中注册,用于 Spring Security 的springSecurityFilterChain.
Hazelcast Spring Security 示例应用程序
本节介绍如何使用 Hazelcast Spring Security 示例应用程序。
运行示例应用程序
您可以通过获取源码并调用以下命令来运行该示例:
$ ./gradlew :spring-session-sample-javaconfig-hazelcast:tomcatRun
| 默认情况下,Hazelcast 以嵌入式模式运行您的应用程序。 但是,如果您想改为连接到独立实例,则可以按照参考文档中的说明对其进行配置。 | 
您现在应该能够访问 localhost:8080/ 中的应用程序
探索安全性示例应用程序
您现在可以尝试使用该应用程序。 为此,请输入以下内容以登录:
- 
用户名 user
 - 
密码 密码
 
现在单击 Login 按钮。
您现在应该会看到一条消息,指示您已使用之前输入的用户登录。
用户的信息存储在 Hazelcast 中,而不是 Tomcat 的HttpSession实现。
它是如何工作的?
而不是使用 Tomcat 的HttpSession,我们将 Hazelcast 中的值保留下来。
Spring Session 取代了HttpSession替换为由Map在 Hazelcast。
当 Spring Security 的SecurityContextPersistenceFilter保存SecurityContext到HttpSession,然后将其持久化到 Hazelcast 中。
与 Data Store 交互
使用控制台
例如,要在连接到 Hazelcast 节点后使用 管理中心 控制台删除会话,请运行以下命令:
default> ns spring:session:sessions spring:session:sessions> m.clear
| Hazelcast 文档包含控制台的说明。 | 
或者,您也可以删除显式密钥。在控制台中输入以下内容,确保将7e8383a4-082c-4ffe-a4bc-c40fd3363c5e与您的SESSION饼干:
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 http://localhost:xxxxx/hazelcast/rest/maps/spring:session:sessions/7e8383a4-082c-4ffe-a4bc-c40fd3363c5e
Hazelcast 节点的端口号在启动时打印到控制台。取代xxxxx替换为端口号。 | 
现在,您可以看到您不再通过此会话进行身份验证。