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

XML Servlet 容器初始化

我们的Spring 配置创建了一个名为 springSessionRepositoryFilter 的 Spring 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 的说明。

或者，也可以删除特定的 key。为此，请在终端中输入以下命令，务必将 7e8383a4-082c-4ffe-a4bc-c40fd3363c5e 替换为你 SESSION cookie 的值

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

现在可以访问 localhost:8080/ 应用，会看到我们添加的属性不再显示了。