SpringBoot监听Redis的Key过期事件

短命女 2023-05-31 06:49 2阅读 0赞

### 前言 ###

redis自2.8.0之后版本提供[Keyspace Notifications][]功能，允许客户订阅Pub / Sub频道，以便以某种方式接收影响Redis数据集的事件。因为 Redis 目前的订阅与发布功能采取的是发送即忘（fire and forget）策略， 所以如果你的程序需要可靠事件通知（reliable notification of events）， 那么目前的键空间通知可能并不适合你：当订阅事件的客户端断线时， 它会丢失所有在断线期间分发给它的事件。并不能确保消息送达。

### 开启配置 ###

> \#  By default all notifications are disabled because most users don't need  
> \#  this feature and the feature has some overhead. Note that if you don't  
> \#  specify at least one of K or E, no events will be delivered.

该配置的其他信息（可以监听N多事件），可以参阅配置文件的注释，非常详细

键空间通知通常是不启用的，因为这个过程会产生额外消耗，相关配置项如下：

<table> 
 <thead> 
 <tr> 
 <th>字符</th> 
 <th>发送通知</th> 
 </tr> 
 </thead> 
 <tbody> 
 <tr> 
 <td>K</td> 
 <td>键空间通知，所有通知以&nbsp;keyspace@&nbsp;为前缀，针对Key</td> 
 </tr> 
 <tr> 
 <td>E</td> 
 <td>键事件通知，所有通知以&nbsp;keyevent@&nbsp;为前缀，针对event</td> 
 </tr> 
 <tr> 
 <td>g</td> 
 <td>DEL 、 EXPIRE 、 RENAME 等类型无关的通用命令的通知</td> 
 </tr> 
 <tr> 
 <td>$</td> 
 <td>字符串命令的通知</td> 
 </tr> 
 <tr> 
 <td>l</td> 
 <td>列表命令的通知</td> 
 </tr> 
 <tr> 
 <td>s</td> 
 <td>集合命令的通知</td> 
 </tr> 
 <tr> 
 <td>h</td> 
 <td>哈希命令的通知</td> 
 </tr> 
 <tr> 
 <td>z</td> 
 <td>有序集合命令的通知</td> 
 </tr> 
 <tr> 
 <td>x</td> 
 <td>过期事件：每当有过期键被删除时发送</td> 
 </tr> 
 <tr> 
 <td>e</td> 
 <td>驱逐(evict)事件：每当有键因为 maxmemory 政策而被删除时发送</td> 
 </tr> 
 <tr> 
 <td>A</td> 
 <td>参数 g$lshzxe 的别名，相当于是All</td> 
 </tr> 
 </tbody> 
</table>

输入的参数中至少要有一个 K 或者 E ， 否则的话， 不管其余的参数是什么， 都不会有任何通知被分发。上表中斜体的部分为通用的操作或者事件，而黑体则表示特定数据类型的操作。配置文件中修改 notify-keyspace-events “Kx”，注意：这个双引号是一定要的，否则配置不成功，启动也不报错。例如，“Kx”表示想监控某个Key的失效事件。

在redis.conf下修改配置：

notify-keyspace-events Ex

### 实现 ###

1.集成KeyExpirationEventMessageListener类重写onMessage，也可以重写其他的，比如doHandleMessage。

package com.zoo.redis.service;
    
    import lombok.extern.slf4j.Slf4j;
    import org.springframework.data.redis.connection.Message;
    import org.springframework.data.redis.listener.KeyExpirationEventMessageListener;
    import org.springframework.data.redis.listener.RedisMessageListenerContainer;
    
    import java.nio.charset.StandardCharsets;
    
    /**
     * @author: 谢飞
     */
    @Slf4j
    public class KeyExpiredListener extends KeyExpirationEventMessageListener {
    
        public KeyExpiredListener(RedisMessageListenerContainer listenerContainer) {
            super(listenerContainer);
        }
    
        @Override
        public void onMessage(Message message, byte[] pattern) {
            String channel = new String(message.getChannel(), StandardCharsets.UTF_8);
            //过期的key
            String key = new String(message.getBody(), StandardCharsets.UTF_8);
            log.info("redis key 过期：pattern={},channel={},key={}", new String(pattern), channel, key);
        }
    
    }

2.添加配置

package com.zoo.redis.config;
 
 import com.zoo.redis.service.KeyExpiredListener;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.data.redis.connection.RedisConnectionFactory;
 import org.springframework.data.redis.core.*;
 import org.springframework.data.redis.listener.RedisMessageListenerContainer;
 import org.springframework.data.redis.serializer.StringRedisSerializer;
 
 /**
 * @Author: 谢飞
 */
 @Configuration
 public class RedisConfiguration {
 
 @Autowired
 private RedisConnectionFactory factory;
 
 @Bean
 public RedisMessageListenerContainer redisMessageListenerContainer() {
 RedisMessageListenerContainer redisMessageListenerContainer = new RedisMessageListenerContainer();
 redisMessageListenerContainer.setConnectionFactory(factory);
 return redisMessageListenerContainer;
 }
 
 @Bean
 public KeyExpiredListener keyExpiredListener() {
 return new KeyExpiredListener(this.redisMessageListenerContainer());
 }
 
 
 @Bean
 public RedisTemplate<String, Object> redisTemplate() {
 RedisTemplate<String, Object> redisTemplate = new RedisTemplate<>();
 //配置连接工厂
 redisTemplate.setConnectionFactory(factory);
 
 redisTemplate.setKeySerializer(new StringRedisSerializer());
 redisTemplate.setHashKeySerializer(new StringRedisSerializer());
 redisTemplate.setHashValueSerializer(new StringRedisSerializer());
 redisTemplate.setValueSerializer(new StringRedisSerializer());
 return redisTemplate;
 }
 
 }

3.测试

![2019102313325888.png][]

[Keyspace Notifications]: https://redis.io/topics/notifications
[2019102313325888.png]: /images/20230531/386819618e334ec0a4aaa999467909f2.png