thinkphp5 的 redis 队列实现原理与bug修复

使用方式

composer require topthink/think-queue:1.1.6 // 官方版
composer require sorry510/think-queue // 修复bug版,断线重连

注意事项

redis 服务端

设置超时时间为 0 或一个尽量大的数,否则队列的某个任务执行时间过程,会导致服务器端主动断开连接

timeout 300

redis 客户端

application\extra\queue.php, timeout 为 0,永不超时

<?php
use think\Env;
return [
    //Redis驱动
    'connector' => 'redis',
    "expire" => 60, //任务过期时间默认为秒,禁用为null
    "default" => "default", //默认队列名称
    "host" => ENV::get('redis.host', '127.0.0.1'), //Redis主机IP地址
    "port" => ENV::get('redis.port', '6379'), //Redis端口
    "password" => ENV::get('redis.password', ''), //Redis密码
    "select" => ENV::get('redis.index', 0), //Redis数据库索引
    "timeout" => 0, //Redis连接超时时间
    "persistent" => false, //是否长连接
];

使用方式

  • listen 模式,每次调用都会开启新的进程,实时调用最新的代码,部署不推荐,特别消耗 cpu 资源
php think queue:listen --queue=xxx
  • work 模式,常驻内存模式,无法调用到修改后的代码,需要重启
php think queue:work --daemon --queue=xxx

work 实现原理

redis 数据

2 种数据类型

list

存储将要执行的任务,key 为 queues:队列名称, 例如,投递一个任务queue($job, '', 0, 'test_queue'),就会生成一个 key 为 queues:test_queue 的 list 数据, 数据元素结构如下:

{
    job:"app\job\JobTest"
    data:""
    id:"CW03tlfol59ClkE7BsC6SuHTIiMkzcVM"
    attempts:1
}
sorted set
  • 执行中的任务

key 为 queues:队列名称:reserved, score为当前时间 + 过期时间(--expire),数据内容与 list 一致

  • 投递的延时的任务

key 为 queues:队列名称:delayed, score为当前时间 + 延时时间(--delay),数据内容与 list 一致

  • 执行失败时的重新发布的任务

key 为 queues:队列名称:delayed, score为当前时间 + 延时时间(--delay),数据内容与 list 一致

运行示意图

tp5.0 redis 队列.jpg

运行方式

  1. 无延时投递任务时时以 left 方式 push 到 list,延时时写入到 sorted set 中
  2. 运行时使用轮训(查看代码 vendor\topthink\think-queue\src\queue\command\Work.php 的 107 行 while (true) {)方式运行,不断循环执行,每次执行后都会睡眠 3 秒钟(可以配置 --sleep 1 修改为 1 秒)
  3. 执行时首先会查询延迟任务(key 为 queues:队列名称:delayed),如果延时到期了,就从set中删除此任务移动到list中(right push)
  4. 然后查询执行失败的任务,从 set 移动到 list(right push),并记录执行次数+1
  5. 之后开始正式的执行环节,首先会从 list 中 right pop 最新的记录,移动到 sorted set(执行中的任务) 中然后开始执行 job
  6. 执行时,首先会判断执行次数是否大于尝试次数(可以配置 --tries 3 设置为3,默认为 0 永久重试),如果大于尝试次数,就从 sorted set 中删除对应数据,并执行 job 的 failed 方法,反之,就正常执行 job 的 fire 方法,成功之后删除 set 中的对应数据,等待休眠,进行下一次循环中,如果 job 的 fire 方法抛出异常且没有被删除(手动调用 $job->delete() 方法),就重新发布 job
  7. 发布逻辑为从 set 中删除之前的对应数据,重新添加一条数据, queues:队列名称:delayed, score 为 当前时间 + 延时时间(--delay),并记录执行次数+1
  8. 下面为主体执行代码逻辑,详情请查看源码 vendor\topthink\think-queue\src\queue\Worker.php 文件
public function process(Job $job, $maxTries = 0, $delay = 0)
{
    if ($maxTries > 0 && $job->attempts() > $maxTries) {
        return $this->logFailedJob($job);
    }

    try {
        $job->fire();

        return ['job' => $job, 'failed' => false];
    } catch (Exception $e) {
        if (!$job->isDeleted()) {
            $job->release($delay);
        }

        throw $e;
    }
}
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,716评论 4 364
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,558评论 1 294
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,431评论 0 244
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,127评论 0 209
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,511评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,692评论 1 222
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,915评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,664评论 0 202
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,412评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,616评论 2 245
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,105评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,424评论 2 254
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,098评论 3 238
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,096评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,869评论 0 197
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,748评论 2 276
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,641评论 2 271

推荐阅读更多精彩内容