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

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

{
    // ...
    "require": {
        "chrisboulton/php-resque": "1.2.x"	// Most recent tagged version
    },
    // ...
}

运行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'
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。但是，请确保在这样做之前设置了各种环境变量。

日志记录

该端口支持用于将日志记录到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

在运行作业之前调用。传入的参数包含即将运行的作业的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 - 包含入队工作项的新令牌的字符串

步骤详解

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

amosoft / php-resque

维护者

详细信息