glit/resque

ruby resque 库的 PHP 版本。并且对作业实例化进行了增强（例如，与 Symfony2 DIC 一起使用很有用）。

此软件包的规范存储库似乎已消失，因此该软件包已被冻结。

维护者

详细信息

github.com/glit/php-resque

源代码

问题

安装次数: 15,785

依赖项: 2

建议者: 0

安全性: 0

星标: 8

观察者: 1

分支: 3

开放问题: 2

dev-master 2013-03-03 23:53 UTC

MIT dababc0735ce7d1e2c515a902e447bb1aabc0f84

  • William POTTIER <wpottier.woop@allprogrammic.com>

resque

This package is auto-updated.

Last update: 2021-02-17 12:07:21 UTC

README

Resque 是一个基于 Redis 的库，用于创建后台作业，将作业放置在多个队列中，并在以后处理它们。

背景

Resque 由 GitHub 的人们（是的，我在拍马屁）开创并开发，是用 Ruby 编写的。你在这里看到的是 Resque 工作者和入队系统的 PHP 章节的直接移植。

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

有关更多信息，请参阅 GitHub 博客上的启动帖子：[http://github.com/blog/542-introducing-resque](http://github.com/blog/542-introducing-resque)

PHP 版本不包括自己的用于查看队列状态的 Web 界面，因为数据存储的格式与 Resque 的 Ruby 版本完全相同。

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

  • 工作者可以在多台机器之间分布
  • 包括对优先级（队列）的支持
  • 对内存泄露具有弹性（分支）
  • 预期会失败

它还支持以下附加功能

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

需求

  • PHP 5.3+
  • Redis 2.2+

作业

队列作业

作业按照以下方式入队

// Required if redis is located elsewhere
Resque::setBackend('localhost:6379');

$args = array(
	'name' => 'Chris'
);
Resque::enqueue('default', 'My_Job', $args);

定义作业

每个作业应该在其自己的类中，并包含一个 perform 方法。

class MyJob extends \Resque\Job\AbstractInstance
{
	public function perform()
	{
		// Work work work
		echo $this->args['name'];
	}
}

当作业运行时，类将被实例化，任何参数都将作为数组设置在实例化的对象上，并且可以通过 $this->args 访问。

作业抛出的任何异常都将导致作业失败 - 这里要小心，确保你处理了不应该导致作业失败的异常。

作业还可以有 setUp 和 tearDown 方法。如果定义了 setUp 方法，它将在运行 perform 方法之前被调用。如果定义了 tearDown 方法，它将在作业完成后被调用。

class MyJob extends \Resque\Job\AbstractInstance
{
	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', 'MyJob', $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 ./bin/resque

您负责告诉工作者要包含哪个文件以开始应用程序。您通过设置 APP_INCLUDE 环境变量来实现这一点

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

启动应用程序还包括告诉工作者您的作业类，通过自动加载器或包含它们来实现。

日志记录

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

$ VERBOSE QUEUE=file_serve ./bin/resque
$ VVERBOSE QUEUE=file_serve ./bin/resque

优先级和队列列表

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

按照原始示例

$ QUEUE=file_serve,warm_cache php resque.php

在检查 warm_cache 队列之前，将始终在每个迭代中检查 file_serve 队列以查找新作业。

运行所有队列

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

$ QUEUE=* ./bin/resque

运行多个工作者

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

$ COUNT=5 ./bin/resque

分叉

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

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

信号

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

  • 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::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 方法入队后调用。传递的参数（按此顺序）包括

  • 类 - 包含作业调度所在类名的字符串
  • 参数 - 传递给作业的参数数组

感谢

本版本基于 chrisbulton 的出色工作