最新稳定版请使用Spring Session 3.5.3spring-doc.cadn.net.cn

春季课程 - 春季启动

本指南介绍了如何利用 Spring Session 透明地利用 Redis 来支持网页应用HttpSession当你使用Spring Boot时。spring-doc.cadn.net.cn

你可以在靴子 Samples申请表中找到完成的指南。

更新依赖关系

在使用 Spring Session with Redis 之前,你必须确保拥有正确的依赖。 我们假设你使用的是一个正常运行的 Spring Boot 网页应用。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实现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-doc.cadn.net.cn

配置 Redis 连接

Spring Boot会自动生成RedisConnection工厂它通过端口6379(默认端口)将Spring Session连接到localhost上的Redis Server。 在生产环境中,你需要更新配置以指向你的 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.

更多信息请参见 Spring Boot 文档中的“连接 Redis 部分”。spring-doc.cadn.net.cn

Servlet 容器初始化

我们的Spring Boot配置创建了一个名为springSessionRepositoryFilter实现Filter. 这springSessionRepositoryFilterBean负责替换HttpSession并采用由 Spring Session 支持的自定义实现。spring-doc.cadn.net.cn

为了我们的Filter要施展它的魔力,Spring需要加载我们的配置类。 最后,我们需要确保我们的servlet容器(即Tomcat)使用我们的springSessionRepositoryFilter每一个请求。 幸运的是,Spring Boot 帮我们解决了这两个步骤。spring-doc.cadn.net.cn

启动示例应用

启动示例应用程序演示了如何利用 Spring Session 透明地利用 Redis 来支持网页应用HttpSession当你使用Spring Boot时。spring-doc.cadn.net.cn

运行启动示例应用

您可以通过获取源代码并调用以下命令来运行示例:spring-doc.cadn.net.cn

$ ./gradlew :spring-session-sample-boot-redis:bootRun
为了让样本正常工作,你必须在localhost上安装Redis 2.8+,并用默认端口(6379)运行。 或者,你也可以更新RedisConnection工厂指向一个Redis服务器。 另一个选择是用 Docker 在 localhost 上运行 Redis。详见 Docker Redis 仓库中的详细说明。

你现在应该可以在localhost:8080/访问该应用了spring-doc.cadn.net.cn

探索安全示例应用

现在你可以试试用这个应用了。请输入以下方式登录:spring-doc.cadn.net.cn

现在点击登录按钮。 你现在应该会看到一条提示,提示你已经登录了之前输入的用户。 用户的信息存储在Redis中,而非Tomcat的HttpSession实现。spring-doc.cadn.net.cn

它是如何运作的?

而不是用Tomcat的HttpSession,我们在Redis中保持这些值。 Spring Session取代了HttpSession实现得到了Redis的支持。 当春季安全SecurityContextPersistenceFilter节省安全上下文前往HttpSession,然后被持久化到Redis中。spring-doc.cadn.net.cn

当新的HttpSession创建了 Spring Session 创建一个名为会期在你的浏览器里。 这个Cookie里包含了你会话的ID。 你可以查看这些Cookie(使用ChromeFirefox)。spring-doc.cadn.net.cn

你可以用redis-cli删除该会话。 例如,在基于Linux的系统上,你可以输入以下内容:spring-doc.cadn.net.cn

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

或者,你也可以删除显式密钥。 作方法是在终端输入以下内容,确保替换7E8383A4-082C-4fFE-A4BC-C40FD3363C5E其价值为会期饼干:spring-doc.cadn.net.cn

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

现在你可以访问 localhost:8080/ 的应用程序,发现我们已不再认证。spring-doc.cadn.net.cn