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

如果你不熟悉Composer，请参阅https://getcomposer.org.cn/。

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

{
    "require": {
        "artox-lab/php-resque": "1.3.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'
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 - 失败的作业

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
@noxt

artox-lab / php-resque

维护者

详细信息