cakejob/php-resque-ex-scheduler

php-resque-ex-scheduler 是 resque-scheduler 的 PHP 版本,为 PHP-Resque 添加了支持调度作业的功能。

1.1.2 2022-08-11 04:19 UTC

This package is auto-updated.

Last update: 2024-09-11 08:38:57 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 将尝试从您的 include 路径加载它(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
  • 陈万祺(Kamisama)