跳到主要内容
版本：4.1.1

Spring Session - Spring Boot

Doubao 中英对照 Spring Session - Spring Boot

本指南描述在使用 Spring Boot 时，如何使用 Spring Session 透明地利用关系型数据库来支撑 Web 应用程序的 HttpSession。

备注

你可以在 httpsession-jdbc-boot 示例应用程序 中找到完整的指南。

更新依赖​

在使用 Spring Session 之前，你必须更新依赖。我们假设你正在使用一个可运行的 Spring Boot Web 应用程序。如果你使用 Maven，你必须添加以下依赖：

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

	<dependency>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-session-jdbc</artifactId>
	</dependency>
</dependencies>

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

Spring Boot 配置​

添加所需依赖后，我们可以创建 Spring Boot 配置。得益于一流的自动配置支持，只需添加依赖，Spring Boot 就会为我们设置由关系型数据库支撑的 Spring Session。

如果 classpath 中只存在一个 Spring Session 模块，Spring Boot 会自动使用该存储实现。如果有多个实现，你必须选择希望用于存储会话的 StoreType，如上所示。

在底层，Spring Boot 应用的配置等同于手动添加 @EnableJdbcHttpSession 注解。这会创建一个名为 springSessionRepositoryFilter 的 Spring bean。该 bean 实现 Filter。该过滤器负责将 HttpSession 实现替换为由 Spring Session 支撑。

你可以使用 application.properties 进一步自定义。以下清单展示了如何这样做：

server.servlet.session.timeout= # Session timeout. If a duration suffix is not specified, seconds are used.
spring.session.jdbc.initialize-schema=embedded # Database schema initialization mode.
spring.session.jdbc.schema=classpath:org/springframework/session/jdbc/schema-@@platform@@.sql # Path to the SQL file to use to initialize the database schema.
spring.session.jdbc.table-name=SPRING_SESSION # Name of the database table used to store sessions.

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

配置 DataSource​

Spring Boot 会自动创建一个 DataSource，将 Spring Session 连接到嵌入式 H2 数据库实例。在生产环境中，你需要更新配置以指向你的关系型数据库。例如，你可以在 application.properties 中加入以下内容：

spring.datasource.url= # JDBC URL of the database.
spring.datasource.username= # Login username of the database.
spring.datasource.password= # Login password of the database.

更多信息，请参阅 Spring Boot 文档的配置 DataSource 部分。

Servlet 容器初始化​

我们的 Spring Boot 配置 创建了一个名为 springSessionRepositoryFilter、实现 Filter 的 Spring bean。springSessionRepositoryFilter bean 负责将 HttpSession 替换为由 Spring Session 支撑的自定义实现。

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

httpsession-jdbc-boot 示例应用程序​

httpsession-jdbc-boot 示例应用程序演示了在使用 Spring Boot 时，如何使用 Spring Session 透明地利用 H2 数据库来支撑 Web 应用程序的 HttpSession。

运行 httpsession-jdbc-boot 示例应用程序​

你可以通过获取源代码并运行以下命令来启动示例：

$ ./gradlew :spring-session-sample-boot-jdbc:bootRun

现在你应该可以通过 localhost:8080/ 访问该应用程序了。

探索 Security 示例应用程序​

现在你可以尝试使用该应用程序。为此，输入以下内容进行登录：

  • 用户名 user
  • 密码 password

现在点击 Login 按钮。你现在应该会看到一条消息，指示你已使用先前输入的用户登录。用户信息存储在 H2 数据库中，而不是 Tomcat 的 HttpSession 实现中。

它是如何工作的？​

我们没有使用 Tomcat 的 HttpSession，而是将值持久化到 H2 数据库中。Spring Session 将 HttpSession 替换为由关系型数据库支撑的实现。当 Spring Security 的 SecurityContextPersistenceFilter 将 SecurityContext 保存到 HttpSession 时，它随后被持久化到 H2 数据库中。

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

你可以通过以下地址提供的 H2 Web 控制台移除会话：localhost:8080/h2-console/（JDBC URL 使用 jdbc:h2:mem:testdb）。

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