Laravel 7.x 使用 keyspace notification 监听不到 Key 过期事件

作者: hedeqiang

发布时间: 2020-08-28 16:10:21

场景使用:假设有一个订单 30 分钟以后未付款 自动关闭该订单。或者会员到期自动提醒续费等等。

这个在 Laravel 中其实有更好的选择方式 队列,使用延时队列

ProcessPodcast::dispatch($podcast)->delay(now()->addMinutes(30));

但是我还想到一种方案就是使用 Redis 的键空间通知(keyspace notification)。意思就是当 Redis 的 key 删除是,回主动通知发送消息给我们,我们只需要监听订阅对应的事件即可。

接下来我还原事情经过。说一下我遇到的问题,以及最后是如何解决的。

首先 Redis 的 keyspace notification 默认是不开启的。我们需要主动开启,开启方式如下 修改 redis.conf 配置文件 找到 notify-keyspace-events "" 默认是空字符串,表示未开启.

notify-keyspace-events "Ex"

然后重启 Redis

或者直接 redis-cli 下输入如下命令进行修改

redis-cli config set notify-keyspace-events Ex

具体 Ex 代表啥意思 参考如下表格:

字符 发送的通知
K 键空间通知,所有通知以 keyspace@<db> 为前缀
E 键事件通知,所有通知以 keyevent@<db> 为前缀
g DEL 、 EXPIRE 、 RENAME 等类型无关的通用命令的通知
$ 字符串命令的通知
l 列表命令的通知
s 集合命令的通知
h 哈希命令的通知
z 有序集合命令的通知
x 过期事件:每当有过期键被删除时发送
e 驱逐(evict)事件:每当有键因为 maxmemory 政策而被删除时发送
A 参数 g$lshzxe 的别名

好了,言归正传,接下来在 Laravel 中,我是新建一个 Command 命令

php artisan make:command OrderExpire

内容如下:

<?php

namespace App\Console\Commands;

use Illuminate\Console\Command;
use Illuminate\Support\Facades\Redis;

class OrderExpire extends Command
{
    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'order:expire';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = '处理订单失效';

    /**
     * Create a new command instance.
     *
     * @return void
     */
    public function __construct()
    {
        parent::__construct();
    }

    /**
     * Execute the console command.
     *
     * @return int
     */
    public function handle()
    {
        $redis = Redis::connection('publisher');
        Redis::subscribe(['__keyevent@0__:expired'], function ($message, $channel) {
            // 处理订单失效 逻辑
            echo '订单已失效';
        });
    }
}

configdatabase.php 中 redis 配置里添加 如下内容:

'publisher' => [
    'host' => env('REDIS_HOST', '127.0.0.1'),
    'password' => env('REDIS_PASSWORD', null),
    'port' => env('REDIS_PORT', 6379),
    'database' => 0,
    'read_timeout' => 0,
    'persistent' => true, 
    'read_write_timeout' => 0,
],

在 路由文件下 编写 Redis 键 到期命令,设置 5 秒失效

use Illuminate\Support\Facades\Redis;
Route::get('/', function () {
    Redis::setex('order_2000123421',5,'2000123421');
});

接下来运行行项目

我们首先在 Laravel 项目中运行 控制台命令

php artisan order:expire

接下来在 red-cli 中也监听过期命令

redis-cli
127.0.0.1:6379> psubscribe __keyevent@0__:expired
Reading messages... (press Ctrl-C to quit)
1) "psubscribe"
2) "__keyevent@0__:expired"
3) (integer) 1
1) "pmessage"
2) "__keyevent@0__:expired"
3) "__keyevent@0__:expired"

访问路由文件,设置 Redis Key,但是你会发现实际上我们编写的控制台命令,Redis 5 秒过后并不会触发任何事件。而 redis-cli 5秒以后会监听到。

下面是 redis-cli 的结果: file

下图是 Laravel 项目的结果,过一定事件还会出现连接错误:

file

这个问题纠结了挺久。最后解决方案如下:

解决方案

不使用 Laravel 自带的 Redis 门面,改为原生 Redis 。修改 handle 方法

$redis = new \Redis();
$redis->connect('redis', '6379');
$redis->setOption(\Redis::OPT_READ_TIMEOUT, -1);
$pattern = '__keyevent@0__:expired';
$redis->psubscribe([$pattern], function ($message, $channel)
{
    echo '订单已失效';
});

接下来再次重启命令,访问路由就可以看到自己想要的内容了

file

Why

I don't know。。。

我猜是 Laravel 的门面 Illuminate\Support\Facades\Redis ,这个订阅可能需要配合 发布一起使用。但是我不清楚这个事件订阅如何起作用,总不能直接发布 Redis::publish('test-channel', json_encode(['foo' => 'bar'])); 吧?希望遇到的童鞋能和我交流一下。

关于极客返利

极客返利 是由我个人开发的一款网课返利、返现平台。包含 极客时间返现、拉勾教育返现、掘金小册返现、GitChat返现。目前仅包含这几个平台。后续如果有需要可以考虑其他平台。 简而言之就是:你买课,我返现。让你花更少的钱,就可以买到课程。

https://geek.laravelcode.cn

https://geek.idaka.ink

版权许可

本作品采用 知识共享署名 4.0 国际许可协议 进行许可。

转载无需与我联系,但须注明出处,注明文章来源 Laravel 7.x 使用 keyspace notification 监听不到 Key 过期事件