响应式 Redis 索引配置

要开始使用 Redis 索引 Web Session 支持，您需要将以下依赖项添加到您的项目中

  • Maven

  • Gradle

<dependency>
    <groupId>org.springframework.session</groupId>
    <artifactId>spring-session-data-redis</artifactId>
</dependency>
implementation 'org.springframework.session:spring-session-data-redis'

并将@EnableRedisIndexedWebSession 注解添加到配置类中

@Configuration
@EnableRedisIndexedWebSession
public class SessionConfig {
    // ...
}

就是这样。您的应用程序现在具有由 Redis 支持的响应式索引 Web Session 支持。现在您已经配置了应用程序，您可能想要开始自定义一些内容

使用 JSON 序列化会话

默认情况下，Spring Session Data Redis 使用 Java 序列化来序列化会话属性。有时这可能会出现问题，尤其是在您有多个应用程序使用相同的 Redis 实例但具有不同版本的同一类时。您可以提供一个RedisSerializer bean 来自定义会话如何序列化到 Redis 中。Spring Data Redis 提供了GenericJackson2JsonRedisSerializer，它使用 Jackson 的ObjectMapper 来序列化和反序列化对象。

配置 RedisSerializer
@Configuration
public class SessionConfig implements BeanClassLoaderAware {

	private ClassLoader loader;

	/**
	 * Note that the bean name for this bean is intentionally
	 * {@code springSessionDefaultRedisSerializer}. It must be named this way to override
	 * the default {@link RedisSerializer} used by Spring Session.
	 */
	@Bean
	public RedisSerializer<Object> springSessionDefaultRedisSerializer() {
		return new GenericJackson2JsonRedisSerializer(objectMapper());
	}

	/**
	 * Customized {@link ObjectMapper} to add mix-in for class that doesn't have default
	 * constructors
	 * @return the {@link ObjectMapper} to use
	 */
	private ObjectMapper objectMapper() {
		ObjectMapper mapper = new ObjectMapper();
		mapper.registerModules(SecurityJackson2Modules.getModules(this.loader));
		return mapper;
	}

	/*
	 * @see
	 * org.springframework.beans.factory.BeanClassLoaderAware#setBeanClassLoader(java.lang
	 * .ClassLoader)
	 */
	@Override
	public void setBeanClassLoader(ClassLoader classLoader) {
		this.loader = classLoader;
	}

}

上面的代码片段使用了 Spring Security，因此我们正在创建一个自定义的ObjectMapper，它使用 Spring Security 的 Jackson 模块。如果您不需要 Spring Security Jackson 模块，您可以注入应用程序的ObjectMapper bean 并像这样使用它

@Bean
public RedisSerializer<Object> springSessionDefaultRedisSerializer(ObjectMapper objectMapper) {
    return new GenericJackson2JsonRedisSerializer(objectMapper);
}

RedisSerializer bean 的名称必须是springSessionDefaultRedisSerializer，这样它才不会与 Spring Data Redis 使用的其他RedisSerializer bean 冲突。如果提供不同的名称，Spring Session 将不会拾取它。

指定不同的命名空间

有多个应用程序使用相同的 Redis 实例，或者想要将会话数据与存储在 Redis 中的其他数据分开，这并不少见。出于这个原因，Spring Session 使用一个namespace（默认为spring:session）来根据需要将会话数据分开。

您可以通过在@EnableRedisIndexedWebSession 注解中设置redisNamespace 属性来指定namespace

指定不同的命名空间
@Configuration
@EnableRedisIndexedWebSession(redisNamespace = "spring:session:myapplication")
public class SessionConfig {
    // ...
}

了解 Spring Session 如何清理过期会话

Spring Session 依赖于Redis 密钥空间事件来清理过期会话。更具体地说，它监听发送到__keyevent@*__:expired和__keyevent@*__:del通道的事件，并根据被销毁的键解析会话 ID。

例如，假设我们有一个 ID 为1234的会话，并且该会话设置为在 30 分钟后过期。当达到过期时间时，Redis 将向__keyevent@*__:expired通道发送一个事件，消息为spring:session:sessions:expires:1234，这是过期的键。然后，Spring Session 将从键中解析会话 ID (1234)，并从 Redis 中删除所有相关的会话键。

