中文站的 REDIS notifications -- Redis中国用户组(CRUG)
功能概述
键空间通知允许客户端订阅发布/订阅频道,以便以某种方式接收影响Redis数据集的事件。
可能接收的事件示例如下:
- 所有影响给定键的命令。
- 所有接收LPUSH操作的键。
- 所有在数据库0中到期的键。
事件使用Redis的普通发布/订阅层传递,因此实现了发布/订阅的客户端无需修改即可使用此功能。
由于Redis的发布/订阅是fire and forget,因此如果你的应用要求可靠的事件通知,目前还不能使用这个功能,也就是说,如果你的发布/订阅客户端断开连接,并在稍后重连,那么所有在客户端断开期间发送的事件将会丢失。
将来有计划允许更可靠的事件传递,但可能会在更一般的层面上解决,要么为发布/订阅本身带来可靠性,要么允许Lua脚本拦截发布/订阅的消息以执行推送等操作,就像往队列里推送事件一样。
事件类型
键空间通知的实现是为每一个影响Redis数据空间的操作发送两个不同类型的事件。例如,在数据库0
中名为mykey
的键上执行DEL
操作,将触发两条消息的传递,完全等同于下面两个PUBLISH
命令:
1. PUBLISH __keyspace@0__:mykey del 2. PUBLISH __keyevent@0__:del mykey
以上很容易看到,一个频道允许监听所有以键mykey
为目标的所有事件,以及另一个频道允许获取有关所有DEL
操作目标键的信息。
第一种事件,在频道中使用keyspace
前缀的被叫做键空间通知,第二种,使用keyevent
前缀的,被叫做键事件通知。
在以上例子中,为键mykey
生成了一个del
事件。 会发生什么:
- 键空间频道接收到的消息是事件的名称。
- 键事件频道接收到的消息是键的名称。
可以只启用其中一种通知,以便只传递我们感兴趣的事件子集。
配置
默认情况下,键空间事件通知是不启用的,因为虽然不太明智,但该功能会消耗一些CPU。可以使用redis.conf中的notify-keyspace-events
或者使用CONFIG SET命令来开启通知。
将参数设置为空字符串会禁用通知。 为了开启通知功能,使用了一个非空字符串,由多个字符组成,每一个字符都有其特殊的含义,具体参见下表:
1. K 键空间事件,以__keyspace@<db>__前缀发布。 2. E 键事件事件,以__keyevent@<db>__前缀发布。 3. g 通用命令(非类型特定),如DEL,EXPIRE,RENAME等等 4. $ 字符串命令 5. l 列表命令 6. s 集合命令 7. h 哈希命令 8. z 有序集合命令 9. x 过期事件(每次键到期时生成的事件) 10. e 被驱逐的事件(当一个键由于达到最大内存而被驱逐时产生的事件) 11. A g$lshzxe的别名,因此字符串AKE表示所有的事件。
字符串中应当至少存在K
或者E
,否则将不会传递事件,不管字符串中其余部分是什么。
例如,要为列表开启键空间事件,则配置参数必须设置为Kl
,以此类推。
字符串KEA
可以用于开启所有可能的事件。
不同的命令生成的事件
根据以下列表,不同的命令产生不同种类的事件。
DEL
命令为每一个删除的key生成一个del
事件。RENAME
生成两个事件,一个是为源key生成的rename_from
事件,一个是为目标key生成的rename_to
事件。
EXPIRE
在给一个键设置有效期时,会生成一个expire
事件,或者每当设置有效期导致键被删除时,生成expired
事件(请查阅EXPIRE
文档以获取更多信息)。SORT
会在使用STORE
选项将结果存储到新键时,生成一个sortstore
事件。如果结果列表为空,且使用了STORE
选项,并且已经存在具有该名称的