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 文件，用于设置运行工作环境。（通过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可能还负责自动加载您的应用程序！

启动应用程序还包括通过自动加载器或包含它们的方式告诉工作进程您的作业类。

或者，您始终可以从应用程序中包含 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

snikius / php-resque

维护者

详细信息