此版本仍在开发中,尚未被认为是稳定的。请使用最新的稳定版本 Spring Session 4.0.2spring-doc.cadn.net.cn

Spring Session - HttpSession (快速入门)

此指南描述了如何使用Spring Session来透明地利用关系型数据库为基于Web的应用程序的HttpSession提供支持,并通过基于XML的配置实现。spring-doc.cadn.net.cn

您可以在httpsession-jdbc-xml 样本应用中找到完整的指南。

更新依赖项

在使用Spring Session之前,您必须更新您的依赖项。 如果您使用的是Maven,您需要添加以下依赖项:spring-doc.cadn.net.cn

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

	<dependency>
		<groupId>org.springframework.session</groupId>
		<artifactId>spring-session-jdbc</artifactId>
		<version>4.1.0-SNAPSHOT</version>
		<type>pom</type>
	</dependency>
	<dependency>
		<groupId>org.springframework</groupId>
		<artifactId>spring-web</artifactId>
		<version>7.0.4</version>
	</dependency>
</dependencies>

Spring XML 配置

添加所需的依赖项后,我们可以创建我们的 Spring 配置。 Spring 配置负责创建一个 servlet 过滤器,该过滤器用基于 Spring Session 的实现替换 HttpSession 实现。 以下示例显示了如何添加以下 Spring 配置:spring-doc.cadn.net.cn

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数据库实例。 我们通过使用Spring Session中包含的SQL脚本来配置H2数据库以创建数据库表。
3 我们创建一个transactionManager来管理之前配置好的dataSource的事务。

对于如何配置数据访问相关的设置的更多信息,请参阅 Spring 框架参考文档spring-doc.cadn.net.cn

XML Servlet 容器初始化

我们的Spring Configuration创建了一个名为springSessionRepositoryFilter的Spring Bean,该Bean实现了FilterspringSessionRepositoryFilter Bean负责用一个由Spring Session支持的自定义实现来替换HttpSessionspring-doc.cadn.net.cn

为了使我们的Filter能够发挥作用,我们需要指示Spring加载我们的session.xml配置。 我们通过以下配置来实现这一点:spring-doc.cadn.net.cn

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>

The ContextLoaderListener 读取 contextConfigLocation 并加载我们的 session.xml 配置文件。spring-doc.cadn.net.cn

最后,我们需要确保我们的Servlet容器(即Tomcat)为每个请求使用我们的springSessionRepositoryFilter。 以下片段为我们执行这一步骤:spring-doc.cadn.net.cn

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>

The DelegatingFilterProxy 会查找名为 springSessionRepositoryFilter 的 Bean,并将其转换为 Filter 类型。 对于每次调用 DelegatingFilterProxy 的请求,都会触发 springSessionRepositoryFilter 的调用。spring-doc.cadn.net.cn

httpsession-jdbc-xml示例应用程序

此部分描述了如何使用httpsession-jdbc-xml示例应用程序。spring-doc.cadn.net.cn

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

您可以运行示例程序,通过获取源代码并执行以下命令来实现:spring-doc.cadn.net.cn

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

您应该能够通过以下地址访问应用:localhost:8080/spring-doc.cadn.net.cn

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

现在您可以尝试使用该应用程序。为此,请填写以下信息:spring-doc.cadn.net.cn

现在点击设置属性按钮。你应该会在表格中看到这些值。spring-doc.cadn.net.cn

它是如何工作的?

我们将在以下SessionServlet中与标准HttpSession进行交互:spring-doc.cadn.net.cn

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(使用 ChromeFirefox)。spring-doc.cadn.net.cn

您可以使用在以下地址可用的H2 web控制台来移除会话:localhost:8080/h2-console/(对于JDBC URL,请使用jdbc:h2:mem:testdbspring-doc.cadn.net.cn

现在您可以访问应用程序,地址为 http://localhost:8080/,并观察到我们添加的属性不再显示。spring-doc.cadn.net.cn