跳到主要内容
版本：4.1.1

Spring Session - HttpSession（快速入门）

Doubao 中英对照 Spring Session - HttpSession (Quick Start)

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

备注

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

更新依赖​

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

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

	<dependency>
		<groupId>org.springframework.session</groupId>
		<artifactId>spring-session-data-redis</artifactId>
		<version>4.1.1</version>
		<type>pom</type>
	</dependency>
	<dependency>
		<groupId>io.lettuce</groupId>
		<artifactId>lettuce-core</artifactId>
		<version>6.8.2.RELEASE</version>
	</dependency>
	<dependency>
		<groupId>org.springframework</groupId>
		<artifactId>spring-web</artifactId>
		<version>7.0.9</version>
	</dependency>
</dependencies>

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

<repositories>

	<!-- ... -->

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

Spring Java 配置​

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

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

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

}

  • @EnableRedisHttpSession 注解创建一个名为 springSessionRepositoryFilter、实现 Filter 的 Spring Bean。该过滤器负责将 HttpSession 实现替换为由 Spring Session 支撑。在本例中，Spring Session 由 Redis 支撑。

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

Java Servlet 容器初始化​

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

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

public class Initializer extends AbstractHttpSessionApplicationInitializer { 1

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

}
备注

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

  • 第一步是扩展 AbstractHttpSessionApplicationInitializer。这样做确保名为 springSessionRepositoryFilter 的 Spring Bean 被注册到我们的 Servlet 容器中，对每个请求都生效。

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

httpsession 示例应用程序​

运行 httpsession 示例应用程序​

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

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

要使示例正常工作，你必须在 localhost 上安装 Redis 2.8+ 并以默认端口（6379）运行。或者，你可以更新 RedisConnectionFactory 以指向 Redis 服务器。另一个选择是使用 Docker 在 localhost 上运行 Redis。详细说明请参阅 Docker Redis 仓库。

现在你应该可以通过 localhost:8080/ 访问该应用程序了。

探索 httpsession 示例应用程序​

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

  • 属性名称： username
  • 属性值： rob

现在点击 Set Attribute 按钮。你现在应该能在表格中看到显示的值。

它是如何工作的？​

我们在以下清单所示的 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;

}

我们没有使用 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/ 上的应用程序，并看到我们添加的属性不再显示。