Spring Session - HttpSession（快速入门）
本指南介绍了如何使用 Spring Session，通过 Java 配置透明地利用 Redis 来支持 Web 应用程序的 HttpSession。
| 你可以在httpsession 示例应用程序中找到完整的指南。 |
更新依赖项
在使用 Spring Session 之前，你必须更新你的依赖项。如果你使用 Maven，你必须添加以下依赖项
<dependencies>
<!-- ... -->
<dependency>
<groupId>org.springframework.session</groupId>
<artifactId>spring-session-data-redis</artifactId>
<version>3.5.3</version>
<type>pom</type>
</dependency>
<dependency>
<groupId>io.lettuce</groupId>
<artifactId>lettuce-core</artifactId>
<version>6.5.5.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-web</artifactId>
<version>6.2.12</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)
}
}| 1 | @EnableRedisHttpSession 注解创建了一个名为 springSessionRepositoryFilter 的 Spring Bean，它实现了 Filter 接口。该过滤器负责替换 HttpSession 的实现，使其由 Spring Session 提供支持。在这种情况下，Spring Session 由 Redis 提供支持。 |
| 2 | 我们创建一个 RedisConnectionFactory，它将 Spring Session 连接到 Redis 服务器。我们将连接配置为连接到默认端口 (6379) 上的 localhost。有关配置 Spring Data Redis 的更多信息，请参阅 参考文档。 |
Java Servlet 容器初始化
我们的Spring 配置创建了一个名为 springSessionRepositoryFilter 的 Spring Bean，它实现了 Filter 接口。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。 |
| 1 | 第一步是扩展 AbstractHttpSessionApplicationInitializer。这样做可以确保名为 springSessionRepositoryFilter 的 Spring Bean 在每个请求中都注册到我们的 Servlet 容器中。 |
| 2 | 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;
}我们没有使用 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/，你会发现我们添加的属性不再显示。
