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/。

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

{
    "require": {
        "chrisboulton/php-resque": "1.2.x"
    }
}

1. 运行 composer install。

2. 如果尚未添加，请将 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

file_serve队列将在检查warm_cache队列之前在每个迭代中始终检查新作业。

运行所有队列

所有队列均以相同的方式受支持，并按字母顺序处理。

$ QUEUE='*' bin/resque

运行多个工作者

可以通过提供环境变量COUNT同时启动多个工作者。

$ COUNT=5 bin/resque

但是请注意，每个工作者都是自己的分支，原始进程将在产生COUNT分支后立即关闭。如果您需要使用外部应用程序（如monit）跟踪工作者，您需要解决这个问题。

自定义前缀

当您有多个应用程序使用相同的Redis数据库时，最好使用自定义前缀来分隔Resque数据。

$ PREFIX=my-app-name bin/resque

分支

与Ruby版本类似，支持的平台将在获取作业后立即分支。分支的子进程将在作业完成后退出。

与php-resque的不同之处在于，如果分支的子进程没有优雅地退出（PHP错误等），php-resque将自动失败作业。

信号

信号在支持的平台上工作，与Ruby版本的Resque完全相同。

• 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