任务调度

• 简介
• 定义调度
  • 调度 Artisan 命令
  • 调度排队作业
  • 调度 Shell 命令
  • 调度频率选项
  • 时区
  • 防止任务重叠
  • 在一台服务器上运行任务
  • 后台任务
  • 维护模式
• 运行调度程序
  • 亚分钟调度任务
  • 在本地运行调度程序
• 任务输出
• 任务钩子
• 事件

简介

过去，您可能为服务器上需要调度的每个任务编写了一个 cron 配置条目。但是，这很快就会变得很麻烦，因为您的任务计划不再处于源代码控制之下，并且您必须 SSH 到服务器才能查看现有的 cron 条目或添加其他条目。

Laravel 的命令调度程序提供了一种管理服务器上计划任务的新方法。调度程序允许您在 Laravel 应用程序本身内流畅且富有表现力地定义您的命令计划。使用调度程序时，服务器上只需要一个 cron 条目。您的任务计划通常在应用程序的 routes/console.php 文件中定义。

定义调度

您可以在应用程序的 routes/console.php 文件中定义所有计划任务。首先，让我们来看一个示例。在此示例中，我们将安排一个闭包每天午夜调用。在闭包中，我们将执行一个数据库查询以清除一个表

<?php
 
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Facades\Schedule;
 
Schedule::call(function () {
    DB::table('recent_users')->delete();
})->daily();

除了使用闭包进行调度外，您还可以调度 可调用对象。可调用对象是包含 __invoke 方法的简单 PHP 类。

Schedule::call(new DeleteRecentUsers)->daily();

如果您希望仅将 routes/console.php 文件保留用于命令定义，则可以在应用程序的 bootstrap/app.php 文件中使用 withSchedule 方法来定义您的计划任务。此方法接受一个闭包，该闭包接收调度程序的实例。

use Illuminate\Console\Scheduling\Schedule;
 
->withSchedule(function (Schedule $schedule) {
    $schedule->call(new DeleteRecentUsers)->daily();
})

如果您想查看计划任务的概述以及下次计划运行的时间，可以使用 schedule:list Artisan 命令。

php artisan schedule:list

调度 Artisan 命令

除了调度闭包之外，您还可以调度 Artisan 命令 和系统命令。例如，您可以使用 command 方法来调度 Artisan 命令，可以使用命令的名称或类名。

当使用命令的类名调度 Artisan 命令时，您可以传递一个额外的命令行参数数组，这些参数应在调用命令时提供给该命令。

use App\Console\Commands\SendEmailsCommand;
use Illuminate\Support\Facades\Schedule;
 
Schedule::command('emails:send Taylor --force')->daily();
 
Schedule::command(SendEmailsCommand::class, ['Taylor', '--force'])->daily();

调度 Artisan 闭包命令

如果要调度由闭包定义的 Artisan 命令，可以在命令定义后链接相关的调度方法。

Artisan::command('delete:recent-users', function () {
    DB::table('recent_users')->delete();
})->purpose('Delete recent users')->daily();

如果需要向闭包命令传递参数，可以将它们提供给 schedule 方法。

Artisan::command('emails:send {user} {--force}', function ($user) {
    // ...
})->purpose('Send emails to the specified user')->schedule(['Taylor', '--force'])->daily();

调度排队作业

job 方法可用于调度 排队作业。此方法提供了一种方便的方法来调度排队作业，而无需使用 call 方法来定义闭包以排队作业。

use App\Jobs\Heartbeat;
use Illuminate\Support\Facades\Schedule;
 
Schedule::job(new Heartbeat)->everyFiveMinutes();

可以向 job 方法提供可选的第二个和第三个参数，分别指定用于排队作业的队列名称和队列连接。

use App\Jobs\Heartbeat;
use Illuminate\Support\Facades\Schedule;
 
// Dispatch the job to the "heartbeats" queue on the "sqs" connection...
Schedule::job(new Heartbeat, 'heartbeats', 'sqs')->everyFiveMinutes();

调度 Shell 命令

exec 方法可用于向操作系统发出命令。

use Illuminate\Support\Facades\Schedule;
 
Schedule::exec('node /home/forge/script.js')->daily();

调度频率选项

我们已经看到了几个关于如何配置任务以在指定时间间隔运行的示例。但是，您可以为任务分配更多任务调度频率。

这些方法可以与其他约束条件结合使用，以创建更精细的计划，这些计划仅在每周的特定日期运行。例如，您可以安排一个命令每周一运行。

use Illuminate\Support\Facades\Schedule;
 
// Run once per week on Monday at 1 PM...
Schedule::call(function () {
    // ...
})->weekly()->mondays()->at('13:00');
 
// Run hourly from 8 AM to 5 PM on weekdays...
Schedule::command('foo')
          ->weekdays()
          ->hourly()
          ->timezone('America/Chicago')
          ->between('8:00', '17:00');

下面列出了其他调度约束条件。

日期约束

可以使用 days 方法将任务的执行限制在每周的特定几天。例如，您可以安排一个命令在每周日和周三每小时运行一次。

use Illuminate\Support\Facades\Schedule;
 
