README

Resque 是一个基于 Redis 的库，用于创建后台任务，将任务放入多个队列，并在稍后处理它们。

背景

Resque 由 GitHub（是的，我是在拍马屁）的出色团队首创并开发，是用 Ruby 编写的。你在这里看到的是 Resque 工作器和入队系统几乎直接移植到 PHP 的结果。

有关 Resque 的更多信息，请访问官方 GitHub 项目： http://github.com/defunkt/resque/

有关更多信息，请参阅 GitHub 博客上的发布帖子： http://github.com/blog/542-introducing-resque

PHP 版本不包括自己的网页界面来查看队列统计信息，因为数据存储的格式与 Resque 的 Ruby 版本完全相同。

PHP 版本提供了与 Ruby 版本几乎相同的特性

工作器可以在多台机器之间分布
支持优先级（队列）
对内存泄漏具有抵抗力（分叉）
预期失败

它还支持以下附加功能

能够跟踪作业的状态
如果分叉子进程运行作业时没有以状态码 0 退出，则会将作业标记为失败
具有内置对 setUp 和 tearDown 方法的支持，分别在作业前和作业后调用

要求

PHP 5.2+
Redis 2.2+

作业

排队作业

作业如下排队

require_once 'lib/Resque.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
	}
}

跟踪作业状态

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 工作器完全相同。有关工作器的完整文档，请参阅原始文档。

包含了一个基本的“启动运行”的resque.php文件，该文件设置了一个运行的工作环境，位于根目录中。

与Ruby版本的resque相似之处的一个例外是如何初始化一个工作进程。为了在所有环境中工作，不像Ruby那样有一个单一的环境，PHP端口对你的设置没有任何假设。

要启动一个工作进程，与Ruby版本非常相似

$ QUEUE=file_serve php resque.php

你的责任是告诉工作进程要包含哪个文件来开始你的应用程序。你通过设置APP_INCLUDE环境变量来这样做

$ QUEUE=file_serve APP_INCLUDE=../application/init.php php resque.php

开始你的应用程序还包括通过某种方式告诉工作进程你的任务类，无论是通过自动加载器还是包含它们。

日志记录

该端口支持相同的日志到STDOUT的环境变量。设置VERBOSE将打印基本的调试信息，而VVERBOSE将打印详细信息。

$ VERBOSE QUEUE=file_serve php resque.php
$ VVERBOSE QUEUE=file_serve php resque.php

优先级和队列列表

同样，优先级和队列列表功能与Ruby工作进程完全相同。多个队列应以逗号分隔，并且它们提供的顺序是它们被检查的顺序。

根据原始示例

$ QUEUE=file_serve,warm_cache php resque.php

在检查warm_cache队列之前，将始终检查file_serve队列以查找新的工作。

运行所有队列

所有队列都支持相同的方式，并按字母顺序处理

$ QUEUE=* php resque.php

运行多个工作进程

可以通过提供COUNT环境变量来启动多个工作进程并自动处理

$ COUNT=5 php resque.php

分叉

与Ruby版本类似，支持的平台在获取工作后立即分叉。分叉的子进程将在作业完成时退出。

与php-resque的不同之处在于，如果分叉的子进程没有优雅地退出（PHP错误等），php-resque将自动失败作业。

信号

信号在支持的平台上工作，与Ruby版本的Resque完全相同

QUIT - 等待子进程完成处理然后退出
TERM / INT - 立即杀死子进程然后退出
USR1 - 立即杀死子进程但不要退出
USR2 - 暂停工作进程，不会处理新的作业
CONT - 恢复工作进程。

进程标题/状态

Resque的Ruby版本有一个巧妙的功能，即工作进程的进程标题会更新以指示工作进程正在做什么，并且任何分叉的子进程也会设置它们的进程标题，以运行作业。这有助于识别服务器上运行的进程及其resque状态。

PHP默认没有此功能。

存在一个PECL模块（http://pecl.php.net/package/proctitle），它将此功能添加到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::listen提供的相同参数的Resque_Event::stopListening来停止监听事件。

由您的应用程序负责注册事件监听器。当在应用程序中入队事件时，只需确保加载php-resque并调用Resque_Event::listen即可。

运行工作者时，如果您通过默认的resque.php脚本来运行工作者，则您的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 - 失败的作业

afterEnqueue

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

Class - 包含计划作业名称的字符串
Arguments - 传给作业的参数数组
Queue - 包含作业添加到的队列名称的字符串

贡献者

chrisboulton
thedotedge
hobodave
scraton
KevBurnsJr
jmathai
dceballos
patrickbajao
andrewjshults
warezthebeef
d11wtq
hlegius
salimane
humancopy
pedroarnal
chaitanyakuber
maetl
Matt Heath
jjfrey
scragg0x

lingziyao115 / php-resque

维护者

详细信息