此版本仍在开发中,尚未被认为是稳定的。请使用最新的稳定版本 Spring Session 4.0.2spring-doc.cadn.net.cn

Spring Session - Spring Boot

此指南描述了如何使用 Spring Session 透明地利用 Redis 来为基于 Spring Boot 的 Web 应用程序的 会话(Session) 提供支持。spring-doc.cadn.net.cn

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

更新依赖项

在使用Spring Session与Redis之前,您必须确保已正确添加依赖项。 我们假设您正在处理一个运行中的Spring Boot Web应用程序。spring-doc.cadn.net.cn

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

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

Spring Boot 为 Spring Session 模块提供了依赖管理,因此您无需显式声明依赖版本。spring-doc.cadn.net.cn

Spring Boot 配置

在添加了所需的依赖项后,我们可以创建我们的 Spring Boot 配置。 得益于一等的自动配置支持,只需添加相应的依赖项,Spring Boot 就会为我们设置基于 Redis 的 Spring Session。spring-doc.cadn.net.cn

在幕后,Spring Boot 应用的配置相当于手动添加了 @EnableRedisHttpSession 注解。 这创建了一个名为 springSessionRepositoryFilter 的 Spring bean,并实现了 Filter 接口。 过滤器负责将 HttpSession 实现替换为由 Spring Session 支持的实现。spring-doc.cadn.net.cn

进一步自定义可以通过使用application.properties实现,如下例所示:spring-doc.cadn.net.cn

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 Session部分的Spring Boot 文档。spring-doc.cadn.net.cn

配置 Redis 连接

Spring Boot 自动创建一个 RedisConnectionFactory,将 Spring Session 连接到本地主机上的端口 6379 的 Redis 服务器(默认端口)。 在生产环境中,您需要更新配置以指向您的 Redis 服务器。例如,您可以将在 application.properties 中包含以下内容:spring-doc.cadn.net.cn

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.

Servlet 容器初始化

我们的 Spring Boot 配置 创建了一个名为 springSessionRepositoryFilter 的 Spring bean,它实现了 FilterspringSessionRepositoryFilter bean 负责用一个由 Spring Session 支撑的自定义实现来替换 HttpSessionspring-doc.cadn.net.cn

为了使我们的Filter发挥魔力,Spring 需要加载我们的Config类。 最后,我们需要确保我们的 servlet 容器(即 Tomcat)为每个请求使用我们的springSessionRepositoryFilter。 幸运的是,Spring Boot 会为我们处理这两个步骤。spring-doc.cadn.net.cn

启动示例应用

The Boot 样例应用演示了如何使用 Spring Session 透明地利用 Redis 来支持一个基于 Spring Boot 的 Web 应用程序的 会话(session)spring-doc.cadn.net.cn

运行 Boot 示例应用程序

您可以运行示例程序,通过获取源代码并执行以下命令来实现:spring-doc.cadn.net.cn

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

您应该能够通过以下地址访问应用:localhost:8080/spring-doc.cadn.net.cn

探索security示例应用程序

现在您可以尝试使用该应用程序。输入以下内容进行登录:spring-doc.cadn.net.cn

现在点击 登录 按钮。 你应该会看到一条消息,表明你已使用之前输入的用户身份进行登录。 用户的个人信息存储在 Redis 而不是 Tomcat 的 HttpSession 实现中。spring-doc.cadn.net.cn

它是如何工作的?

而不是使用Tomcat的HttpSession,我们将在Redis中持久化这些值。 Spring Session用一个基于Redis的实现替换了HttpSession。 当Spring Security的SecurityContextPersistenceFilterSecurityContext保存到HttpSession时,它会被持久化到Redis中。spring-doc.cadn.net.cn

当一个新的HttpSession被创建时,Spring Session会在你的浏览器中创建一个名为SESSION的cookie。 该cookie包含你的会话ID。 你可以通过ChromeFirefox查看这些cookie。spring-doc.cadn.net.cn

您可以使用 redis-cli 移除会话。<br/> 例如,在基于 Linux 的系统上,可以输入以下命令:spring-doc.cadn.net.cn

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

也可以删除显式的密钥。
要执行此操作,请在终端中输入以下内容,并确保将7e8383a4-082c-4ffe-a4bc-c40fd3363c5e替换为您的SESSION cookie的值:spring-doc.cadn.net.cn

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

现在您可以访问应用,地址为 http://localhost:8080/,并观察到我们已经不再进行身份验证。spring-doc.cadn.net.cn