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://getcomposer.org.cn/。

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

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

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'
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将自动失败作业。

信号

信号在支持的平台上与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
• @test