键通知配置主要是为了监听redis键的各种状态:过期、删除等命令,如果有这种业务需求,就需要通过以下配置开启键通知配置。
Redis设置
因为开启键通知功能需要消耗一些CPU,所以默认情况下该功能是关闭的。
查看键通知配置
config get notify-keyspace-events
开启键通知配置
临时修改
注意:redis重启配置会还原
config set notify-keyspace-events "Ex"
永久修改
redis.conf配置文件新增如下配置:
notify-keyspace-events Ex
设置的字符含义如下:
字符 | 发送的通知 |
---|---|
K | 键空间通知,所有通知以 keyspace@ 为前缀 |
E | 键事件通知,所有通知以__keyevent@__为前缀 |
g | del、expire、rename 等类型无关的通用命令的通知 |
$ | string命令的通知 |
l | list命令的通知 |
s | set命令的通知 |
h | hash命令的通知 |
z | zset命令的通知 |
x | 过期事件:每当有过期键被删除时发送 |
e | 驱逐(evict)事件:每当有键因为 maxmemory 政策而被删除时发送 |
A | 参数 g$lshzxe 的别名 |
根据含义可知,上面命令就是:打开键过期的事件通知。
Springboot业务应用
前提:redis打开键通知开关
场景
监控指定redis库的key失效事件,redis-key失效时执行相关业务逻辑。
编码
新增类,需继承KeyExpirationEventMessageListener
@Component
@Slf4j
public class RedisKeyBasicExpirationListener
extends KeyExpirationEventMessageListener {
// 当前服务连接的redis库序列号
@Value("${spring.redis.database}")
private Integer database;
public RedisKeyBasicExpirationListener(
RedisMessageListenerContainer listenerContainer) {
super(listenerContainer);
}
// 指定监听数据库
@Override
protected void doRegister(RedisMessageListenerContainer listenerContainer) {
listenerContainer
.addMessageListener(
this, new PatternTopic("__keyevent@" + database + "__:expired")
);
}
@Override
public void onMessage(Message message, byte[] pattern) {
// 业务逻辑执行
}
}
注意:KeyExpirationEventMessageListener类默认是监听redis所有库的失效事件,如果想监听所有库,那就删除doRegister()方法,否则,需要加上doRegister()方法进行redis库指定。