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://composer.php.ac.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

file_serve队列将在每次迭代之前始终检查新作业，然后再检查warm_cache队列。

运行所有队列

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

$ QUEUE='*' bin/resque

运行多个工作进程

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

$ COUNT=5 bin/resque

然而，请注意，每个工作进程都是一个单独的fork，原始进程将在产生COUNT个fork后立即关闭。如果您需要使用如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有一个基本的即使系统，可以被您的应用程序用来自定义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