Spring Session - Spring Boot

本指南介绍了如何在使用 Spring Boot 时，使用 Spring Session 透明地利用 Redis 来支持 Web 应用程序的 HttpSession。

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

更新依赖项

在使用 Spring Session 与 Redis 之前，您必须确保拥有正确的依赖项。我们假设您正在使用一个可运行的 Spring Boot Web 应用程序。

  • pom.xml

  • build.gradle

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

	<dependency>
		<groupId>org.springframework.session</groupId>
		<artifactId>spring-session-data-redis</artifactId>
	</dependency>
</dependencies>
implementation("org.springframework.session:spring-session-data-redis")

Spring Boot 为 Spring Session 模块提供依赖管理，因此您无需显式声明依赖版本。

Spring Boot 配置

添加了必要的依赖项后，我们可以创建 Spring Boot 配置。由于一流的自动配置支持，只需添加依赖项，Spring Boot 就会为我们设置由 Redis 支持的 Spring Session。

在幕后，Spring Boot 应用了等效于手动添加 @EnableRedisHttpSession 注解的配置。这将创建一个名为 springSessionRepositoryFilter 的 Spring Bean，它实现了 Filter。该过滤器负责替换由 Spring Session 支持的 HttpSession 实现。

可以使用 application.properties 进行进一步的自定义，如下面的列表所示

src/main/resources/application.properties
server.servlet.session.timeout= # Session timeout. If a duration suffix is not specified, seconds is used.
spring.session.redis.flush-mode=on_save # Sessions flush mode.
spring.session.redis.namespace=spring:session # Namespace for keys used to store sessions.

有关更多信息，请参阅 Spring Boot 文档的 Spring Session 部分。

配置 Redis 连接

Spring Boot 自动创建一个 RedisConnectionFactory，它将 Spring Session 连接到 localhost 上端口 6379（默认端口）上的 Redis 服务器。在生产环境中，您需要更新配置以指向您的 Redis 服务器。例如，您可以在您的 application.properties 中包含以下内容

src/main/resources/application.properties
spring.data.redis.host=localhost # Redis server host.
spring.data.redis.password= # Login password of the redis server.
spring.data.redis.port=6379 # Redis server port.

有关更多信息，请参阅 Spring Boot 文档的 连接到 Redis 部分。

Servlet 容器初始化

我们的 Spring Boot 配置 创建了一个名为 springSessionRepositoryFilter 的 Spring bean，它实现了 Filter 接口。springSessionRepositoryFilter bean 负责用由 Spring Session 支持的自定义实现替换 HttpSession。

为了让我们的 Filter 发挥作用，Spring 需要加载我们的 Config 类。最后，我们需要确保我们的 servlet 容器（即 Tomcat）对每个请求都使用我们的 springSessionRepositoryFilter。幸运的是，Spring Boot 为我们处理了这两个步骤。

Boot 示例应用程序

Boot 示例应用程序演示了如何在使用 Spring Boot 时，使用 Spring Session 透明地利用 Redis 来支持 Web 应用程序的 HttpSession。

运行 Boot 示例应用程序

您可以通过获取 源代码 并执行以下命令来运行示例

$ ./gradlew :spring-session-sample-boot-redis:bootRun
为了使示例正常工作，您必须在 localhost 上 安装 Redis 2.8+ 并使用默认端口 (6379) 运行它。或者，您可以更新 RedisConnectionFactory 以指向 Redis 服务器。另一个选择是使用 Docker 在 localhost 上运行 Redis。有关详细说明，请参阅 Docker Redis 存储库。

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

探索 security 示例应用程序

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

  • 用户名 user

  • 密码 password

现在点击登录按钮。您现在应该看到一条消息，表明您已使用之前输入的用户登录。用户信息存储在 Redis 中，而不是 Tomcat 的 HttpSession 实现中。

它是如何工作的？

我们没有使用 Tomcat 的 HttpSession，而是将值持久化到 Redis 中。Spring Session 用由 Redis 支持的实现替换了 HttpSession。当 Spring Security 的 SecurityContextPersistenceFilter 将 SecurityContext 保存到 HttpSession 时，它就会被持久化到 Redis 中。

当创建一个新的 HttpSession 时，Spring Session 会在您的浏览器中创建一个名为 SESSION 的 cookie。该 cookie 包含您的会话 ID。您可以使用（Chrome 或 Firefox）查看 cookie。

您可以使用 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/ 上的应用程序，并观察到我们不再经过身份验证。