README

Resque是一个Redis支持的库，用于创建后台作业，将这些作业放入一个或多个队列中，并在稍后处理它们。

背景

Resque是由GitHub（是的，我在拍马屁）的出色团队开创并开发的，用Ruby编写。你所看到的是Resque工作机和入队系统到PHP的直接移植。

有关Resque的更多信息，请访问官方GitHub项目：https://github.com/resque/resque

有关更多信息，请参阅GitHub博客上的启动帖子：http://github.com/blog/542-introducing-resque

PHP移植不包括自己的Web界面来查看队列统计信息，因为数据存储的格式与Resque的Ruby版本完全相同。

PHP移植提供了与Ruby版本几乎相同的特性

• 工作机可以在多台机器之间分配
• 包括对优先级（队列）的支持
• 具有抗内存泄漏（分叉）的能力
• 预期失败

它还支持以下附加功能

• 能够跟踪作业状态
• 如果分叉的子进程在执行作业时没有以状态码0退出，则将作业标记为失败
• 内置对setUp和tearDown方法的支持，分别在作业前后调用

需求

• PHP 5.3+
• Redis 2.2+
• 可选但推荐：Composer

入门

当php-resque作为你的项目中的Composer包安装时，与php-resque一起工作最容易。Composer不是必需的，但它会使生活更加轻松。

如果你不熟悉Composer，请参阅https://getcomposer.org.cn/。

1. 将php-resque添加到应用程序的composer.json中。

{
    // ...
    "require": {
        "chrisboulton/php-resque": "1.2.x"	// Most recent tagged version
    },
    // ...
}

1. 运行composer install。

2. 如果还没有，请将Composer自动加载添加到项目初始化文件中。（示例）

require 'vendor/autoload.php';

作业

队列作业

作业按以下方式排队

// Required if redis is located elsewhere
Resque::setBackend('localhost:6379');

$args = array(
        'name' => 'Chris'
        );
Resque::enqueue('default', 'My_Job', $args);

定义作业

每个作业应该在其自己的类中，并包含一个perform方法。

class My_Job
{
    public function perform()
    {
        // Work work work
        echo $this->args['name'];
    }
}

当作业运行时，将实例化该类，并将任何参数设置为实例对象的数组，并通过$this->args访问。

作业抛出的任何异常都将导致作业失败 - 请在此处小心，并确保你处理那些不应该导致作业失败的异常。

作业还可以有setUp和tearDown方法。如果定义了setUp方法，它将在运行perform方法之前被调用。如果定义了tearDown方法，它将在作业完成后被调用。

class My_Job
{
    public function setUp()
    {
        // ... Set up environment for this job
    }

    public function perform()
    {
        // .. Run job
    }

    public function tearDown()
    {
        // ... Remove environment for this job
    }
}

出队作业

此方法可用于方便地从队列中删除作业。

// Removes job class 'My_Job' of queue 'default'
Resque::dequeue('default', ['My_Job']);

// Removes job class 'My_Job' with Job ID '087df5819a790ac666c9608e2234b21e' of queue 'default'
Resuque::dequeue('default', ['My_Job' => '087df5819a790ac666c9608e2234b21e']);

// Removes job class 'My_Job' with arguments of queue 'default'
Resque::dequeue('default', ['My_Job' => array('foo' => 1, 'bar' => 2)]);

// Removes multiple jobs
Resque::dequeue('default', ['My_Job', 'My_Job2']);

如果没有提供作业，此方法将出队所有与提供的队列匹配的作业。

// Removes all jobs of queue 'default'
Resque::dequeue('default');

跟踪作业状态

php-resque能够执行队列作业的基本状态跟踪。状态信息将允许你检查作业是否在队列中，是否正在运行，是否已完成或已失败。

要跟踪作业的状态，请将true作为第四个参数传递给Resque::enqueue。将返回用于跟踪作业状态的令牌

$token = Resque::enqueue('default', 'My_Job', $args, true);
echo $token;

获取作业状态

$status = new Resque_Job_Status($token);
echo $status->get(); // Outputs the status

