PHPphp-resque的规划与下

php-resque-1.2-annotated
一个 php-resque 源码阅读之路,欢迎大家star

php-resque的设计

于Resque中,一个后台任务被架空为由三栽角色共同完成:

  • Job | 任务 :
    一个Job就是一个用以后台就的职责,比如本文举例的殡葬邮件,就得抽象为一个Job。在Resque中一个Job就是一个Class。
  • Queue | 队列 :
    也就是是上文的信息队列,在Resque中,队列则是由Redis实现的。Resque还提供了一个粗略的排管理器,可以实现以Job插入/取出队列等效果。
  • Worker | 执行者 :
    负责从队列中取出Job并履行,可以以守护进程的法门运行于后台。
    那么根据这个分,一个后台任务在Resque下的主导流程是如此的:

在Resque中,有一个良要紧之规划:一个Worker,可以拍卖一个阵,也可以拍卖过剩个队,并且可透过加Worker的长河/线程数来增速队列的实施进度。

流程如下:

  • 拿一个后台任务编写为一个独门的Class,这个Class就是一个Job。
  • 每当急需用后台程序的地方,系统以Job
    Class的称谓以及所用参数放入队列。
  • 坐命执行措施打开一个Worker,并透过参数指定Worker所需要处理的排。
  • Worker作为医护进程运行,并且定时检查队列。
  • 当排中生Job时,Worker取出Job并运行,即实例化Job
    Class并尽Class中之方式。

php-resque的使用

编辑一个Worker
实则php-resque已经让有了简便易行的例证,
demo/job.php文件就是一个尽简单易行的Job:

class PHP_Job
{
    public function perform()
    {
        sleep(120);
        fwrite(STDOUT, 'Hello!');
    }
}

这Job就是于120秒后朝着STDOUT输出字符Hello!

当Resque的计划着,一个Job必须存在一个perform方法,Worker则会自动运行是措施。

用Job插入行
php-resque也深受闹了极端简单易行的插队列实现 demo/queue.php:

if(empty($argv[1])) {
    die('Specify the name of a job to add. e.g, php queue.php PHP_Job');
}

require __DIR__ . '/init.php';
date_default_timezone_set('GMT');
Resque::setBackend('127.0.0.1:6379');

$args = array(
    'time' => time(),
    'array' => array(
        'test' => 'test',
    ),
);

$jobId = Resque::enqueue('default', $argv[1], $args, true);
echo "Queued job ".$jobId."\n\n";

每当是事例中,queue.php需要盖cli方式运行,将cli接收至的率先单参数作为Job名称,插入名也’default’的排,同时向屏幕输出刚才插入行的Job
Id。在终端输入:

cd demo
php queue.php PHP_Job

结果可以视屏幕及输出:

Queued job 52f5abf5344094efc417e7ea8f1aa083

纵然Job已经长成功。注意这里的Job名称以及我们编辑的Job
Class名称保持一致:PHP_Job
在这个时节连接redis-cli,可以看到有如下三独key:

1) "resque:job:52f5abf5344094efc417e7ea8f1aa083:status"
2) "resque:queue:default"
3) "resque:queues"

各自就此如下命令查看其色:

type resque:job:52f5abf5344094efc417e7ea8f1aa083:status
type resque:queue:default
type resque:queues

那列分别是:string/list/set
得出resque:job:52f5abf5344094efc417e7ea8f1aa083:status的始末查看:

get resque:job:52f5abf5344094efc417e7ea8f1aa083:status

其情如下:

"{\"status\":1,\"updated\":1438095296,\"started\":1438095296}"

里头的status表示Job运行状态,updated表示更新时间,started表示开时。
此存放的凡job执行状态的音讯。
php-resque同样也提供了翻Job运行状态的事例,直接运行:

php check_status.php 52f5abf5344094efc417e7ea8f1aa083

可以看输出为:

Tracking status of 52f5abf5344094efc417e7ea8f1aa083. Press [break] to stop. 
Status of 52f5abf5344094efc417e7ea8f1aa083 is: 1

咱刚刚创建的Job状态为1。在Resque中,一个Job有以下4种状态:

  • Resque_Job_Status::STATUS_WAITING = 1; (等待)
  • Resque_Job_Status::STATUS_RUNNING = 2; (正在实施)
  • Resque_Job_Status::STATUS_FAILED = 3; (失败)
  • Resque_Job_Status::STATUS_COMPLETE = 4; (结束)

博出resque:queue:default的情查看(key中之default是以前头代码中定义的queue的名称):

lrange resque:queue:default 0 -1

那个情节如下:

1) "{\"class\":\"PHP_Job\",\"args\":[{\"time\":1438095296,\"array\":{\"test\":\"test\"}}],\"id\":\"52f5abf5344094efc417e7ea8f1aa083\"}"

中间的class表示Job的类似,args表示Job执行时的参数,id表示Job的ID,可以因这ID去查询Job执行状态的音信。
此地存放的凡每个要推行之Job的连带信息。因为就补充加了一个,所以当default的班中,只发生一个价值。

