Redis的Keyspace notifications功能初探

By | 2018年12月6日

最近在做一套系统,其中要求若干个Worker服务器将心跳信息都上报给中央服务器。当一定时间中央服务器没有得到心跳信息时则认为该Worker失效了,发出告警。

满足这种需求的解决方法多种多样,我开始想到了memcache,上报一次心跳信息就刷新一次缓存,当缓存内心跳信息对象超时被删除,即认为对应的Worker失效。然而由于memcache的工作原理,删除都是被动的,我们无法及时判断数据是否过期,即便知道了数据过期,也没有一种机制来回调方法来执行自定义的处理动作。难道缓存架构就真的不行了吗?

答案是否定的。在Redis 2.8.0版本起,加入了“Keyspace notifications”(即“键空间通知”)的功能。如何理解该功能呢?我们来看下官方是怎么说的:

键空间通知,允许Redis客户端从“发布/订阅”通道中建立订阅关系,以便客户端能够在Redis中的数据因某种方式受到影响时收到相应事件。

可能接收到的事件举例如下:

影响一个给出的键的所有命令(会告诉你哪个键被执行了一个命令,这个命令是什么);

接收到了一个LPUSH操作的所有键(LPUSH命令:key v1 [v2 v3..]将指定的所有值从左到右进行压栈操作,形成一个栈,并将该栈命名为指定的key);

在数据库0中失效的所有键(不一定非得是数据库0,这里这样表述其实想表达可以知道影响的哪个数据库)。

看到这里我联想到,如果一条缓存数据失效了,通过订阅关系,客户端会收到消息,通过分析消息可以得知何种消息,分析消息内容可以知道是哪个key失效了。这样就可以间接实现开头所描述的功能。

接下来我们来看下实验的步骤:
1.准备redis服务器
作为开源软件,redis下载后得到的是源代码,使用tar -xzvf redis-2.8.9.tar.gz解压后对其进行编译,过程也很简单,make就可以了。编译完成之后可以使用自带的runtest进行测试,看是否编译成功。然后就是安装了,执行make PREFIX=/usr/local/redis-2.8.9 install,PREFIX参数指定的就是安装路径。现在安装的只有可执行文件,还没有配置文件。其实在源码目录中有一个模板redis.conf,我们对它进行改动就可以了。
其他配置我们不关心,但是官方文档中说Keyspace notifications功能默认是关闭的(默认地,Keyspace 时间通知功能是禁用的,因为它或多或少会使用一些CPU的资源),我们需要打开它。打开的方法也很简单,配置属性:notify-keyspace-events

默认配置是这样的:notify-keyspace-events “”
根据文档中的说明:

K Keyspace events, published with __keyspace@<db>__ prefix.
E Keyevent events, published with __keyevent@<db>__ prefix.
g Generic commands (non-type specific) like DEL, EXPIRE, RENAME, …
$ String commands
l List commands
s Set commands
h Hash commands
z Sorted set commands
x Expired events (events generated every time a key expires)
e Evicted events (events generated when a key is evicted for maxmemory)
A Alias for g$lshzxe, so that the “AKE” string means all the events.

我们配置为:notify-keyspace-events Ex,含义为:发布key事件,使用过期事件(当每一个key失效时,都会生成该事件)。
2.准备客户端和连接配置

本文中使用的客户端是Jedis,版本为2.4.2,为了代码的通用性,我使用Spring来管理连接:

<bean id=”pool” class=”redis.clients.jedis.JedisPool”>
<constructor-arg>
<bean id=”config” class=”redis.clients.jedis.JedisPoolConfig”>
<property name=”maxIdle” value=”0″ />
<property name=”maxTotal” value=”20″ />
<property name=”maxWaitMillis” value=”1000″ />
<property name=”testOnBorrow” value=”true” />
</bean>
</constructor-arg>
<constructor-arg>
<value>192.168.1.100</value>
</constructor-arg>
<constructor-arg>
<value>6379</value>
</constructor-arg>
</bean>

