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

将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 文件，该文件设置了一个运行的工作者环境。 (vendor/bin/resque 通过 Composer 安装时)

与 Ruby 版本的 resque 相似之处有一个例外，那就是工作者的初始设置。为了在所有环境中工作，而不是像 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

每当作业失败时被调用。传入的参数（按此顺序）包括：

Exception - 作业失败时抛出的异常
Resque_Job - 失败的作业

beforeEnqueue

在调用 Resque::enqueue 方法将作业入队之前立即调用。传入的参数（按此顺序）包括：

Class - 包含要入队作业名称的字符串
Arguments - 作业的参数数组
Queue - 包含作业要入队的队列名称的字符串
ID - 包含要入队作业令牌的字符串

您可以通过抛出 Resque_Job_DontCreate 异常来防止作业入队。

afterEnqueue

在调用 Resque::enqueue 方法将作业入队后调用。传入的参数（按此顺序）包括：

Class - 包含计划作业名称的字符串
Arguments - 供给作业的参数数组
Queue - 包含添加作业的队列名称的字符串
ID - 包含入队作业的新令牌的字符串

Step-By-Step

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

daneren2005 / php-resque

维护者

详细信息