Spring Session - HttpSession (快速入门)

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

更新依赖项

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

pom.xml

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

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

Spring Java 配置

添加必要的依赖项后，我们可以创建 Spring 配置。Spring 配置负责创建一个 Servlet 过滤器，该过滤器将 `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 负责将 `HttpSession` 替换为由 Spring Session 支持的自定义实现。

为了让我们的 `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` 限定符，允许您明确声明应在 `JdbcIndexedSessionRepository` 中注入哪个 `DataSource` bean。这在应用程序上下文中存在多个 `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 URL 使用 `jdbc:h2:mem:testdb`）。

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