Spring Session - HttpSession（快速入门）

本指南介绍如何使用 Spring Session 透明地利用关系数据库来支持 Web 应用程序的 HttpSession，并使用 Java 配置。

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

更新依赖项

在使用 Spring Session 之前，您必须更新依赖项。如果您使用 Maven，则必须添加以下依赖项

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

	<dependency>
		<groupId>org.springframework.session</groupId>
		<artifactId>spring-session-jdbc</artifactId>
		<version>3.3.0</version>
		<type>pom</type>
	</dependency>
	<dependency>
		<groupId>org.springframework</groupId>
		<artifactId>spring-web</artifactId>
		<version>6.1.7</version>
	</dependency>
</dependencies>

Spring Java 配置

添加必需的依赖项后，我们可以创建 Spring 配置。Spring 配置负责创建一个 Servlet Filter，该过滤器将 HttpSession 实现替换为由 Spring Session 支持的实现。为此，请添加以下 Spring 配置

@Configuration(proxyBeanMethods = false)
@EnableJdbcHttpSession (1)
public class Config {

	@Bean
	public EmbeddedDatabase dataSource() {
		return new EmbeddedDatabaseBuilder() (2)
			.setType(EmbeddedDatabaseType.H2)
			.addScript("org/springframework/session/jdbc/schema-h2.sql")
			.build();
	}

	@Bean
	public PlatformTransactionManager transactionManager(DataSource dataSource) {
		return new DataSourceTransactionManager(dataSource); (3)
	}

}
1 @EnableJdbcHttpSession 注释创建一个名为 springSessionRepositoryFilter 的 Spring Bean。该 Bean 实现 Filter。该过滤器负责将 HttpSession 实现替换为由 Spring Session 支持的实现。在此例中，Spring Session 由关系数据库支持。
2 我们创建一个 dataSource，将 Spring Session 连接到 H2 数据库的嵌入式实例。我们配置 H2 数据库，使用 Spring Session 中包含的 SQL 脚本创建数据库表。
3 我们创建一个 transactionManager，它为先前配置的 dataSource 管理事务。

有关如何配置与数据访问相关的注意事项的更多信息，请参阅 Spring Framework 参考文档。

Java Servlet 容器初始化

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

为了让我们的 Filter 发挥作用，Spring 需要加载我们的 Config 类。最后，我们需要确保我们的 Servlet 容器（即 Tomcat）对每个请求都使用我们的 springSessionRepositoryFilter。幸运的是，Spring Session 提供了一个名为 AbstractHttpSessionApplicationInitializer 的实用程序类，可以轻松完成这两个步骤。以下示例展示了如何执行此操作

src/main/java/sample/Initializer.java
public class Initializer extends AbstractHttpSessionApplicationInitializer { (1)

	public Initializer() {
		super(Config.class); (2)
	}

}
我们的类（Initializer）的名称无关紧要。重要的是我们扩展 AbstractHttpSessionApplicationInitializer。
1 第一步是扩展 AbstractHttpSessionApplicationInitializer。这样做可确保名为 springSessionRepositoryFilter 的 Spring Bean 会在每个请求中向我们的 Servlet 容器注册。
2 AbstractHttpSessionApplicationInitializer 还提供了一种机制来确保 Spring 加载我们的 Config。

多个数据源

Spring Session 提供 @SpringSessionDataSource 限定符，允许您明确声明应将哪个 DataSource Bean 注入到 JdbcIndexedSessionRepository 中。这在应用程序上下文中存在多个 DataSource Bean 的情况下特别有用。

以下示例展示了如何执行此操作

Config.java
@EnableJdbcHttpSession
public class Config {

	@Bean
	@SpringSessionDataSource (1)
	public EmbeddedDatabase firstDataSource() {
		return new EmbeddedDatabaseBuilder()
				.setType(EmbeddedDatabaseType.H2).addScript("org/springframework/session/jdbc/schema-h2.sql").build();
	}

	@Bean
	public HikariDataSource secondDataSource() {
		// ...
	}
}
1 此限定符声明 Spring Session 将使用 firstDataSource。

httpsession-jdbc 示例应用程序

本节介绍如何使用 httpsession-jdbc 示例应用程序。

运行 httpsession-jdbc 示例应用程序

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

$ ./gradlew :spring-session-sample-javaconfig-jdbc:tomcatRun

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

探索 httpsession-jdbc 示例应用程序

现在，您可以尝试使用该应用程序。为此，请使用以下信息填写表单

  • 属性名称： username

  • 属性值： rob

现在，单击 设置属性 按钮。您现在应该看到表中显示的值。

它是如何工作的？

我们在 SessionServlet 中与标准 HttpSession 交互，如下面的清单所示

src/main/java/sample/SessionServlet.java
@WebServlet("/session")
public class SessionServlet extends HttpServlet {

	@Override
	protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws IOException {
		String attributeName = req.getParameter("attributeName");
		String attributeValue = req.getParameter("attributeValue");
		req.getSession().setAttribute(attributeName, attributeValue);
		resp.sendRedirect(req.getContextPath() + "/");
	}

	private static final long serialVersionUID = 2878267318695777395L;

}

我们没有使用 Tomcat 的 HttpSession，而是将值保留在 H2 数据库中。Spring Session 在您的浏览器中创建一个名为 SESSION 的 cookie。该 cookie 包含您的会话 ID。您可以查看 cookie（使用 Chrome 或 Firefox）。

如果您愿意，可以使用 H2 Web 控制台删除会话，该控制台可在以下位置获得：localhost:8080/h2-console/（将 jdbc:h2:mem:testdb 用于 JDBC URL）。

现在，您可以访问 localhost:8080/ 上的应用程序，并看到我们添加的属性不再显示。