跳到主要内容
版本：4.1.1

Spring Session 与 Spring Security

Doubao 中英对照 Spring Session and 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>4.1.1</version>
		<type>pom</type>
	</dependency>
	<dependency>
		<groupId>io.lettuce</groupId>
		<artifactId>lettuce-core</artifactId>
		<version>6.8.2.RELEASE</version>
	</dependency>
	<dependency>
		<groupId>org.springframework</groupId>
		<artifactId>spring-web</artifactId>
		<version>7.0.9</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
	}

}

  • @EnableRedisHttpSession 注解创建一个名为 springSessionRepositoryFilter、实现 Filter 的 Spring bean。该过滤器负责将 HttpSession 实现替换为由 Spring Session 支撑。在本例中，Spring Session 由 Redis 支撑。

  • 我们创建一个 RedisConnectionFactory，将 Spring Session 连接到 Redis 服务器。我们将连接配置为连接到 localhost 的默认端口（6379）。有关配置 Spring Data Redis 的更多信息，请参阅参考文档。

Servlet 容器初始化​

我们的 Spring 配置 创建了一个名为 springSessionRepositoryFilter、实现 Filter 的 Spring bean。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 将 HttpSession 替换为由 Redis 支撑的实现。当 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 的说明。

或者，你也可以删除显式键。在终端中输入以下命令，并确保将 7e8383a4-082c-4ffe-a4bc-c40fd3363c5e 替换为你的 SESSION cookie 的值：

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

现在你可以访问 localhost:8080/ 上的应用程序，并看到我们已不再处于认证状态。