该版本仍在开发中,尚未被视为稳定。最新稳定版请使用Spring Session 3.5.3spring-doc.cadn.net.cn

春季课程 - HttpSession(快速入门)

本指南介绍了如何利用 Spring Session 透明地利用 Redis 来支持网页应用HttpSession采用基于XML的配置。spring-doc.cadn.net.cn

你可以在 httpsession-xml 示例应用中找到完成的指南。

更新依赖关系

在使用春季会话之前,您必须更新依赖。 如果你使用 Maven,必须添加以下依赖关系:spring-doc.cadn.net.cn

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

	<dependency>
		<groupId>org.springframework.session</groupId>
		<artifactId>spring-session-data-redis</artifactId>
		<version>4.0.1-SNAPSHOT</version>
		<type>pom</type>
	</dependency>
	<dependency>
		<groupId>io.lettuce</groupId>
		<artifactId>lettuce-core</artifactId>
		<version>6.8.1.RELEASE</version>
	</dependency>
	<dependency>
		<groupId>org.springframework</groupId>
		<artifactId>spring-web</artifactId>
		<version>7.0.0</version>
	</dependency>
</dependencies>

Spring XML 配置

添加所需的依赖后,我们可以创建 Spring 配置。 Spring配置负责创建一个servletFilter,以替换HttpSession实现时,Spring Session支持的实现。 为此,添加以下Spring配置:spring-doc.cadn.net.cn

src/main/webapp/WEB-INF/spring/session.xml
(1)
<context:annotation-config/>
<bean class="org.springframework.session.data.redis.config.annotation.web.http.RedisHttpSessionConfiguration"/>

(2)
<bean class="org.springframework.data.redis.connection.lettuce.LettuceConnectionFactory"/>
1 我们使用以下组合:<context:annotation-config/>RedisHttpSessionConfiguration因为 Spring Session 尚未支持 XML 命名空间(参见 gh-104)。 这会产生一种名为springSessionRepositoryFilter实现Filter. 过滤器负责更换HttpSession实施将由Spring Session支持。 这次,Spring Session 得到了 Redis 的支持。
2 我们创建一个RedisConnection工厂该连接将 Spring Session 连接到 Redis 服务器。我们将连接配置为连接到默认端口(6379)的本地主机。有关配置 Spring Data Redis 的更多信息,请参见参考文档

XML Servlet 容器初始化

我们的Spring配置创建了一个名为springSessionRepositoryFilter实现Filter. 这springSessionRepositoryFilterBean负责替换HttpSession并采用由 Spring Session 支持的自定义实现。spring-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>

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>

DelegatingFilterProxy查找一个叫springSessionRepositoryFilter并将其铸为Filter. 对于每一个请求DelegatingFilterProxy被调用时,springSessionRepositoryFilter被召唤。spring-doc.cadn.net.cn

HTTPsession-XML示例应用

本节介绍了如何与HTTPsession-XML示例应用。spring-doc.cadn.net.cn

运行HTTPsession-XML示例应用

您可以通过获取源代码并调用以下命令来运行示例:spring-doc.cadn.net.cn

为了让样本正常工作,你必须在localhost上安装Redis 2.8+,并用默认端口(6379)运行。 或者,你也可以更新RedisConnection工厂指向 Redis 服务器。另一种选择是使用 Docker 在本地主机上运行 Redis。详见 Docker Redis 仓库中的详细说明。
$ ./gradlew :spring-session-sample-xml-redis:tomcatRun

你现在应该可以在localhost:8080/访问该应用了spring-doc.cadn.net.cn

探索HTTPsession-XML示例应用

现在你可以试试用这个应用了。请填写以下信息:spring-doc.cadn.net.cn

现在点击设置属性按钮。你现在应该能在表格中看到显示的数值。spring-doc.cadn.net.cn

它是如何运作的?

我们与标准互动HttpSessionSessionServlet如下列表所示: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,我们在Redis中保持这些值。 Spring Session 会在您的浏览器中创建一个名为 SESSION 的 cookie。 这个Cookie里包含了你会话的ID。 你可以查看这些Cookie(使用ChromeFirefox)。spring-doc.cadn.net.cn

你可以用redis-cli删除会话。 例如,在基于Linux的系统上,你可以输入以下内容:spring-doc.cadn.net.cn

	$ redis-cli keys '*' | xargs redis-cli del
Redis 文档中有安装 redis-cli 的说明。

或者,你也可以删除显式密钥。作方法是在终端输入以下内容,确保替换7E8383A4-082C-4fFE-A4BC-C40FD3363C5E以您的SESSION cookie值表示:spring-doc.cadn.net.cn

	$ redis-cli del spring:session:sessions:7e8383a4-082c-4ffe-a4bc-c40fd3363c5e

现在你可以访问 localhost:8080/ 的应用程序,看到我们添加的属性已不再显示。spring-doc.cadn.net.cn