Spring Session - HttpSession（快速入门）

本指南介绍了如何使用 Spring Session 透明地利用关系型数据库通过基于 XML 的配置来支持 Web 应用程序的 HttpSession。

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

更新依赖项

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

pom.xml

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

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

Spring XML 配置

添加必要的依赖项后，我们可以创建 Spring 配置。Spring 配置负责创建一个 Servlet 过滤器，该过滤器将 HttpSession 实现替换为由 Spring Session 支持的实现。以下清单展示了如何添加以下 Spring 配置：

src/main/webapp/WEB-INF/spring/session.xml

(1)
<context:annotation-config/>
<bean class="org.springframework.session.jdbc.config.annotation.web.http.JdbcHttpSessionConfiguration"/>

(2)
<jdbc:embedded-database id="dataSource" database-name="testdb" type="H2">
	<jdbc:script location="classpath:org/springframework/session/jdbc/schema-h2.sql"/>
</jdbc:embedded-database>

(3)
<bean class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
	<constructor-arg ref="dataSource"/>
</bean>

1	我们结合使用 `<context:annotation-config/>` 和 `JdbcHttpSessionConfiguration`，因为 Spring Session 尚未提供 XML 命名空间支持（参见 gh-104）。这会创建一个名为 `springSessionRepositoryFilter` 的 Spring bean。该 bean 实现了 `Filter` 接口。该过滤器负责将 `HttpSession` 实现替换为由 Spring Session 支持的实现。在此示例中，Spring Session 由关系型数据库支持。
2	我们创建了一个 `dataSource` bean，用于将 Spring Session 连接到嵌入式 H2 数据库实例。我们配置 H2 数据库使用 Spring Session 中包含的 SQL 脚本创建数据库表。
3	我们创建了一个 `transactionManager` bean，用于管理先前配置的 `dataSource` 的事务。

有关如何配置数据访问相关内容的更多信息，请参阅 Spring Framework 参考文档。

XML Servlet 容器初始化

我们的 Spring 配置创建了一个名为 springSessionRepositoryFilter 的 Spring bean，该 bean 实现了 Filter 接口。springSessionRepositoryFilter bean 负责将 HttpSession 替换为由 Spring Session 支持的自定义实现。

为了让我们的 Filter 发挥作用，我们需要指示 Spring 加载我们的 session.xml 配置。我们通过以下配置来实现：

src/main/webapp/WEB-INF/web.xml

<context-param>
	<param-name>contextConfigLocation</param-name>
	<param-value>
		/WEB-INF/spring/session.xml
	</param-value>
</context-param>
<listener>
	<listener-class>
		org.springframework.web.context.ContextLoaderListener
	</listener-class>
</listener>

ContextLoaderListener 读取 contextConfigLocation 并加载我们的 session.xml 配置。

最后，我们需要确保我们的 Servlet 容器（例如 Tomcat）对每个请求都使用我们的 springSessionRepositoryFilter。以下代码片段为我们完成了这最后一步：

src/main/webapp/WEB-INF/web.xml

<filter>
	<filter-name>springSessionRepositoryFilter</filter-name>
	<filter-class>org.springframework.web.filter.DelegatingFilterProxy</filter-class>
</filter>
<filter-mapping>
	<filter-name>springSessionRepositoryFilter</filter-name>
	<url-pattern>/*</url-pattern>
	<dispatcher>REQUEST</dispatcher>
	<dispatcher>ERROR</dispatcher>
</filter-mapping>

DelegatingFilterProxy 查找名为 springSessionRepositoryFilter 的 bean 并将其转换为 Filter 类型。对于每个调用 DelegatingFilterProxy 的请求，都会调用 springSessionRepositoryFilter。

`httpsession-jdbc-xml` 示例应用程序

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

运行 `httpsession-jdbc-xml` 示例应用程序

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

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

您现在应该能够通过 localhost:8080/ 访问该应用程序。

探索 `httpsession-jdbc-xml` 示例应用程序

现在您可以尝试使用该应用程序。请填写以下信息：

属性名称: username
属性值: rob

现在点击设置属性按钮。您应该会看到这些值显示在表格中。

工作原理是什么？

我们在以下 SessionServlet 中与标准的 HttpSession 进行交互：

src/main/java/sample/SessionServlet.java

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/，并观察到之前添加的属性不再显示。