Redis实践操作之—— keyspace notification（键空间通知）

Posted 2020-08-10

一、需求分析：

1. 设置了生存时间的Key，在过期时能不能有所提示？
2. 如果能对过期Key有个监听，如何对过期Key进行一个回调处理？
3. 如何使用 Redis 来实现定时任务？

二、序言：

        本文所说的定时任务或者说计划任务并不是很多人想象中的那样，比如说每天凌晨三点自动运行起来跑一个脚本。这种都已经烂大街了，随便一个 Crontab 就能搞定了。

        这里所说的定时任务可以说是计时器任务，比如说用户触发了某个动作，那么从这个点开始过二十四小时我们要对这个动作做点什么。那么如果有 1000 个用户触发了这个动

作，就会有 1000 个定时任务。于是这就不是 Cron 范畴里面的内容了。

       举个最简单的例子，一个用户推荐了另一个用户，我们定一个二十四小时之后的任务，看看被推荐的用户有没有来注册，如果没注册就给他搞一条短信过去。

三、Redis介绍

       在 Redis 的 2.8.0 版本之后，其推出了一个新的特性——键空间消息（Redis Keyspace Notifications），它配合 2.0.0 版本之后的 SUBSCRIBE 就能完成这个定时任务

的操作了，不过定时的单位是秒。

（1）Publish / Subscribe 

     Redis 在 2.0.0 之后推出了 Pub / Sub 的指令，大致就是说一边给 Redis 的特定频道发送消息，另一边从 Redis 的特定频道取值——形成了一个简易的消息队列。

（2）Redis Keyspace Notifications

     在 Redis 里面有一些事件，比如键到期、键被删除等。然后我们可以通过配置一些东西来让 Redis 一旦触发这些事件的时候就往特定的 Channel 推一条消息。

     大致的流程就是我们给 Redis 的某一个 db 设置过期事件，使其键一旦过期就会往特定频道推消息，我在自己的客户端这边就一直消费这个频道就好了。

     以后一来一条定时任务，我们就把这个任务状态压缩成一个键，并且过期时间为距这个任务执行的时间差。那么当键一旦到期，就到了任务该执行的时间，Redis 自然会把过期消息推去，我们的客户端就能接收到了。这样一来就起到了定时任务的作用。

 四、Key过期事件的Redis配置

      这里需要配置 notify-keyspace-events 的参数为 “Ex”。x 代表了过期事件。notify-keyspace-events "Ex" 保存配置后，重启Redis服务，使配置生效。
重启Reids服务器：

[email protected]:/etc/redis# service redis-server restart redis.conf
Stopping redis-server: redis-server.
Starting redis-server: redis-server.

添加过期事件订阅 开启一个终端，redis-cli 进入 redis 。开始订阅所有操作，等待接收消息。

[email protected]:~$ redis-cli -h 151.41.38.209 -p 63789
221.141.218.123:63789> psubscribe [email protected]__:expired
Reading messages... (press Ctrl-C to quit)
1) "psubscribe"
2) "[email protected]__:expired"
3) (integer) 1

再开启一个终端，redis-cli 进入 redis，新增一个 20秒过期的键：

121.41.188.109:63789> SETEX coolName 123 20
OK
121.41.188.109:63789> get coolName
"20"
121.41.188.109:63789> ttl coolName
(integer) 104

另外一边执行了阻塞订阅操作后的终端，20秒过期后有如下信息输出：

121.141.188.209:63789> psubscribe [email protected]__:expired
Reading messages... (press Ctrl-C to quit)
1) "psubscribe"
2) "[email protected]__:expired"
3) (integer) 1
1) "pmessage"
2) "[email protected]__:expired"
3) "[email protected]__:expired"
4) "coolName"

说明：说明对过期Key信息的订阅是成功的。

 五、phpREDIS实现订阅Keyspace notification

 Redis实例化类：(RedisInstance.class.php)

<?php

class RedisInstance
{
    private $redis;

    public function __construct($host = ‘121.41.88.209‘, $port = 63789)
    {
        $this->redis = new Redis();
        $this->redis->connect($host, $port);
    }

    public function expire($key = null, $time = 0)
    {
        return $this->redis->expire($key, $time);
    }

