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 - 包含入队工作项的新令牌的字符串

步骤详解

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

gemsnet / php-resque

维护者

详细信息