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

入门

在项目中以Composer包的形式安装php-resque是使用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）

与Resque的Ruby版本相似之处在于，工作者初始设置方式不同。为了在所有环境中工作（不像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也负责自动加载您的应用程序！

启动应用程序还包括通过某种方式告知工作者您的作业类，例如自动加载器或包含它们。

或者，您始终可以从应用程序中include('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

在检查warm_cache队列之前，将始终在每次迭代中检查file_serve队列是否有新作业。

运行所有队列

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

$ QUEUE='*' bin/resque

运行多个工作者

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

$ COUNT=5 bin/resque

但是，请注意，每个工作者都是其自己的分叉，并且原始进程将在生成COUNT个子进程后立即关闭。如果您需要使用如monit之类的外部应用程序跟踪您的工作者，您需要解决这个限制。

自定义前缀

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

$ PREFIX=my-app-name bin/resque

分叉

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

与php-resque不同的是，如果一个分叉的子进程没有优雅地退出（PHP错误或其他），php-resque将自动失败作业。

信号

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

• 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有一个基本的 eventos 系统可以由您的应用程序使用来定制一些php-resque内部行为。

您可以通过注册Resque_Event并提供一个回调来监听事件（如下所示），当事件被触发时，您希望触发的回调

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

[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

每当任务失败时调用。传递的参数（按此顺序）包括

• 异常 - 任务失败时抛出的异常
• Resque_Job - 失败的任务

beforeEnqueue

在使用 Resque::enqueue 方法将任务入队之前立即调用。按此顺序传递的参数包括

• 类 - 包含要入队任务名称的字符串
• 参数 - 任务参数的数组
• 队列 - 包含任务要入队的队列名称的字符串
• ID - 包含要入队任务标记的字符串

您可以通过抛出 Resque_Job_DontCreate 异常来阻止任务入队。

afterEnqueue

在使用 Resque::enqueue 方法将任务入队后调用。按此顺序传递的参数包括

• 类 - 包含预定任务名称的字符串
• 参数 - 传递给任务的参数数组
• 队列 - 包含任务被添加到的队列名称的字符串
• ID - 包含入队任务的新标记的字符串

步骤-by-步骤

要深入了解 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