取得出resque:queues的情节查看:

smembers resque:queues

夫情如下:

1) "default"

此间存放的凡颇具班的名。因为光发生一个,所以当queues的集中,只生一个价值。

因无Worker运行,所以才创建的Job还是等状态。
运行Worker
这次咱们一直编写demo/resque.php:

date_default_timezone_set('GMT');
require 'job.php';
require '../bin/resque';

可以视一个Worker至少需要简单组成部分:

好一直包含Job类文件,也得以应用php的电动加载机制,指定好Job
Class所于途径并能够促成全自动加载
包含Resque的默认Worker: bin/resque
于巅峰中运行:

QUEUE=default php resque.php

前方的QUEUE部分凡是安环境变量,我们指定当前之Worker只当处理default队列。也足以以

QUEUE=* php resque.php

来拍卖所有班。

运转后输出为

#!/usr/bin/env php
*** Starting worker jun-Ubuntu:23437:*

之所以ps指令检查一下:

ps aux | grep resque

可观看出一个php的护理进程已经在运转了

jun      23437  1.0  0.3 314148 14884 pts/16   S+   23:23   0:00 php resque.php

在这时刻更连接受redis-cli,查看key,可以看来如下key:

1) "resque:job:52f5abf5344094efc417e7ea8f1aa083:status"
2) "resque:workers"
3) "resque:queues"
4) "resque:worker:jun-Ubuntu:25122:*:started"
5) "resque:worker:jun-Ubuntu:25122:*"

独家查看新增的key是呀项目:

type resque:workers
type resque:worker:jun-Ubuntu:25122:*:started
type resque:worker:jun-Ubuntu:25122:*

夫列分别是set/string/string
个别取出其情节,命令就不再写了,请参见前的情节
resque:workers中的情如下:

1) "jun-Ubuntu:25122:*"

此存放的凡兼备worker的进程ID。因为光来一个,所以当workers的集合中,只出一个价值。
resque:worker:jun-Ubuntu:25122::started中的内容如下(key中之jun-Ubuntu:25122:是worker的host+进程ID+queue的名称):

"Tue Jul 28 15:29:37 GMT 2015"

此存放的凡Job启动的时。
resque:worker:jun-Ubuntu:25122:未遭之始末如下(key中的jun-Ubuntu:25122:是worker的host+进程ID+queue的名称):

"{\"queue\":\"default\",\"run_at\":\"Tue Jul 28 15:29:37 GMT 2015\",\"payload\":{\"class\":\"PHP_Job\",\"args\":[{\"time\":1438097296,\"array\":{\"test\":\"test\"}}],\"id\":\"52f5abf5344094efc417e7ea8f1aa083\"}}"

此间存放的凡这worker当前履行的Job的持有信息。
于此同时,resque:job:52f5abf5344094efc417e7ea8f1aa083:status中之情节变为如下内容:

"{\"status\":2,\"updated\":1438097377}"

状态变为2(正在尽)了。
啊得采用前的检讨Job指令

php check_status.php 52f5abf5344094efc417e7ea8f1aa083

2分钟后更连接受redis-cli上去查看key,可以见到如下key:

1) "resque:job:52f5abf5344094efc417e7ea8f1aa083:status"
2) "resque:workers"
3) "resque:stat:processed"
4) "resque:stat:processed:jun-Ubuntu:25122:*"
5) "resque:queues"
6) "resque:worker:jun-Ubuntu:25122:*:started"

其中的resque:stat:processed和resque:stat:processed:jun-Ubuntu:25122:还是string类型,分别表示所有worker执行job成功之个数与worker为jun-Ubuntu:25122:的尽job成功之个数。
此时刻更夺查以下resque:job:52f5abf5344094efc417e7ea8f1aa083:status的情节,发现状态就变为4(结束)了。
为得使前的反省Job指令查看,其结果如下:

Status of 52f5abf5344094efc417e7ea8f1aa083 is: 4

就意味着任务就运行了,同时屏幕上该可以看来输出的Hello!

至今我们早就成功之做到了一个极度简单易行的Resque实例的凡事演示,更扑朔迷离的状态与遗留的题材会在生一样潮的日记被证明。

小结一下Redis中的key对应之情节及其含义如下:

  • resque:workers (set) – 存放有的worker,每一个价值都是{worker
    host}:{进程ID}:{queue的称}
  • resque:queues (set) – 存放有queue的名称
  • resque:queue:default (list) – 保存之行列中等待执行之Job
  • resque:job:52f5abf5344094efc417e7ea8f1aa083:status (string) –
    存放job的状态信息
  • resque:stat:processed (string) – 保存有worker执行job成功之个数
  • resque:stat:processed:jun-Ubuntu:25122:* (string) –
    保存一个worker执行job成功之个数
  • resque:worker:jun-Ubuntu:25122:*:started (string) –
    保存一个worker的开行日
  • resque:worker:jun-Ubuntu:25122:* (string) –
    保存一个worker当前执行之Job的富有消息

参考摘录:
PHP的轻量消息队列php-resque使用说明

相关文章