任务调度

• Introduction
• 定义时间表
  • 计划频率选项
  • 防止任务重叠
• 任务输出
• 任务挂钩

#Introduction

过去，开发人员为他们需要安排的每个任务生成一个 Cron 条目。然而，这有时会让人头疼。您的任务计划不再受源代码控制，您必须通过 SSH 连接到您的服务器以添加 Cron 条目。命令调度程序允许您在应用程序本身内流畅而富有表现力地定义您的命令调度，并且您的服务器上只需要一个 Cron 条目。

NOTE：见安装指南 有关如何设置调度程序任务的说明。

#定义时间表

您可以通过覆盖registerSchedule 里面的方法插件注册类.该方法将采用单个$schedule 参数，用于定义命令及其频率。

首先，让我们看一个调度任务的示例。在这个例子中，我们将安排一个Closure 每天午夜被召唤。在Closure 我们将执行一个数据库查询来清除一个表：

class Plugin extends PluginBase
{
    [...]

    public function registerSchedule($schedule)
    {
        $schedule->call(function () {
            \Db::table('recent_users')->delete();
        })->daily();
    }
}

除了调度Closure 电话，您也可以安排控制台命令 和操作系统命令。例如，您可以使用command 调度控制台命令的方法：

$schedule->command('cache:clear')->daily();

这exec 命令可用于向操作系统发出命令：

$schedule->exec('node /home/acme/script.js')->daily();

#计划频率选项

当然，您可以为任务分配多种时间表：

这些方法可以与额外的约束相结合，以创建仅在一周中的特定几天运行的更精细调整的时间表。例如，要安排一个命令每周在星期一运行：

$schedule->call(function () {
    // Runs once a week on Monday at 13:00...
})->weekly()->mondays()->at('13:00');

以下是附加计划限制的列表：

真值测试约束

这when 方法可用于根据给定真值测试的结果来限制任务的执行。换句话说，如果给定Closure 返回true，只要没有其他约束条件阻止任务运行，任务就会执行：

$schedule->command('emails:send')->daily()->when(function () {
    return true;
});

#防止任务重叠

默认情况下，即使任务的前一个实例仍在运行，计划任务也会运行。为了防止这种情况，您可以使用withoutOverlapping 方法：

$schedule->command('emails:send')->withoutOverlapping();

在这个例子中，emails:send 控制台命令 如果尚未运行，将每分钟运行一次。这withoutOverlapping 如果您的任务在执行时间上变化很大，则该方法特别有用，这样您就无需准确预测给定任务将花费多长时间。

#任务输出

调度程序提供了几种方便的方法来处理计划任务生成的输出。首先，使用sendOutputTo 方法，您可以将输出发送到文件以供以后检查：

$schedule->command('emails:send')
    ->daily()
    ->sendOutputTo($filePath);

使用emailOutputTo 方法，您可以将输出通过电子邮件发送到您选择的电子邮件地址。请注意，输出必须首先使用sendOutputTo 方法。同样在通过电子邮件发送任务输出之前，您应该配置邮件服务:

$schedule->command('foo')
    ->daily()
    ->sendOutputTo($filePath)
    ->emailOutputTo('foo@example.com');

NOTE: 这emailOutputTo 和sendOutputTo 方法是专有的command 方法，不支持call.

#任务挂钩

使用before 和after 方法，您可以指定要在计划任务完成之前和之后执行的代码：

$schedule->command('emails:send')
    ->daily()
    ->before(function () {
        // Task is about to start...
    })
    ->after(function () {
        // Task is complete...
    });

ping 网址

使用pingBefore 和thenPing 方法，调度程序可以在任务完成之前或之后自动 ping 给定的 URL。此方法可用于通知外部服务您的计划任务正在开始或完成：

$schedule->command('emails:send')
    ->daily()
    ->pingBefore($url)
    ->thenPing($url);

你需要安装驱动插件 在你可以使用之前pingBefore($url) 或者thenPing($url) 特征。