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包安装时，与php-resque一起工作最容易。Composer不是必需的，但它使生活变得更加简单。

如果您不熟悉Composer，请参阅https://getcomposer.org.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。只是确保在执行之前设置了各种环境变量（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 - 失败的任务

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

hewenhua / php-resque

维护者

详细信息