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包安装。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 有一个基本的事件系统，您的应用程序可以使用它来自定义一些 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 - 包含入队作业的新标记的字符串

逐步指南

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

spiritdead / php-resque

维护者

详细信息