Spring Session - HttpSession（快速入门）

QWen Max 中英对照 Redis Spring Session - HttpSession (Quick Start)

本指南描述了如何使用 Spring Session 通过 Java 配置透明地利用 Redis 来支持 Web 应用程序的 HttpSession。

备注

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

Index

更新依赖项

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

<dependencies>
	<!-- ... -->

	<dependency>
		<groupId>org.springframework.session</groupId>
		<artifactId>spring-session-data-redis</artifactId>
		<version>3.4.2</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.3</version>
	</dependency>
</dependencies>

xml

由于我们使用的是SNAPSHOT版本，因此需要确保添加Spring Snapshot Maven 仓库。您的 pom.xml 文件中必须包含以下内容：

<repositories>

	<!-- ... -->

	<repository>
		<id>spring-snapshot</id>
		<url>https://repo.spring.io/libs-snapshot</url>
	</repository>
</repositories>

xml

Spring Java 配置

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

@Configuration(proxyBeanMethods = false)
@EnableRedisHttpSession 1
public class Config {

	@Bean
	public LettuceConnectionFactory connectionFactory() {
		return new LettuceConnectionFactory(); 2
	}

}

java

• @EnableRedisHttpSession 注解创建了一个名为 springSessionRepositoryFilter 的 Spring Bean，该 Bean 实现了 Filter。过滤器负责将 HttpSession 实现替换为由 Spring Session 支持的实现。在这种情况下，Spring Session 由 Redis 支持。

• 我们创建了一个 RedisConnectionFactory，它将 Spring Session 连接到 Redis 服务器。我们配置连接以默认端口（6379）连接到本地主机。有关配置 Spring Data Redis 的更多信息，请参阅参考文档。

Java Servlet 容器初始化

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

为了让我们的 Filter 发挥作用，Spring 需要加载我们的 Config 类。最后，我们需要确保我们的 Servlet 容器（即 Tomcat）对每个请求都使用我们的 springSessionRepositoryFilter。幸运的是，Spring Session 提供了一个名为 AbstractHttpSessionApplicationInitializer 的工具类，使这两个步骤变得简单。以下是一个示例：

public class Initializer extends AbstractHttpSessionApplicationInitializer { 1

	public Initializer() {
		super(Config.class); 2
	}

}

java

备注

我们类的名称（Initializer）并不重要。重要的是我们继承了 AbstractHttpSessionApplicationInitializer。

• 第一步是扩展 AbstractHttpSessionApplicationInitializer。这样做可以确保名为 springSessionRepositoryFilter 的 Spring Bean 在每次请求时都注册到我们的 Servlet 容器中。

• AbstractHttpSessionApplicationInitializer 还提供了一种机制，以确保 Spring 加载我们的 Config。

httpsession 示例应用程序

运行 httpsession 示例应用程序

你可以通过获取源代码并运行以下命令来运行示例：

$ ./gradlew :spring-session-sample-javaconfig-redis:tomcatRun

备注

为了让示例正常工作，您必须在本地主机上安装 Redis 2.8+，并使用默认端口（6379）运行它。或者，您可以更新 RedisConnectionFactory 以指向一个 Redis 服务器。另一个选项是使用 Docker 在本地主机上运行 Redis。有关详细说明，请参阅 Docker Redis 仓库。

你现在应该能够访问 localhost:8080/ 上的应用程序了。

探索 httpsession 示例应用程序

现在你可以尝试使用该应用程序。为此，请用以下信息填写表单：

• 属性名称: username

• 属性值: rob

现在点击 设置属性 按钮。你应该可以在表格中看到显示的值。

它是如何工作的？

我们在下面列出的 SessionServlet 中与标准的 HttpSession 进行交互：

@WebServlet("/session")
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;

}

java

而不是使用 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/，并看到我们添加的属性不再显示。