使用@EnableSpringWebSession

void demo() {

S toSave = this.repository.createSession(); (2)

// ...

toSave.setMaxInactiveInterval(Duration.ofSeconds(30)); (3)

this.repository.save(toSave); (4)

S session = this.repository.findById(toSave.getId()); (5)

// ...

}

// ... setter methods ...

}

1

我们创建一个带有泛型 S，扩展自 Session 的 SessionRepository 实例。泛型类型在我们类中定义。

2

我们使用我们的 SessionRepository 创建一个新的 Session 并将其赋值给一个类型为 S 的变量。

3

我们与 Session 交互。在我们的示例中，我们演示了如何更新 Session 在过期前可以处于非活动状态的时长。

4

现在我们保存 Session。这就是为什么我们需要泛型 S。SessionRepository 只允许保存使用同一个 SessionRepository 创建或检索的 Session 实例。这允许 SessionRepository 进行特定实现的优化（即只写入已更改的属性）。Session 保存时，最后访问时间会自动更新。

5

我们从 SessionRepository 检索 Session。如果 Session 已过期，结果将为 null。

使用 SessionRepository

一个 SessionRepository 负责创建、检索和持久化 Session 实例。

如果可能，您不应直接与 SessionRepository 或 Session 交互。相反，开发者应优先通过 HttpSession 和 WebSocket 集成间接与 SessionRepository 和 Session 交互。

使用 FindByIndexNameSessionRepository

Spring Session 使用 Session 最基本的 API 是 SessionRepository。这个 API 有意设计得非常简单，以便您可以轻松提供具有基本功能的额外实现。

一些 SessionRepository 实现也可能选择实现 FindByIndexNameSessionRepository。例如，Spring 的 Redis、JDBC 和 Hazelcast 支持库都实现了 FindByIndexNameSessionRepository。

FindByIndexNameSessionRepository 提供了一个方法，用于查找所有具有给定索引名称和索引值的会话。作为所有提供的 FindByIndexNameSessionRepository 实现支持的常见用例，您可以使用一个便捷方法来查找特定用户的所有会话。实现这一点的方法是，确保名称为 FindByIndexNameSessionRepository.PRINCIPAL_NAME_INDEX_NAME 的会话属性填充了用户名。您有责任确保该属性被填充，因为 Spring Session 不了解正在使用的认证机制。以下清单展示了如何使用此方法的示例

String username = "username";

this.session.setAttribute(FindByIndexNameSessionRepository.PRINCIPAL_NAME_INDEX_NAME, username);

FindByIndexNameSessionRepository 的一些实现提供了自动索引其他会话属性的钩子。例如，许多实现会自动确保当前的 Spring Security 用户名使用索引名称 FindByIndexNameSessionRepository.PRINCIPAL_NAME_INDEX_NAME 进行索引。

一旦会话被索引，您可以使用类似于以下代码的方式进行查找

String username = "username";

Map sessionIdToSession = this.sessionRepository.findByPrincipalName(username);

使用 ReactiveSessionRepository

一个 ReactiveSessionRepository 负责以非阻塞和响应式的方式创建、检索和持久化 Session 实例。

如果可能，您不应直接与 ReactiveSessionRepository 或 Session 交互。相反，您应优先通过 WebSession 集成间接与 ReactiveSessionRepository 和 Session 交互。

使用 @EnableSpringHttpSession

您可以将 @EnableSpringHttpSession 注解添加到 @Configuration 类中，以将 SessionRepositoryFilter 公开为一个名为 springSessionRepositoryFilter 的 bean。为了使用该注解，您必须提供一个单独的 SessionRepository bean。以下示例展示了如何实现

@EnableSpringHttpSession

@Configuration

public class SpringHttpSessionConfig {

@Bean

public MapSessionRepository sessionRepository() {

return new MapSessionRepository(new ConcurrentHashMap<>());

}

}

请注意，未为您配置会话过期的基础设施。这是因为会话过期等事项高度依赖于具体的实现。这意味着，如果您需要清理已过期的会话，您有责任进行清理。

使用 @EnableSpringWebSession

您可以将 @EnableSpringWebSession 注解添加到 @Configuration 类中，以将 WebSessionManager 公开为一个名为 webSessionManager 的 bean。要使用该注解，您必须提供一个单独的 ReactiveSessionRepository bean。以下示例展示了如何实现

@Configuration(proxyBeanMethods = false)

@EnableSpringWebSession

public class SpringWebSessionConfig {

@Bean

public ReactiveSessionRepository reactiveSessionRepository() {

return new ReactiveMapSessionRepository(new ConcurrentHashMap<>());

}

}

请注意，未为您配置会话过期的基础设施。这是因为会话过期等事项高度依赖于具体的实现。这意味着，如果您需要清理已过期的会话，您有责任进行清理。

使用 RedisSessionRepository

RedisSessionRepository 是一个 SessionRepository，它使用 Spring Data 的 RedisOperations 实现。在 web 环境中，这通常与 SessionRepositoryFilter 结合使用。请注意，此实现不支持发布会话事件。

实例化一个 RedisSessionRepository

以下清单展示了如何创建一个新实例的典型示例

RedisTemplate redisTemplate = new RedisTemplate<>();

// ... configure redisTemplate ...

SessionRepository repository = new RedisSessionRepository(redisTemplate);

有关如何创建 RedisConnectionFactory 的更多信息，请参阅 Spring Data Redis 参考文档。

使用 @EnableRedisHttpSession

在 web 环境中，创建新的 RedisSessionRepository 最简单的方法是使用 @EnableRedisHttpSession。您可以在 示例与指南 (由此开始) 中找到完整的示例用法。您可以使用以下属性自定义配置

enableIndexingAndEvents * enableIndexingAndEvents: 是否使用 RedisIndexedSessionRepository 而不是 RedisSessionRepository。默认值为 false。 * maxInactiveIntervalInSeconds: 会话过期前的时间量，以秒为单位。 * redisNamespace: 允许为会话配置特定于应用的命名空间。Redis 键和通道 ID 以 : 为前缀开始。 * flushMode: 允许指定何时将数据写入 Redis。默认值是仅当在 SessionRepository 上调用 save 时。FlushMode.IMMEDIATE 值表示尽快将数据写入 Redis。

自定义 RedisSerializer

您可以通过创建一个名为 springSessionDefaultRedisSerializer 并实现了 RedisSerializer