Schedule::command('emails:send')
                ->hourly()
                ->days([0, 3]);

或者，您可以在定义任务应运行的日期时，使用 Illuminate\Console\Scheduling\Schedule 类中提供的常量。

use Illuminate\Support\Facades;
use Illuminate\Console\Scheduling\Schedule;
 
Facades\Schedule::command('emails:send')
                ->hourly()
                ->days([Schedule::SUNDAY, Schedule::WEDNESDAY]);

时间范围约束

可以使用 between 方法根据一天中的时间限制任务的执行。

Schedule::command('emails:send')
                    ->hourly()
                    ->between('7:00', '22:00');

类似地，可以使用 unlessBetween 方法排除任务在特定时间段内的执行。

Schedule::command('emails:send')
                    ->hourly()
                    ->unlessBetween('23:00', '4:00');

真值测试约束

可以使用 when 方法根据给定真值测试的结果限制任务的执行。换句话说，如果给定的闭包返回 true，则任务将执行，只要没有其他约束条件阻止任务运行。

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

skip 方法可以看作是 when 的反面。如果 skip 方法返回 true，则不会执行计划的任务。

Schedule::command('emails:send')->daily()->skip(function () {
    return true;
});

当使用链式 when 方法时，只有当所有 when 条件都返回 true 时，才会执行计划的命令。

环境约束

可以使用 environments 方法仅在给定的环境中执行任务（由 APP_ENV 环境变量 定义）。

Schedule::command('emails:send')
            ->daily()
            ->environments(['staging', 'production']);

时区

使用 timezone 方法，您可以指定计划任务的时间应在给定时区内解释。

use Illuminate\Support\Facades\Schedule;
 
Schedule::command('report:generate')
         ->timezone('America/New_York')
         ->at('2:00')

如果您反复将相同的时区分配给所有计划任务，则可以通过在应用程序的 app 配置文件中定义 schedule_timezone 选项来指定应分配给所有计划的时区。

'timezone' => env('APP_TIMEZONE', 'UTC'),
 
'schedule_timezone' => 'America/Chicago',

防止任务重叠

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

use Illuminate\Support\Facades\Schedule;
 
Schedule::command('emails:send')->withoutOverlapping();

在此示例中，如果 emails:send Artisan 命令 未在运行，则每分钟运行一次。如果您有执行时间差异很大的任务，withoutOverlapping 方法特别有用，可以防止您准确预测特定任务需要多长时间。

如果需要，您可以指定“不重叠”锁过期前必须经过多少分钟。默认情况下，锁将在 24 小时后过期。

Schedule::command('emails:send')->withoutOverlapping(10);

在后台，withoutOverlapping 方法利用应用程序的 缓存 来获取锁。如有必要，您可以使用 schedule:clear-cache Artisan 命令清除这些缓存锁。这通常仅在由于意外的服务器问题导致任务卡住时才需要。

在一台服务器上运行任务

如果您的应用程序调度程序在多台服务器上运行，则可以将计划作业限制为仅在一台服务器上执行。例如，假设您有一个计划任务，该任务每周五晚上生成一个新报告。如果任务调度程序在三台工作服务器上运行，则计划任务将在所有三台服务器上运行并生成三次报告。这不好！

要指示任务应仅在一台服务器上运行，请在定义计划任务时使用 onOneServer 方法。第一台获取任务的服务器将在作业上获得原子锁，以防止其他服务器在同一时间运行相同的任务。

use Illuminate\Support\Facades\Schedule;
 
Schedule::command('report:generate')
                ->fridays()
                ->at('17:00')
                ->onOneServer();

命名单服务器作业

有时您可能需要安排相同的作业以不同的参数分派，同时仍指示 Laravel 在一台服务器上运行作业的每个排列。为此，您可以通过 name 方法为每个调度定义分配一个唯一的名称。

Schedule::job(new CheckUptime('https://laravel.net.cn'))
            ->name('check_uptime:laravel.com')
            ->everyFiveMinutes()
            ->onOneServer();
 
Schedule::job(new CheckUptime('https://vapor.laravel.net.cn'))
            ->name('check_uptime:vapor.laravel.com')
            ->everyFiveMinutes()
            ->onOneServer();

类似地，如果计划的闭包旨在在一台服务器上运行，则必须为其分配一个名称。

Schedule::call(fn () => User::resetApiRequestCount())
    ->name('reset-api-request-count')
    ->daily()
    ->onOneServer();

后台任务

默认情况下，在同一时间安排的多个任务将根据它们在 schedule 方法中定义的顺序依次执行。如果您有长时间运行的任务，这可能会导致后续任务比预期晚得多。如果您想在后台运行任务以便它们可以同时运行，则可以使用 runInBackground 方法。

use Illuminate\Support\Facades\Schedule;
 
Schedule::command('analytics:report')
         ->daily()
         ->runInBackground();

维护模式

当应用程序处于 维护模式 时，应用程序的计划任务将不会运行，因为我们不希望您的任务干扰您可能在服务器上执行的任何未完成的维护。但是，如果您想强制任务即使在维护模式下也运行，则可以在定义任务时调用 evenInMaintenanceMode 方法。

