Spring Session - HttpSession（快速入门）

本指南介绍如何使用 Spring Session 透明地利用 Redis 来支持 Web 应用程序的 HttpSession，并使用基于 XML 的配置。

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

更新依赖项

在使用 Spring Session 之前，您必须更新您的依赖项。如果您使用 Maven，则必须添加以下依赖项

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

	<dependency>
		<groupId>org.springframework.session</groupId>
		<artifactId>spring-session-data-redis</artifactId>
		<version>3.3.3</version>
		<type>pom</type>
	</dependency>
	<dependency>
		<groupId>io.lettuce</groupId>
		<artifactId>lettuce-core</artifactId>
		<version>6.3.2.RELEASE</version>
	</dependency>
	<dependency>
		<groupId>org.springframework</groupId>
		<artifactId>spring-web</artifactId>
		<version>6.1.14</version>
	</dependency>
</dependencies>

Spring XML 配置

添加所需的依赖项后，我们可以创建 Spring 配置。Spring 配置负责创建一个 servlet 过滤器，该过滤器将 HttpSession 实现替换为由 Spring Session 支持的实现。为此，请添加以下 Spring 配置

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 的 Spring Bean，该 Bean 实现 Filter。该过滤器负责替换 HttpSession 实现，使其由 Spring Session 支持。在本例中，Spring Session 由 Redis 支持。
2 我们创建一个 RedisConnectionFactory，它将 Spring Session 连接到 Redis 服务器。我们配置连接以连接到 localhost 上的默认端口 (6379)。有关配置 Spring Data Redis 的更多信息，请参阅 参考文档。

XML Servlet 容器初始化

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

为了使我们的 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 配置。

最后，我们需要确保我们的 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。

httpsession-xml 示例应用程序

本节介绍如何使用 httpsession-xml 示例应用程序。

运行 httpsession-xml 示例应用程序

您可以通过获取 源代码 并调用以下命令来运行该示例

为了使示例能够工作，您必须在 localhost 上 安装 Redis 2.8+ 并使用默认端口 (6379) 运行它。或者，您可以更新 RedisConnectionFactory 以指向 Redis 服务器。另一种选择是使用 Docker 在 localhost 上运行 Redis。有关详细说明，请参阅 Docker Redis 存储库。 
$ ./gradlew :spring-session-sample-xml-redis:tomcatRun

现在您应该能够在 localhost:8080/ 访问该应用程序

探索 httpsession-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，而是在 Redis 中持久化这些值。Spring Session 在您的浏览器中创建一个名为 SESSION 的 Cookie。该 Cookie 包含您的会话 ID。您可以查看 Cookie（使用 Chrome 或 Firefox）。

您可以使用 redis-cli 删除会话。例如，在基于 Linux 的系统上，您可以键入以下内容

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

或者，您也可以删除显式键。为此，请在终端中输入以下内容，确保将 7e8383a4-082c-4ffe-a4bc-c40fd3363c5e 替换为 SESSION Cookie 的值

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

现在您可以访问 localhost:8080/ 上的应用程序，并看到我们添加的属性不再显示。