作业状态在Resque_Job_Status类中定义为常量。有效的状态包括

• Resque_Job_Status::STATUS_WAITING - 作业仍在队列中
• Resque_Job_Status::STATUS_RUNNING - 作业正在运行
• Resque_Job_Status::STATUS_FAILED - 作业已失败
• Resque_Job_Status::STATUS_COMPLETE - 作业已完成
• false - 获取状态失败 - 令牌是否有效？

作业完成或失败后的状态最多可保留24小时，之后将自动过期。也可以通过在状态类上调用stop()方法强制使状态过期。

工作者

工作者的工作方式与Ruby工作者完全相同。有关工作者的完整文档，请参阅原始文档。

包含了一个基本的“启动运行”的bin/resque文件，该文件设置了运行工作者的环境。（通过Composer安装时为vendor/bin/resque）

与Ruby版本的resque相似的例外是如何初始化工作者。为了在所有环境中工作，而不像Ruby那样只有一个环境，PHP端口不假设你的设置。

启动工作者与Ruby版本非常相似

$ QUEUE=file_serve php bin/resque

您需要告诉工作者要包含哪个文件以开始应用程序。您可以通过设置APP_INCLUDE环境变量来做到这一点

$ QUEUE=file_serve APP_INCLUDE=../application/init.php php bin/resque

技巧：如果您使用Composer，那么您很可能不需要担心APP_INCLUDE，因为Composer可能也负责自动加载您的应用程序！

开始应用程序还包括通过自动加载器或包含它们的方式告诉工作者您的作业类。

或者，您始终可以从应用程序中包含bin/resque，并完全跳过设置APP_INCLUDE。但是，请在执行之前确保设置了各种环境变量（setenv）。

日志记录

端口支持用于将日志记录到STDOUT的相同环境变量。设置VERBOSE将打印基本调试信息，而VVERBOSE将打印详细信息。

$ VERBOSE=1 QUEUE=file_serve bin/resque
$ VVERBOSE=1 QUEUE=file_serve bin/resque

优先级和队列列表

同样，优先级和队列列表功能与Ruby工作者完全相同。多个队列应以逗号分隔，并且它们提供的顺序是它们被检查的顺序。

按照原始示例

$ QUEUE=file_serve,warm_cache bin/resque

file_serve队列将在检查warm_cache队列之前在每个迭代中始终检查新作业。

运行所有队列

所有队列都支持相同的方式，并按字母顺序处理。

$ QUEUE='*' bin/resque

运行多个工作者

可以通过提供COUNT环境变量同时启动多个工作者。

$ COUNT=5 bin/resque

但是请注意，每个工作者都是其自己的分支，并且原始进程将在产生COUNT分支后立即关闭。如果您需要使用外部应用程序（如monit）跟踪工作者，您将需要绕过这个限制。

自定义前缀

当您有多个应用程序使用相同的Redis数据库时，最好使用自定义前缀来分离Resque数据

$ PREFIX=my-app-name bin/resque

分支

与Ruby版本类似，支持的平台将立即在获取作业后分支。分支的子进程将在作业完成时退出。

与php-resque的区别是，如果分支的子进程没有优雅地退出（PHP错误等），php-resque将自动失败作业。

信号

信号在支持的平台上的工作方式与Ruby版本的Resque完全相同

• QUIT - 等待作业完成处理然后退出
• TERM / INT - 立即终止作业后退出
• USR1 - 立即终止作业但不退出
• USR2 - 暂停工作进程，不再处理新的作业
• CONT - 恢复工作进程。

进程标题/状态

Resque的Ruby版本有一个巧妙的功能，即工作进程的进程标题会更新，以指示工作进程正在做什么，并且任何分叉的子进程也会设置其进程标题，包括正在运行的作业。这有助于识别服务器上正在运行的过程及其Resque状态。

PHP在5.5之前默认没有这项功能。

存在一个PECL模块（http://pecl.php.net/package/proctitle），在5.5之前为PHP添加了这项功能，因此如果您想更新进程标题，也需要安装这个PECL模块。php-resque将自动检测并使用它。

事件/钩子系统