然后使用Spring Test和Junit来测试代码

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(“/applicationContext*.xml”)
public class RedisSubscribeDemo {

private static final Log Log= LogFactory.getLog(RedisSubscribeDemo.class);

@Resource
private JedisPool pool;

@Test
public void doTest() throws InterruptedException {
for (int i = 0; i < 1; i++) {
TestThread thread= new TestThread(pool);
thread.start();
}
Thread.sleep(50000L);
Log.info(“Test finish…”);
}
}

由于要使用一定的延迟,我们把主要测试代码放到了TestThread中。当测试线程启动后,主线程停滞50秒,让我们有足够的时间来操作。

public class TestThread extends Thread {

private Log log= LogFactory.getLog(TestThread.class);

private JedisPool pool;

public TestThread(JedisPool pool){
log.info(“loading test thread”);
this.pool= pool;
}

@Override
public void run() {
Jedis jedis= pool.getResource();
jedis.psubscribe(new MySubscribe(), “*”);
try {
Thread.sleep(10000L);
} catch (InterruptedException e) {
log.info(“延时失败”, e);
}
jedis.close();
log.info(“Test run finished”);
}
}

在测试线程中,我们将自定义的MySubscribe加入到了Jedis的模板订阅(即psubscribe,因为模板订阅的channel是支持星号’*’通配的,这样可以收集到多个通配通道的消息,而与之相反的还有一个subscribe,此订阅只能指定严格匹配的通道)中,同样为了测试过程能够将结果显示出来,在绑定了订阅后,对该线程进行了延时10秒。

public class MySubscribe extends JedisPubSub {

private static final Log log= LogFactory.getLog(MySubscribe.class);

// 初始化按表达式的方式订阅时候的处理
public void onPSubscribe(String pattern, int subscribedChannels) {
log.info(pattern + “=” + subscribedChannels);
}

// 取得按表达式的方式订阅的消息后的处理
public void onPMessage(String pattern, String channel, String message) {
log.info(pattern + “=” + channel + “=” + message);
}

…其他未用到的重写方法忽略
}

作为Jedis自定义订阅,必须继承redis.clients.jedis.JedisPubSub类,在psubscribe模式下,重点重写onPMessage方法,该方法为接收到模板订阅后处理事件的重要代码。pattern为在绑定订阅时使用的通配模板,channel为通配后符合条件的实际通道名称,message就不用多说了,就是事件消息内容。

3.实战
通过Redis自带的redis-cli命令,我们可以在服务端通过命令行的方式直接操作。我们运行上面的示例代码,然后迅速切换到redis-cli命令中,建立一个生命周期很短暂的数据:

127.0.0.1:6379> set chaijunkun 123 PX 100

PX参数指定生命周期单位为毫秒,100即声明周期,即100毫秒。key为chaijunkun的数据,其值为123。
当执行语句后,回显:

OK

这时我们看实例程序的输出:

*=__keyevent@0__:expired=chaijunkun

从输出可以看出,之前指定的通配符为*,通配任何通道;之后是实际的通道名称:__keyevent@0__:expired,这里我们可以看到订阅收到了一个keyevent位于数据库0,事件类型为:expired,是一个过期事件;最后是chaijunkun,这个是过期数据的key。
在官方文档中,keyevent通道的格式永远是这样的:
__keyevent@<db>__:prefix
对于数据过期事件,我们在绑定订阅时通配模板也可以精确地写成:
__keyevent@*__:expired
通过示例代码,我们可以看到确实印证了之前的构想,实现了数据过期的事件触发(event)或者说回调(callback)。

4.其他应用
之前的代码中,对于事件的发布都是由Redis自己生成的。实际上在命令中主动发布自定义消息也是可以的,在publish命令的帮助中我们看到:

127.0.0.1:6379> help publish

PUBLISH channel message
summary: Post a message to a channel
since: 2.0.0
group: pubsub

通过参数,可以自定义通道名称和通道消息。而在Jedis中,发布API甚至做到了字节数据的级别:
jedis.publish(byte[] channel, byte[] message)
因此我们可以构想,自定一套通讯协议,channel为命令字,message为消息体,我们可以通过redis这种简单的发布/订阅机制实现消息的分发。

发表评论

您的电子邮箱地址不会被公开。 必填项已用*标注