仅依赖 Redis 过期的一个问题是，如果未访问密钥，Redis 无法保证何时触发过期事件。有关更多详细信息，请参阅 Redis 文档中的Redis 如何使密钥过期。为了避免过期事件并非一定发生的这一事实，我们可以确保在预期密钥过期时访问每个密钥。这意味着如果密钥的 TTL 已过期，当我们尝试访问密钥时，Redis 将删除密钥并触发过期事件。出于这个原因，每个会话过期也通过按其过期时间排序的排序集中存储会话 ID 来跟踪。这允许后台任务访问可能已过期的会话，以确保以更确定性的方式触发 Redis 过期事件。例如

ZADD spring:session:sessions:expirations "1.702402961162E12" "648377f7-c76f-4f45-b847-c0268bb48381"

我们不会显式删除密钥，因为在某些情况下可能存在竞争条件，会在密钥未过期时将其错误地识别为已过期。除了使用分布式锁（这会降低我们的性能）之外，没有办法确保过期映射的一致性。通过简单地访问密钥，我们确保只有当该密钥上的 TTL 已过期时才会删除密钥。

默认情况下，Spring Session 每 60 秒将检索最多 100 个过期会话。如果您想配置清理任务运行的频率，请参阅更改会话清理频率部分。

配置 Redis 以发送密钥空间事件

默认情况下，Spring Session 尝试使用ConfigureNotifyKeyspaceEventsReactiveAction配置 Redis 以发送密钥空间事件，该操作反过来可能会将notify-keyspace-events配置属性设置为Egx。但是，如果 Redis 实例已正确保护，则此策略将不起作用。在这种情况下，应在外部配置 Redis 实例，并应公开类型为ConfigureReactiveRedisAction.NO_OP的 Bean 以禁用自动配置。

@Bean
public ConfigureReactiveRedisAction configureReactiveRedisAction() {
    return ConfigureReactiveRedisAction.NO_OP;
}

更改会话清理频率

根据您的应用程序的需求，您可能想要更改会话清理的频率。为此，您可以公开一个ReactiveSessionRepositoryCustomizer<ReactiveRedisIndexedSessionRepository> bean 并设置cleanupInterval属性

@Bean
public ReactiveSessionRepositoryCustomizer<ReactiveRedisIndexedSessionRepository> reactiveSessionRepositoryCustomizer() {
    return (sessionRepository) -> sessionRepository.setCleanupInterval(Duration.ofSeconds(30));
}

您还可以设置调用disableCleanupTask()来禁用清理任务。

@Bean
public ReactiveSessionRepositoryCustomizer<ReactiveRedisIndexedSessionRepository> reactiveSessionRepositoryCustomizer() {
    return (sessionRepository) -> sessionRepository.disableCleanupTask();
}

控制清理任务

有时，默认清理任务可能不足以满足您的应用程序的需求。您可能想要采用不同的策略来清理过期会话。由于您知道会话 ID 存储在键spring:session:sessions:expirations下的排序集中，并按其过期时间排序，您可以禁用默认清理任务并提供您自己的策略。例如

@Component
public class SessionEvicter {

    private ReactiveRedisOperations<String, String> redisOperations;

    @Scheduled
    public Mono<Void> cleanup() {
        Instant now = Instant.now();
        Instant oneMinuteAgo = now.minus(Duration.ofMinutes(1));
        Range<Double> range = Range.closed((double) oneMinuteAgo.toEpochMilli(), (double) now.toEpochMilli());
        Limit limit = Limit.limit().count(1000);
        return this.redisOperations.opsForZSet().reverseRangeByScore("spring:session:sessions:expirations", range, limit)
                // do something with the session ids
                .then();
    }

}

监听会话事件

通常，对会话事件做出反应非常有价值，例如，您可能希望根据会话生命周期执行某种类型的处理。

您可以配置您的应用程序以监听SessionCreatedEvent、SessionDeletedEvent和SessionExpiredEvent事件。在 Spring 中有几种监听应用程序事件的方法，在此示例中，我们将使用@EventListener注解。

@Component
public class SessionEventListener {

    @EventListener
    public Mono<Void> processSessionCreatedEvent(SessionCreatedEvent event) {
        // do the necessary work
    }

    @EventListener
    public Mono<Void> processSessionDeletedEvent(SessionDeletedEvent event) {
        // do the necessary work
    }

    @EventListener
    public Mono<Void> processSessionExpiredEvent(SessionExpiredEvent event) {
        // do the necessary work
    }

}