任务调度
Laravel 的命令调度程序允许你在 Laravel 中对命令调度进行清晰流畅的定义。并且在使用调度程序时,只需要在服务器上增加一条 Cron 项目即可。调度是在 文件的 schedule
方法中定义的。为了方便你开始,该方法已经包含了一个简单的例子。
使用调度器时,只需将以下 Cron 项目添加到服务器。如果你不知道如何将 Cron 项目添加到服务器,可以考虑使用 Laravel Forge 等服务来管理你的 Cron 项目:
上面这个 Cron 会每分钟调用一次 Laravel 命令调度器。执行 schedule:run
命令时, Laravel 会根据你的调度运行预定任务。
你可以在 App\Console\Kernel
类的 schedule
方法中定义所有调度任务。在开始之前,先看看一个调度任务的例子。在该例子中,我们将计划在每天午夜调用一个 Closure
。在这个 Closure
中,将执行一个数据库查询来清除一个表:
<?php
namespace App\Console;
use DB;
use Illuminate\Console\Scheduling\Schedule;
use Illuminate\Foundation\Console\Kernel as ConsoleKernel;
class Kernel extends ConsoleKernel
{
/**
* 应用提供的 Artisan 命令
*
* @var array
*/
protected $commands = [
//
];
/**
*定义应用的命令调度
*
* @param \Illuminate\Console\Scheduling\Schedule $schedule
* @return void
*/
protected function schedule(Schedule $schedule)
{
$schedule->call(function () {
DB::table('recent_users')->delete();
})->daily();
}
}
Artisan 命令调度
除了通过以 Closure calls
这种方式调度,你还能调度 Artisan 命令 以及系统命令。举个例子,你可以给 command
方法传递命令名称或者类名称来调度一个 Artisan
命令:
$schedule->command('emails:send --force')->daily();
$schedule->command(EmailsCommand::class, ['--force'])->daily();
队列任务调度
job
方法可以用来调度。这个方法提供了一种快捷方式来调度任务,而无需使用 call
方法手动创建闭包来调度任务:
$schedule->job(new Heartbeat)->everyFiveMinutes();
exec
方法可用于向操作系统发出命令:
$schedule->exec('node /home/forge/script.js')->daily();
调度频率设置
当然,你可以为你的任务分配多种调度计划:
这些方法可以合并其它限制条件以生成更精确的调度。例如,计划每周周一的调度:
// 每周一的下午一点钟运行
$schedule->call(function () {
//
})->weekly()->mondays()->at('13:00');
// 周一至周五上午 8 点至下午 5 点每小时运行一次...
$schedule->command('foo')
->weekdays()
->hourly()
->timezone('America/Chicago')
->between('8:00', '17:00');
方法 | 描述 |
---|---|
->weekdays(); | 将任务限制在工作日 |
->sundays(); | 将任务限制在星期天 |
->mondays(); | 将任务限制在星期一 |
->tuesdays(); | 将任务限制在星期二 |
->wednesdays(); | 将任务限制在星期三 |
->thursdays(); | 将任务限制在星期四 |
->fridays(); | 将任务限制在星期五 |
->saturdays(); | 将任务限制在星期六 |
->between($start, $end); | 限制任务运行在开始到结束时间范围内 |
->when(Closure); | 根据闭包函数的返回来限制任务 |
时间范围限制
between
方法可以用来限制一天中某个时间范围内的任务执行:
$schedule->command('reminders:send')
->hourly()
->between('7:00', '22:00');
类似的, unlessBetween
方法可以用来在一段时间内排除任务的执行:
闭包测试限制
when
方法可以用来根据给定的测试的结果来限制任务的执行。换句话说,如果给定的 Closure
返回 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
条件返回 时才运行。
时区
使用 timezone
方法,您可以指定计划任务的时间应该在给定时区内执行:
$schedule->command('report:generate')
->timezone('America/New_York')
->at('02:00')
默认情况,即便有相同的任务还在运行,调度内的任务依旧会被执行。为了避免这个问题,你可以使用 withoutOverlapping
方法:
$schedule->command('emails:send')->withoutOverlapping();
在上面这个例子中,如果没有其它 Artisan 命令 emails:send
在运行的话,此任务将于每分钟被运行一次。如果你的任务在执行时间上有很大的不同,你无法准确预测给定任务需要多长时间, withoutOverlapping
方法将会特别有帮助。
如果需要, 你可以指定在 "without overlapping" 锁过期之前必须经过多少分钟。 默认情况下,锁将在24小时后过期:
$schedule->command('emails:send')->withoutOverlapping(10);
任务只运行在一台服务器上
为了让计划任务只在一台服务器上运行,在定义计划任务时可使用 onOneServer
方法。 原理是获取到该任务的第一台服务器将对该任务加上原子锁,以防止其他服务器同时运行相同的任务:
$schedule->command('report:generate')
->fridays()
->at('17:00')
->onOneServer();
维护模式
当 Laravel 处于 时,Laravel 的调度功能将不会生效。这是因为我们不想让任务调度干扰你服务器上可能还未完成的项目。然而,如果你想强制某个任务在维护模式下运行的话,你可以使用 evenInMaintenanceMode
方法:
Laravel 调度器提供了几个方便的方法来处理调度任务生成的输出。首先,使用 sendOutputTo
方法可以将输出发送到单个文件上以便后续检查:
$schedule->command('emails:send')
->daily()
->sendOutputTo($filePath);
如果想将输出附加到指定的文件上,则可以使用 appendOutputTo
方法:
$schedule->command('emails:send')
->daily()
->appendOutputTo($filePath);
使用 emailOutputTo
方法,你可以通过电子邮件将输出发送到你所指定的邮箱上。在发送任务的输出之前,你应该先配置 Laravel 的 :
$schedule->command('foo')
->daily()
->sendOutputTo($filePath)
->emailOutputTo('foo@example.com');
通过 before
与 after
方法,你可以指定要在调度任务完成之前和之后执行的代码:
$schedule->command('emails:send')
->daily()
->before(function () {
// 任务开始...
})
->after(function () {
// 任务结束...
});
Ping 网址
使用 pingBefore
与 thenPing
方法,调度器可以在任务完成之前或之后自动 ping 给定的 URL。这个方法对于通知外部服务(例如 Laravel Envoyer)你的调度任务正在开始或已经完成执行很有用:
$schedule->command('emails:send')
->daily()
->pingBefore($url)
->thenPing($url);
无论是使用 pingBefore($url)
还是 thenPing($url)
的功能,都需要 Guzzle HTTP 函数库的支持。你可以使用 Composer 将 Guzzle 函数库添加到你的项目中:
本文章首发在 网站上。