此版本仍在开发中,尚未被视为稳定版本。对于最新的稳定版本,请使用 Spring Session 3.4.2! |
Spring Session - HttpSession(快速入门)
本指南描述了如何使用 Spring Session 透明地利用关系来支持 Web 应用程序的HttpSession
使用基于 XML 的配置。
您可以在 httpsession-jdbc-xml 示例应用程序中找到完整的指南。 |
更新依赖项
在使用 Spring Session 之前,您必须更新依赖项。 如果您使用的是 Maven,则必须添加以下依赖项:
<dependencies>
<!-- ... -->
<dependency>
<groupId>org.springframework.session</groupId>
<artifactId>spring-session-jdbc</artifactId>
<version>3.4.3-SNAPSHOT</version>
<type>pom</type>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-web</artifactId>
<version>6.2.4</version>
</dependency>
</dependencies>
Spring XML 配置
添加所需的依赖项后,我们可以创建 Spring 配置。
Spring 配置负责创建一个 servlet 过滤器,该过滤器将HttpSession
implementation 替换为 Spring Session 支持的 implementation。
下面的清单显示了如何添加以下 Spring Configuration:
(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 .
该 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
实现Filter
.
这springSessionRepositoryFilter
bean 负责替换HttpSession
使用由 Spring Session 支持的自定义实现。
为了我们的Filter
为了发挥它的魔力,我们需要指示 Spring 加载我们的session.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
对于每个请求。
以下代码片段为我们执行了最后一步:
<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
并将其转换为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
现在单击 Set Attribute 按钮。您现在应该会看到表中显示的值。
它是如何工作的?
我们与标准HttpSession
在以下SessionServlet
:
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 包含会话的 ID。
您可以查看 Cookie(使用 Chrome 或 Firefox)。
您可以使用 H2 Web 控制台删除会话,网址为:localhost:8080/h2-console/(使用jdbc:h2:mem:testdb
对于 JDBC URL)
现在,您可以在 localhost:8080/ 上访问应用程序,并观察到我们添加的属性不再显示。