php-resque有一个基本的用于自定义一些php-resque内部行为的事件系统。

您可以通过使用Resque_Event进行注册并提供一个回调函数来监听事件（如下所示）。

Resque_Event::listen('eventName', [callback]);

[回调]可以是PHP中任何可以通过call_user_func_array调用的东西。

• 一个包含函数名的字符串
• 包含对象和要调用的方法的数组
• 包含对象和要调用的静态方法的数组
• 闭包（PHP 5.3+）

事件可以传递参数（如下文所述），因此您的回调应该接受这些参数。

您可以通过调用Resque_Event::stopListening并传递与Resque_Event::listen相同的参数来停止监听事件。

注册事件监听器是您应用程序的责任。当在应用程序中入队事件时，只需确保已加载php-resque并调用Resque_Event::listen即可。

当运行工作进程时，如果您通过默认的bin/resque脚本运行工作进程，您的APP_INCLUDE脚本应初始化并注册操作所需的任何监听器。如果您自己编写了工作进程管理器，那么注册监听器也是您的责任。

在extras目录中包含了一个示例插件。

事件

beforeFirstFork

在工作进程初始化时被调用一次。传递的参数是刚刚初始化的Resque_Worker实例。

beforeFork

在php-resque分叉以运行作业之前被调用。传递的参数包含即将运行的作业的Resque_Job实例。

beforeFork在父进程中触发。任何更改都将对工作进程的生命周期保持永久。

afterFork

在php-resque分叉以运行作业（但在运行作业之前）被调用。传递的参数包含即将运行的作业的Resque_Job实例。

afterFork在分叉以完成作业的子进程后触发。任何更改将仅在作业被处理时存在。

beforePerform

在运行作业上的setUp和perform方法之前被调用。传递的参数包含即将运行的作业的Resque_Job实例。

您可以通过抛出Resque_Job_DontPerform异常来防止执行作业。抛出任何其他异常都将被视为在作业中抛出，导致作业失败。

afterPerform

在运行作业上的perform和tearDown方法之后被调用。传递的参数包含刚刚运行的作业的Resque_Job实例。

抛出的任何异常都将被视为在作业中抛出，导致作业被标记为失败。

onFailure

每当作业失败时被调用。传入的参数（按顺序）包括

• Exception - 作业失败时抛出的异常
• Resque_Job - 失败的作业

beforeEnqueue

在调用 Resque::enqueue 方法将作业入队之前立即调用。传入的参数（按顺序）包括

• Class - 包含要入队作业名称的字符串
• Arguments - 作业参数数组
• Queue - 包含作业要入队的队列名称的字符串
• ID - 包含要入队作业令牌的字符串

您可以通过抛出 Resque_Job_DontCreate 异常来防止作业入队。

afterEnqueue

使用 Resque::enqueue 方法将作业入队后调用。传入的参数（按顺序）包括

• Class - 包含计划作业名称的字符串
• Arguments - 供给作业的参数数组
• Queue - 包含已添加作业的队列名称的字符串
• ID - 包含入队作业的新令牌的字符串

Step-By-Step

要更深入地了解php-resque在底层执行的操作（而无需直接检查代码），请参阅 HOWITWORKS.md。

贡献者

项目负责人

• @chrisboulton

其他人

• @acinader
• @ajbonner
• @andrewjshults
• @atorres757
• @benjisg
• @cballou
• @chaitanyakuber
• @charly22
• @CyrilMazur
• @d11wtq
• @danhunsaker
• @dceballos
• @ebernhardson
• @hlegius
• @hobodave
• @humancopy
• @iskandar
• @JesseObrien
• @jjfrey
• @jmathai
• @joshhawthorne
• @KevBurnsJr
• @lboynton
• @maetl
• @matteosister
• @MattHeath
• @mickhrmweb
• @Olden
• @patrickbajao
• @pedroarnal
• @ptrofimov
• @rajibahmed
• @richardkmiller
• @Rockstar04
• @ruudk
• @salimane
• @scragg0x
• @scraton
• @thedotedge
• @tonypiper
• @trimbletodd
• @warezthebeef