adventgroup / php-resque-scheduler
php-resque-scheduler 是 resque-scheduler 的 PHP 版本,为 Resque 添加了对未来项目排程的支持。
Requires
- adventgroup/php-resque: 1.0.x
This package is auto-updated.
Last update: 2024-09-23 05:51:18 UTC
README
php-resque-scheduler 是 resque-scheduler 的 PHP 版本,它为 Resque 添加了对未来项目排程的支持。
resque-scheduler 的 PHP 版本被设计成几乎直接复制 Ruby 插件,并设计成与 resque 的 PHP 版本 php-resque 一起使用。
目前,php-resque-scheduler 只支持延迟作业,这可以将作业推送到队列并在特定时间戳或秒数后运行。计划在未来的版本中添加对循环作业(类似于 CRON)的支持。
由于 PHP 版本几乎直接复制了 Ruby 版本的 API,因此它也与 Ruby 版本的 Web 界面兼容,该界面提供了查看和管理延迟作业的能力。
延迟作业
以下引用自 Ruby resque-scheduler 的文档
延迟作业是在未来的某个时间点放入队列的一次性作业。经典示例是发送电子邮件
require 'Resque/Resque.php';
require 'ResqueScheduler/ResqueScheduler.php';
$in = 3600;
$args = array('id' => $user->id);
ResqueScheduler::enqueueIn($in, 'email', 'SendFollowUpEmail', $args);
上述代码将作业存储在延迟队列中 1 小时,然后从延迟队列中取出作业并提交给 Resque 的 email
队列以进行处理,一旦有可用的工人。
除了传递相对时间(以秒为单位)外,您还可以将 DateTime 对象或包含 UNIX 时间戳的整数作为时间戳传递给 enqueueAt
方法
require 'Resque/Resque.php';
require 'ResqueScheduler/ResqueScheduler.php';
$time = 1332067214;
ResqueScheduler::enqueueAt($time, 'email', 'SendFollowUpEmail', $args);
$datetime = new DateTime('2012-03-18 13:21:49');
ResqueScheduler::enqueueAt(datetime, 'email', 'SendFollowUpEmail', $args);
注意:resque-scheduler 不保证作业将在指定的时间触发。在指定的时间,resque-scheduler 将从延迟队列中取出作业并将其推送到 Resque 中适当的队列。您的下一个可用的 Resque 工人将取走作业。为了尽可能快地处理,请保持您的队列尽可能空。
工人
与 resque 一样,resque-scheduler 包含一个在后台运行的工人。此工人负责从排程/延迟队列中拉取项目并将其添加到 resque 的队列中。这意味着为了执行延迟或排程作业,工人需要运行。
根目录中包含一个基本的 "启动运行" resque-scheduler.php 文件,该文件设置了一个运行工人环境。它接受许多与 php-resque 相同的环境变量
REDIS_BACKEND
- 连接到 Redis 服务器LOGGING
- 启用向 STDOUT 记录日志VERBOSE
- 启用详细日志记录VVERBOSE
- 启用非常详细日志记录INTERVAL
- 在检查排程/延迟队列之前睡眠此长时间APP_INCLUDE
- 启动时包含此文件(以启动您的应用程序)PIDFILE
- 将工人的 PID 写入此文件
resque-scheduler 工人需要 resque 才能运行。示例 resque-scheduler.php 工人允许您提供 RESQUE_PHP
环境变量,其中包含 Resque.php 的路径。如果未提供且 resque 未经加载,resque-scheduler 将尝试从您的包含路径中加载它(require_once 'Resque/Resque.php';'
)
使用 resque-scheduler.php 启动 resque-scheduler 工人很容易:$ RESQUE_PHP=../resque/lib/Resque/Resque.php php resque-scheduler.php
事件/钩子系统
php-resque-scheduler 使用与 php-resque 相同的事件系统,并公开以下事件。
afterSchedule
在任务被添加到调度后调用。传入的参数包括时间戳、任务的队列、任务的类名以及任务的参数。
beforeDelayedEnqueue
在任务从延迟队列中取出后立即调用,并且在任务被添加到resque队列之前。传入的参数包括任务的队列、任务的类名以及任务的参数。
贡献者
- chrisboulton
- rayward
- atorres757
- tonypiper
- biinari
- cballou