Spring 会话 - HttpSession（快速入门）

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

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

更新依赖项

在使用 Spring 会话之前，您必须更新依赖项。如果您使用的是 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 XML 配置

添加了必要的依赖项后，我们可以创建 Spring 配置。Spring 配置负责创建一个 servlet 过滤器，该过滤器将 HttpSession 实现替换为由 Spring 会话支持的实现。以下清单显示了如何添加以下 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 会话尚未提供 XML 命名空间支持（参见 gh-104）。这将创建一个名为 `springSessionRepositoryFilter` 的 Spring bean。该 bean 实现 `Filter`。该过滤器负责将 `HttpSession` 实现替换为由 Spring 会话支持的实现。在本例中，Spring 会话由关系型数据库支持。
2	我们创建一个 `dataSource`，它将 Spring 会话连接到嵌入式 H2 数据库实例。我们配置 H2 数据库以使用 Spring 会话中包含的 SQL 脚本创建数据库表。
3	我们创建一个 `transactionManager`，它管理先前配置的 `dataSource` 的事务。

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

XML Servlet 容器初始化

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

为了让我们的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配置。有关详细信息，请参阅Spring 文档。

最后，我们需要确保我们的 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。有关详细信息，请参阅Spring 文档。

`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/）并观察到我们添加的属性不再显示。