对于最新的稳定版本,请使用 Spring Session 3.5.2! |
使用 Hazelcast 的 Spring 会话和 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.1.7</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-web</artifactId>
<version>6.0.20</version>
</dependency>
</dependencies>
弹簧配置
添加所需的依赖项后,我们可以创建 Spring 配置。
Spring 配置负责创建一个 servlet 过滤器,该过滤器将HttpSession
实现,由 Spring Session 支持的实现。
为此,请添加以下 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 实现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
. 这springSessionRepositoryFilter
bean 负责将HttpSession
使用由 Spring Session 支持的自定义实现。
为了我们的Filter
为了发挥它的魔力,Spring 需要加载我们的SessionConfig
类。
由于我们的应用程序已经在加载 Spring 配置,因此使用SecurityInitializer
类,我们可以将SessionConfig
班级。
以下列表显示了如何执行此作:
public class SecurityInitializer extends AbstractSecurityWebApplicationInitializer {
public SecurityInitializer() {
super(SecurityConfig.class, SessionConfig.class);
}
}
最后,我们需要确保我们的 Servlet 容器(即 Tomcat)使用springSessionRepositoryFilter
对于每个请求。
Spring Session的springSessionRepositoryFilter
在 Spring Security 的springSecurityFilterChain
.
这样做可以确保HttpSession
Spring Security 使用的由 Spring Session 支持。
幸运的是,Spring Session 提供了一个名为AbstractHttpSessionApplicationInitializer
这使得这样做变得如此容易。
以下示例显示了如何执行此作:
public class Initializer extends AbstractHttpSessionApplicationInitializer {
}
我们的类的名称 (Initializer )无关紧要。重要的是,我们扩展AbstractHttpSessionApplicationInitializer . |
通过扩展AbstractHttpSessionApplicationInitializer
,我们确保 Spring Bean 命名为springSessionRepositoryFilter
在 Spring Security 之前的每个请求都注册到我们的 servlet 容器中springSecurityFilterChain
.
Hazelcast Spring Security示例应用程序
本节介绍如何使用 Hazelcast Spring Security 示例应用程序。
运行示例应用程序
您可以通过获取源代码并调用以下命令来运行示例:
$ ./gradlew :spring-session-sample-javaconfig-hazelcast:tomcatRun
默认情况下,Hazelcast 在应用程序中以嵌入式模式运行。 但是,如果您想连接到独立实例,可以按照参考文档中的说明进行配置。 |
您现在应该能够在 localhost:8080/ 访问该应用程序
探索安全示例应用程序
您现在可以尝试使用该应用程序。 为此,请输入以下内容进行登录:
-
用户名 user
-
密码密码
现在点击 登录 按钮。
您现在应该会看到一条消息,指示您已使用之前输入的用户登录。
用户的信息存储在 Hazelcast 中,而不是 Tomcat 的HttpSession
实现。
它是如何工作的?
而不是使用 Tomcat 的HttpSession
,我们将值保留在 Hazelcast 中。
Spring Session 将HttpSession
使用由Map
在黑兹尔卡斯特。
当 Spring Security 的SecurityContextPersistenceFilter
保存SecurityContext
到HttpSession
,然后将其持久化到 Hazelcast 中。
与数据存储交互
使用控制台
例如,要在连接到 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 替换为端口号。 |
现在,您可以看到您不再通过此会话进行身份验证。