Spring Session - Spring Boot
本指南描述了如何使用Spring Session透明地利用关系型数据库来支持Web应用程序的HttpSession
,当你使用Spring Boot时。
你可以在 httpsession-jdbc-boot 示例应用程序 中找到完整的指南。
更新依赖项
在使用 Spring Session 之前,您必须更新依赖项。我们假设您正在使用一个可以正常工作的 Spring Boot Web 应用程序。如果您使用 Maven,则必须添加以下依赖项:
<dependencies>
<!-- ... -->
<dependency>
<groupId>org.springframework.session</groupId>
<artifactId>spring-session-jdbc</artifactId>
</dependency>
</dependencies>
Spring Boot 为 Spring Session 模块提供了依赖管理,因此你不必显式声明依赖版本。
Spring Boot 配置
在添加了所需的依赖项后,我们可以创建我们的Spring Boot配置。得益于一流的自动配置支持,只需添加依赖项,Spring Boot 就会为我们设置由关系数据库支持的 Spring Session。
如果类路径上存在单个 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 Session 部分的 Spring Boot 文档。
配置 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
的 Spring bean,它实现了 Filter
。springSessionRepositoryFilter
bean 负责用由 Spring Session 支持的自定义实现来替换 HttpSession
。
为了让我们的 Filter
发挥作用,Spring 需要加载我们的 Config
类。最后,我们需要确保我们的 Servlet 容器(即 Tomcat)对每个请求都使用我们的 springSessionRepositoryFilter
。幸运的是,Spring Boot 为我们处理了这两个步骤。
httpsession-jdbc-boot
示例应用程序
httpsession-jdbc-boot 示例应用程序演示了如何使用 Spring Session 透明地利用 H2 数据库来支持 Web 应用程序的 HttpSession
,当你使用 Spring Boot 时。
运行 httpsession-jdbc-boot
示例应用程序
您可以从获取源代码并运行以下命令来运行示例:
$ ./gradlew :spring-session-sample-boot-jdbc:bootRun
你现在应该能够访问 localhost:8080/ 上的应用程序。
探索 Security 示例应用程序
你现在可以尝试使用该应用程序。为此,请输入以下内容进行登录:
-
用户名 user
-
密码 password
现在点击 登录 按钮。你应该会看到一条消息,表明你已使用之前输入的用户登录。用户的信息存储在 H2 数据库中,而不是 Tomcat 的 HttpSession
实现中。
它是如何工作的?
我们不使用 Tomcat 的 HttpSession
,而是将值持久化到 H2 数据库中。Spring Session 用一个由关系型数据库支持的实现来替换 HttpSession
。当 Spring Security 的 SecurityContextPersistenceFilter
将 SecurityContext
保存到 HttpSession
时,它会被持久化到 H2 数据库中。
您可以使用位于 localhost:8080/h2-console/ 的 H2 Web 控制台来移除会话(使用 jdbc:h2:mem:testdb
作为 JDBC URL)。
现在你可以访问 localhost:8080/,并看到我们不再处于认证状态。