Spring Session 和 Spring Security

本指南介绍如何将 Spring Session 与 Spring Security 一起使用。它假设您已将 Spring Security 应用到您的应用程序中。

您可以在 安全示例应用程序 中找到完整的指南。

更新依赖项

在使用 Spring Session 之前,您必须更新您的依赖项。如果您使用 Maven,则必须添加以下依赖项

pom.xml
<dependencies>
	<!-- ... -->

	<dependency>
		<groupId>org.springframework.session</groupId>
		<artifactId>spring-session-data-redis</artifactId>
		<version>3.3.0</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.1.7</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 服务器。我们配置连接以在默认端口 (6379) 上连接到本地主机。有关配置 Spring Data Redis 的更多信息,请参阅 参考文档

Servlet 容器初始化

我们的 Spring 配置 创建了一个名为 springSessionRepositoryFilter 的 Spring bean,它实现了 FilterspringSessionRepositoryFilter bean 负责使用由 Spring Session 支持的自定义实现替换 HttpSession

为了让我们的 Filter 发挥作用,Spring 需要加载我们的 Config 类。由于我们的应用程序已经通过使用我们的 SecurityInitializer 类加载 Spring 配置,因此我们可以将我们的配置类添加到其中。以下示例展示了如何执行此操作

src/main/java/sample/SecurityInitializer.java
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 的实用程序类,使其易于执行此操作。以下示例展示了如何执行此操作

src/main/java/sample/Initializer.java
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
要使示例正常工作,您必须在本地主机上 安装 Redis 2.8+ 并使用默认端口 (6379) 运行它。或者,您可以更新 RedisConnectionFactory 以指向 Redis 服务器。另一个选择是使用 Docker 在本地主机上运行 Redis。有关详细说明,请参阅 Docker Redis 存储库

您现在应该能够在 localhost:8080/ 访问应用程序

探索 security 示例应用程序

现在您可以使用该应用程序。输入以下内容以登录

  • 用户名 user

  • 密码 password

现在单击登录按钮。您现在应该看到一条消息,指示您已使用先前输入的用户登录。用户的的信息存储在 Redis 中,而不是 Tomcat 的 HttpSession 实现中。

它是如何工作的?

我们不会使用 Tomcat 的 HttpSession,而是将值保留在 Redis 中。Spring Session 用由 Redis 支持的实现替换了 HttpSession。当 Spring Security 的 SecurityContextPersistenceFilterSecurityContext 保存到 HttpSession 时,它会被保留到 Redis 中。

当创建新的 HttpSession 时,Spring Session 会在您的浏览器中创建一个名为 SESSION 的 cookie。该 cookie 包含会话的 ID。您可以查看 cookie(使用 ChromeFirefox)。

您可以使用 redis-cli 删除会话。例如,在基于 Linux 的系统上,您可以键入以下命令

	$ redis-cli keys '*' | xargs redis-cli del
Redis 文档包含有关 安装 redis-cli 的说明。

或者,您还可以删除显式密钥。在您的终端中输入以下命令,务必将 7e8383a4-082c-4ffe-a4bc-c40fd3363c5e 替换为 SESSION cookie 的值

$ redis-cli del spring:session:sessions:7e8383a4-082c-4ffe-a4bc-c40fd3363c5e

现在,您可以访问 localhost:8080/ 上的应用程序,并看到我们不再经过身份验证。