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

入门

当 php-resque 作为你的项目中的 Composer 包安装时，与它一起工作是最容易的。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也负责自动加载你的应用程序！

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

或者，你始终可以从应用程序中 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有一个基本的事件系统，可用于自定义某些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

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

异常 - 任务失败时抛出的异常
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

catch-of-the-day / php-resque

维护者

详细信息