README

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

运行composer require resque/php-resque。
如果您尚未这样做，请将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 也负责自动加载您的应用程序！

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

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

进程标题/状态

Ruby版本的Resque有一个便捷的功能，即工作进程的进程标题会更新以显示工作进程正在做什么，以及任何被分叉的子进程也会设置它们的进程标题以显示正在运行的作业。这有助于识别服务器上正在运行的过程及其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

项目维护者

@danhunsaker
@rajibahmed
@steveklabnik

其他人

@acinader
@ajbonner
@andrewjshults
@atorres757
@benjisg
@cballou
@chaitanyakuber
@charly22
@CyrilMazur
@d11wtq
@dceballos
@ebernhardson
@hlegius
@hobodave
@humancopy
@iskandar
@JesseObrien
@jjfrey
@jmathai
@joshhawthorne
@KevBurnsJr
@lboynton
@maetl
@matteosister
@MattHeath
@mickhrmweb
@Olden
@patrickbajao
@pedroarnal
@ptrofimov
@richardkmiller
@Rockstar04
@ruudk
@salimane
@scragg0x
@scraton
@thedotedge
@tonypiper
@trimbletodd
@warezthebeef

danhunsaker / php-resque

维护者

详细信息