Redis单机监听key过期事件

本文记录在Redis单机环境下，监听redis key过期并作出处理的常用方法。这种机制常见的用于某项操作，给多长时间处理，如果不处理的话，然后做什么操作。比如电商中的订单要求在30分钟内支付，否则取消订单，释放库存锁定。在这两样类似的场景下，能用redis设置一个过期时间的key, 然后又能监听过期的key就可以完美解决这种问题。

一. redis 配置开启监听

但是redis 默认本身并不开启监听过期key值这个功能的，原因是消耗CPU资源。如果要开启，首先需要在 redis.conf  中修改配置文件中的配置 默认：notify-keyspace-events "", 开启监听

notify-keyspace-events Ex

然后重启redis.

二. 应用程序开发及配置

应用程序配置，采用 springboot, 直接用的jedis, 没有用lettuce, 主要的pom配置如下

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
       <exclusions>
           <exclusion>
               <groupId>io.lettuce</groupId>
               <artifactId>lettuce-core</artifactId>
           </exclusion>
       </exclusions>
</dependency>

建立 RedisMessageListenerContainer 类

import org.springframework.context.annotation.Bean;
import org.springframework.data.redis.connection.RedisConnectionFactory;
import org.springframework.data.redis.listener.RedisMessageListenerContainer;

@Configuration
public class RedisMessageListenerContainerConfig {

    @Bean
    RedisMessageListenerContainer container(RedisConnectionFactory connectionFactory) {
        RedisMessageListenerContainer container = new RedisMessageListenerContainer();
        container.setConnectionFactory(connectionFactory);
        //ChannelTopic channelTopic = new ChannelTopic("__keyevent@0__:expired");
        //container.addMessageListener(redisTimeoutListener, channelTopic);
        return container;
    }

}

注意这里我监听的是默认DB 0上的KEY。

配置监听器 RedisTimeoutListener 类

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.data.redis.connection.Message;
import org.springframework.data.redis.connection.MessageListener;
import org.springframework.data.redis.listener.KeyExpirationEventMessageListener;
import org.springframework.data.redis.listener.RedisMessageListenerContainer;
import org.springframework.stereotype.Service;

@Service
public class RedisTimeoutListener extends KeyExpirationEventMessageListener {

    private static final Logger log = LoggerFactory.getLogger(RedisTimeoutListener.class);

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

    @Override
    public void onMessage(Message message, byte[] pattern) {

        byte[] body = message.getBody();
        byte[] channel = message.getChannel();
        String topic = new String(channel);
        String expireKey = new String(body);

        log.info("exporeKey: {}, topic: {}", expireKey, topic);
    }
}

程序编码配置完成，可以用程序或者redis 命令设置测试key值。

set testkey 123 ex 10

然后观察输出。

exporeKey: testkey, topic: __keyevent@0__:expired

一切正常。说明监听到了时间过期的key,剩下的事，就交给业务去处理。

From：一号门