README

===========================================

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

背景

Resque是由GitHub的优秀团队（是的，我就是个马屁精）开创并开发的，是用Ruby编写的。你所看到的是Resque工作器和入队系统的PHP的直接移植。

有关Resque的更多信息，请访问官方GitHub项目

PHP移植版本不包括用于查看队列状态的Web界面，因为数据存储的格式与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

file_serve队列将在检查warm_cache队列之前在每个迭代中检查新作业。

运行所有队列

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

$ 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模块，它可以将此功能添加到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即可。

在运行工作进程时，如果您通过默认的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

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

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

afterEnqueue

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

类 - 包含计划作业名称的字符串
参数 - 传递给作业的参数数组
队列 - 包含作业被添加到的队列名称的字符串

ashishchashta / resque

维护者

详细信息