Spring Session - HttpSession (快速入门)

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

更新依赖项

在使用 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>

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

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)
	}

}

1	`@EnableRedisHttpSession` 注解创建一个名为 `springSessionRepositoryFilter` 的 Spring Bean，该 Bean 实现 `Filter` 接口。该过滤器负责将 `HttpSession` 实现替换为由 Spring Session 支持的实现。在本例中，Spring Session 由 Redis 支持。
2	我们创建一个 `RedisConnectionFactory`，将 Spring Session 连接到 Redis 服务器。我们将连接配置为连接到 localhost 的默认端口 (6379)。有关配置 Spring Data Redis 的更多信息，请参阅参考文档。

Java Servlet 容器初始化

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

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

src/main/java/sample/Initializer.java

public class Initializer extends AbstractHttpSessionApplicationInitializer { (1)

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

}

我们类的名称（`Initializer`）无关紧要。重要的是我们扩展了 `AbstractHttpSessionApplicationInitializer`。

1	第一步是扩展 `AbstractHttpSessionApplicationInitializer`。这样做可以确保名为 `springSessionRepositoryFilter` 的 Spring Bean 为每个请求注册到我们的 Servlet 容器。
2	`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

现在单击**设置属性**按钮。您现在应该会看到表中显示的值。

它是如何工作的？

我们在以下列表中显示的 `SessionServlet` 中与标准 `HttpSession` 进行交互：

src/main/java/sample/SessionServlet.java

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