spring boot+redis 监听过期Key的操作方法

以下是“Spring Boot+Redis监听过期Key的操作方法”的完整攻略，包含两个示例说明。

简介

在Spring Boot中，我们可以使用Redis的Key过期事件来实现一些特定的业务逻辑。例如，我们可以在Key过期时自动删除相关的缓存数据，或者在Key过期时发送通知消息等。

示例1：使用RedisTemplate监听过期Key

以下是一个使用RedisTemplate监听过期Key的示例：

1. 配置RedisTemplate

首先，我们需要配置RedisTemplate来支持Key过期事件的监听。在RedisConfig类中添加以下配置：

@Configuration
public class RedisConfig {

    @Bean
    public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory redisConnectionFactory) {
        RedisTemplate<String, Object> redisTemplate = new RedisTemplate<>();
        redisTemplate.setConnectionFactory(redisConnectionFactory);
        redisTemplate.setKeySerializer(new StringRedisSerializer());
        redisTemplate.setValueSerializer(new GenericJackson2JsonRedisSerializer());
        redisTemplate.afterPropertiesSet();
        return redisTemplate;
    }

    @Bean
    public RedisMessageListenerContainer redisMessageListenerContainer(RedisConnectionFactory redisConnectionFactory) {
        RedisMessageListenerContainer container = new RedisMessageListenerContainer();
        container.setConnectionFactory(redisConnectionFactory);
        return container;
    }
}

在这个示例中，我们使用RedisTemplate来连接Redis服务器，并设置Key和Value的序列化方式。我们还创建了一个RedisMessageListenerContainer来监听Key过期事件。

2. 监听Key过期事件

在需要监听Key过期事件的地方，使用@Component注解创建一个监听器：

@Component
public class RedisKeyExpirationListener extends KeyExpirationEventMessageListener {

    public RedisKeyExpirationListener(RedisMessageListenerContainer listenerContainer) {
        super(listenerContainer);
    }

    @Override
    public void onMessage(Message message, byte[] pattern) {
        String expiredKey = message.toString();
        System.out.println("Key expired: " + expiredKey);
        // TODO: 处理Key过期事件
    }
}

在这个示例中，我们创建了一个RedisKeyExpirationListener类，继承自KeyExpirationEventMessageListener，并重写了onMessage方法来处理Key过期事件。在onMessage方法中，我们可以获取到过期的Key，并进行相应的业务逻辑处理。

3. 运行示例

现在，您可以运行应用程序，并在Redis中设置一个过期时间为10秒的Key：

redisTemplate.opsForValue().set("myKey", "myValue", 10, TimeUnit.SECONDS);

在Key过期时，RedisKeyExpirationListener类的onMessage方法将被调用，并输出Key expired: myKey的日志信息。

示例2：使用注解监听过期Key

以下是一个使用注解监听过期Key的示例：

1. 配置RedisTemplate

首先，我们需要配置RedisTemplate来支持Key过期事件的监听。在RedisConfig类中添加以下配置：

@Configuration
public class RedisConfig {

    @Bean
    public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory redisConnectionFactory) {
        RedisTemplate<String, Object> redisTemplate = new RedisTemplate<>();
        redisTemplate.setConnectionFactory(redisConnectionFactory);
        redisTemplate.setKeySerializer(new StringRedisSerializer());
        redisTemplate.setValueSerializer(new GenericJackson2JsonRedisSerializer());
        redisTemplate.afterPropertiesSet();
        return redisTemplate;
    }

    @Bean
    public RedisMessageListenerContainer redisMessageListenerContainer(RedisConnectionFactory redisConnectionFactory) {
        RedisMessageListenerContainer container = new RedisMessageListenerContainer();
        container.setConnectionFactory(redisConnectionFactory);
        return container;
    }

    @Bean
    public RedisKeyExpirationListener redisKeyExpirationListener() {
        return new RedisKeyExpirationListener();
    }
}

在这个示例中，我们使用RedisTemplate来连接Redis服务器，并设置Key和Value的序列化方式。我们还创建了一个RedisMessageListenerContainer来监听Key过期事件，并创建了一个RedisKeyExpirationListener类来处理Key过期事件。

2. 监听Key过期事件

在需要监听Key过期事件的地方，使用@RedisKeyExpired注解创建一个监听器：

@Component
public class MyRedisKeyExpirationListener {

    @RedisKeyExpired("myKey")
    public void onMyKeyExpired() {
        System.out.println("myKey expired");
        // TODO: 处理Key过期事件
    }
}

在这个示例中，我们创建了一个MyRedisKeyExpirationListener类，并使用@RedisKeyExpired注解来监听myKey过期事件。在onMyKeyExpired方法中，我们可以进行相应的业务逻辑处理。

3. 运行示例

现在，您可以运行应用程序，并在Redis中设置一个过期时间为10秒的Key：

redisTemplate.opsForValue().set("myKey", "myValue", 10, TimeUnit.SECONDS);

在Key过期时，MyRedisKeyExpirationListener类的onMyKeyExpired方法将被调用，并输出myKey expired的日志信息。