README

Resque 是一个基于 Redis 的库，用于创建后台任务，将这些任务放入一个或多个队列，并在稍后处理它们。

背景

Resque 由 GitHub 的高级人员（是的，我就是个马屁精）发起并开发，用 Ruby 编写。你所看到的是 Resque 工作器和入队系统几乎直接移植到 PHP 的示例。

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

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

PHP 版本不包含自己的网页界面来查看队列状态，因为数据存储的格式与 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/。

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

{
    "require": {
        "chrisboulton/php-resque": "1.2.x"
    }
}

运行 composer install。
如果尚未添加，请将 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'
Resque::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也负责自动加载您的应用程序！

启动应用程序还包括通过自动加载器或包含它们来告诉工作进程您的作业类。

或者，您始终可以从应用程序中包含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]);

[回调]可以是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

在工作进程派生以运行作业之前调用。传递的参数包含即将运行的作业的Resque_Job实例。

beforeFork在父进程中触发。所做的任何更改都将永久适用于工作进程的生命周期。

afterFork

在工作进程派生以运行作业后（但在运行作业之前）调用。传递的参数包含即将运行的作业的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

abuisine / php-resque

维护者

详细信息