对于最新的稳定版本,请使用 Spring Session 3.5.2! |
春季会话 - 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.1.6</version>
<type>pom</type>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-web</artifactId>
<version>6.0.20</version>
</dependency>
</dependencies>
Spring XML 配置
添加所需的依赖项后,我们可以创建 Spring 配置。
Spring 配置负责创建一个 servlet 过滤器,该过滤器将HttpSession
实现,由 Spring Session 支持的实现。
以下列表显示了如何添加以下 Spring 配置:
(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 数据库的嵌入式实例。
我们使用 Spring Session 中包含的 SQL 脚本配置 H2 数据库以创建数据库表。 |
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/ 的应用程序,并观察我们添加的属性不再显示。