    public function psubscribe($patterns = array(), $callback)
    {
        $this->redis->psubscribe($patterns, $callback);
    }

    public function setOption()
    {
        $this->redis->setOption(\Redis::OPT_READ_TIMEOUT,-1);
    }

}

过期事件的订阅：（psubscribe.php）

<?php
require_once ‘./RedisInstance.class.php‘;
$redis = new \RedisInstance();
// 解决Redis客户端订阅时候超时情况
$redis->setOption();
$redis->psubscribe(array(‘[email protected]__:expired‘), ‘psCallback‘);
// 回调函数,这里写处理逻辑
function psCallback($redis, $pattern, $chan, $msg)
{
    echo "Pattern: $pattern\n";
    echo "Channel: $chan\n";
    echo "Payload: $msg\n\n";
}

说明：psCallback 函数为订阅事件后的回调函数。$redis, $pattern, $chan, $msg 四个参数为回调时返回的参数。 详细说明见下面 Redis 官方文档对 psubscribe 的说明。

因为订阅事件启动后是阻塞执行的，所以我们尝试在终端执行 psubscribe.php 这个脚本。

D:\wamp\www\redistest>php psubscribe.php

设置一个过期事件：

121.41.188.109:63789> SETEX username123 20

10秒过期时间到时，另外一边执行了脚本被阻塞的终端，有如下信息输出订阅结果：

D:\wamp\www\redistest>php psubscribe.php
Pattern: [email protected]__:expired
Channel: [email protected]__:expired
Payload: username123

以上PHP操作Reids是成功的

 六、使监听后台始终运行（订阅）

     有个问题 做到这一步，利用 phpredis 扩展，成功在代码里实现对过期 Key 的监听，并在 psCallback()里进行回调处理。 开头提出的两个需求已经实现。 可是这里有个问题：redis 在执行完订阅操作后，终端进入阻塞状态，需要一直挂在那。且此订阅脚本需要人为在命令行执行，不符合实际需求。

    实际上，我们对过期监听回调的需求，是希望它像守护进程一样，在后台运行，当有过期事件的消息时，触发回调函数。 使监听后台始终运行 希望像守护进程一样在后台一样，

我是这样实现的。

    Linux中有一个nohup命令。功能就是不挂断地运行命令。 同时nohup把脚本程序的所有输出，都放到当前目录的nohup.out文件中，如果文件不可写，则放到<用户主目录>/nohup.out 文件中。那么有了这个命令以后，不管我们终端窗口是否关闭，都能够让我们的php脚本一直运行。

编写PHP脚本文件：

<?php
#! /usr/local/php/bin/php
require_once ‘./redis.class.php‘;
$redis = new MyRedis();
$redis->setOption();
$redis->psubscribe(array(‘[email protected]__:expired‘), ‘psCallback‘);
// 回调函数,这里写处理逻辑
function psCallback($redis, $pattern, $chan, $msg)
{
    echo "Pattern: $pattern\n";
    echo "Channel: $chan\n";
    echo "Payload: $msg\n\n";
}

注意：不过我们在开头，需要申明 php 编译器的路径：#! /usr/local/php/bin/php 。 这是执行 php 脚本所必须的。

然后，nohup 不挂起执行 nohupRedisNotify.php，注意 末尾的 &

[[email protected] HiGirl]# nohup ./nohupRedisNotify.php & [1] 4456 nohup: ignoring input and appending output to `nohup.out‘

确认一下脚本是否已在后台运行。查看进程结果如下： 

[[email protected] HiGirl]# ps PID TTY TIME CMD 3943 pts/2 00:00:00 bash 4456 pts/2 00:00:00 nohupRedisNotif 4480 pts/2 00:00:00 

说明：脚本确实已经在 4456 号进程上跑起来。 

最后在查看下nohup.out cat 一下 nohuo.out，看下是否有过期输出：

[[email protected] HiGirl]# cat nohup.out [[email protected] HiGirl]#

并没有。我们还是老样子，新增一个10秒过期的的键 name。10秒后，我们再 cat 一次。 

[[email protected] HiGirl]# cat nohup.out Pattern: [email protected]__:expired Channel: [email protected]__:expired Payload: name

说明监听过期事件并回调成功。