Schedule::command('emails:send')->evenInMaintenanceMode();

运行调度程序

现在我们已经了解了如何定义计划任务，让我们讨论如何在服务器上实际运行它们。schedule:run Artisan 命令将评估所有计划任务并根据服务器的当前时间确定它们是否需要运行。

因此，当使用 Laravel 的调度程序时，我们只需要在服务器上添加一个单一的 cron 配置条目，该条目每分钟运行一次 schedule:run 命令。如果您不知道如何在服务器上添加 cron 条目，请考虑使用 Laravel Forge 等服务，它可以为您管理 cron 条目。

* * * * * cd /path-to-your-project && php artisan schedule:run >> /dev/null 2>&1

亚分钟调度任务

在大多数操作系统上，cron 作业最多只能每分钟运行一次。但是，Laravel 的调度程序允许您安排任务以更频繁的间隔运行，甚至可以每秒运行一次。

use Illuminate\Support\Facades\Schedule;
 
Schedule::call(function () {
    DB::table('recent_users')->delete();
})->everySecond();

当在应用程序中定义了亚分钟任务时，schedule:run 命令将继续运行到当前分钟结束，而不是立即退出。这允许命令在整个分钟内调用所有必需的亚分钟任务。

由于运行时间超过预期的亚分钟任务可能会延迟后续亚分钟任务的执行，因此建议所有亚分钟任务都分派排队作业或后台命令来处理实际的任务处理。

use App\Jobs\DeleteRecentUsers;
 
Schedule::job(new DeleteRecentUsers)->everyTenSeconds();
 
Schedule::command('users:delete')->everyTenSeconds()->runInBackground();

中断亚分钟任务

当定义了亚分钟任务时，由于 schedule:run 命令在整个调用分钟内运行，因此您有时可能需要在部署应用程序时中断该命令。否则，正在运行的 schedule:run 命令实例将继续使用应用程序先前部署的代码，直到当前分钟结束。

要中断正在进行的 schedule:run 调用，您可以将 schedule:interrupt 命令添加到应用程序的部署脚本中。此命令应在应用程序部署完成后调用。

php artisan schedule:interrupt

在本地运行调度程序

通常，您不会将调度程序 cron 条目添加到本地开发机器中。相反，您可以使用 schedule:work Artisan 命令。此命令将在前台运行，并每分钟调用一次调度程序，直到您终止该命令。

php artisan schedule:work

任务输出

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

use Illuminate\Support\Facades\Schedule;
 
Schedule::command('emails:send')
         ->daily()
         ->sendOutputTo($filePath);

如果您想将输出追加到给定文件，则可以使用 appendOutputTo 方法。

Schedule::command('emails:send')
         ->daily()
         ->appendOutputTo($filePath);

使用 emailOutputTo 方法，您可以将输出通过电子邮件发送到您选择的电子邮件地址。在通过电子邮件发送任务的输出之前，您应该配置 Laravel 的 电子邮件服务。

Schedule::command('report:generate')
         ->daily()
         ->sendOutputTo($filePath)
         ->emailOutputTo('[email protected]');

如果您只想在计划的 Artisan 或系统命令以非零退出代码终止时通过电子邮件发送输出，请使用 emailOutputOnFailure 方法。

Schedule::command('report:generate')
         ->daily()
         ->emailOutputOnFailure('[email protected]');

任务钩子

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

use Illuminate\Support\Facades\Schedule;
 
Schedule::command('emails:send')
         ->daily()
         ->before(function () {
             // The task is about to execute...
         })
         ->after(function () {
             // The task has executed...
         });

onSuccess 和 onFailure 方法允许您指定如果计划任务成功或失败要执行的代码。失败表示计划的 Artisan 或系统命令以非零退出代码终止。

Schedule::command('emails:send')
         ->daily()
         ->onSuccess(function () {
             // The task succeeded...
         })
         ->onFailure(function () {
             // The task failed...
         });

如果您的命令有输出可用，则可以通过将 Illuminate\Support\Stringable 实例作为挂钩闭包定义的 $output 参数进行类型提示，从而在 after、onSuccess 或 onFailure 挂钩中访问它。

use Illuminate\Support\Stringable;
 
Schedule::command('emails:send')
         ->daily()
         ->onSuccess(function (Stringable $output) {
             // The task succeeded...
         })
         ->onFailure(function (Stringable $output) {
             // The task failed...
         });

Ping URL

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

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

pingBeforeIf 和 thenPingIf 方法可用于仅在给定条件为 true 时 ping 给定 URL。

Schedule::command('emails:send')
         ->daily()
         ->pingBeforeIf($condition, $url)
         ->thenPingIf($condition, $url);

pingOnSuccess 和 pingOnFailure 方法可用于仅在任务成功或失败时 ping 给定 URL。失败表示计划的 Artisan 或系统命令以非零退出代码终止。

Schedule::command('emails:send')
         ->daily()
         ->pingOnSuccess($successUrl)
         ->pingOnFailure($failureUrl);

事件

Laravel 在调度过程中分派各种 事件。您可以为以下任何事件 定义监听器。