Spring Session

Rob Winch; Vedran Pavić; Jay Bryant; Eleftheria Stein-Kousathana

Spring Session 提供 API 和实现来管理用户的会话信息。

Spring Session 提供 API 和实现来管理用户的会话信息,同时可以轻松支持集群会话,且不受特定应用容器解决方案的限制。它还提供与以下各项的透明集成:

  • HttpSession:允许以应用容器无关的方式替换 HttpSession,支持在头部提供会话 ID,以便与 RESTful API 协作。

  • WebSocket:提供在接收 WebSocket 消息时保持 HttpSession 活跃的能力

  • WebSession:允许以应用容器无关的方式替换 Spring WebFlux 的 WebSession

理解 Spring Session 解决的问题

当用户与 Web 应用交互时,服务器会创建一个会话来跟踪用户的活动。此会话可能存储用户信息,例如用户偏好、登录状态和购物车内容。然而,会话在分布式环境中可能会出现问题,因为它们通常存储在服务器的内存中。

为了更好地理解 Spring Session 解决的问题,让我们首先看下面的图表

In-Memory Sessions
图 1. 内存会话

在上图中,每个 Spring 应用将其会话存储在一个只有自身可以访问的地方,通常在服务器的内存中,但这在分布式环境中可能会成为问题。想象一下,如果 Spring 应用 #2 收到一个带有会话 #3 的请求,该应用将无法读取会话数据,因为它存储在 Spring 应用 #1 的内存中。为了解决这个问题,我们需要实现某种共享会话存储,如下图所示

Shared Session Storage
图 2. 共享会话存储

通过上述设置,拥有会话存储访问权限的每个应用都可以访问会话。

Spring Session 在应用和会话管理之间提供了一个抽象层。它允许将会话数据存储在各种持久化存储中,例如关系型数据库、NoSQL 数据库等。

使用 Spring Session,无论使用何种持久化存储,您都可以使用相同的 API 来管理会话。这使得在不同存储之间切换变得更容易,而无需更改应用代码。Spring Session 还提供会话过期和不同 Web 应用之间的跨上下文通信等功能。

总而言之,Spring Session 简化了 Web 应用中的用户会话管理,让您可以更轻松地专注于构建应用的核心功能。

以下是一些 Spring Session 的常见用例

  • 分布式 Web 应用:如果您有一个分布式部署在多台服务器上的 Web 应用,管理用户会话可能会很困难。Spring Session 可以通过将会话数据存储在共享数据库或 Redis 中来提供帮助,从而允许所有服务器访问和更新会话数据。

  • 会话可伸缩性:在拥有大量并发用户的大型 Web 应用中,将会话存储在服务器内存中可能会导致可伸缩性问题。Spring Session 允许您将会话数据存储在持久化存储中,从而提高可伸缩性并降低内存溢出错误的风险。

  • 会话备份与恢复:将会话数据存储在持久化存储中还可以提供一种机制,用于在服务器故障或停机时备份和恢复会话数据。

Spring Session 社区

我们很高兴将您视为我们社区的一份子。以下部分提供了关于如何与 Spring Session 社区互动的额外信息。

支持

您可以在 在 Stack Overflow 上使用 spring-session 标签提问 来获得帮助。同样,我们也鼓励您通过回答 Stack Overflow 上的问题来帮助他人。

源代码

您可以在 GitHub 上找到源代码:github.com/spring-projects/spring-session/

问题追踪

我们在 GitHub issues 上追踪问题:github.com/spring-projects/spring-session/issues

贡献

许可证

Spring Session 是根据 Apache 2.0 许可证发布的开源软件。

社区扩展

名称 位置

Spring Session Infinispan

infinispan.org/docs/stable/titles/spring/spring.html

Spring Session Caffeine

github.com/gotson/spring-session-caffeine

最低要求

Spring Session 的最低要求是:

  • Java 17+。

  • 如果您在 Servlet 容器中运行(非必需),需要 Servlet 3.1+。

  • 如果您使用其他 Spring 库(非必需),最低版本要求是 Spring 6.0.x。

  • @EnableRedisHttpSession 需要 Redis 2.8+。这是支持会话过期所必需的

  • @EnableHazelcastHttpSession 需要 Hazelcast 3.6+。这是支持 FindByIndexNameSessionRepository 所必需的

核心而言,Spring Session 仅强制依赖于 spring-jcl。有关在不依赖任何其他 Spring 依赖项的情况下使用 Spring Session 的示例,请参阅 hazelcast 示例应用。