Spring Session - HttpSession（快速入门）

本指南介绍如何使用 Spring Session 以透明的方式利用关系型数据库来支持 Web 应用的 HttpSession，并使用基于 XML 的配置。

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

更新依赖项

在使用 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 XML 配置

添加所需的依赖项后，我们可以创建 Spring 配置。Spring 配置负责创建一个 Servlet 过滤器，该过滤器用由 Spring Session 支持的实现替换 HttpSession 实现。以下清单显示了如何添加以下 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`，将 Spring Session 连接到嵌入式 H2 数据库实例。我们配置 H2 数据库以使用 Spring Session 中包含的 SQL 脚本创建数据库表。
3	我们创建一个 `transactionManager`，管理先前配置的 `dataSource` 的事务。

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

XML Servlet 容器初始化

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

为了让我们的 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:h2:mem:testdb 用于 JDBC URL）。

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