在以前,開發(fā)者需要為每一個需要調(diào)度然后添加這些Cron條目。Laravel命令調(diào)度器允許你平滑而又富有表現(xiàn)力地在Laravel中定義命令調(diào)度,并且服務器上只需要一個Cron條目即可。
任務調(diào)度定義在app/Console/Kernel.php
文件的schedule
方法中,該方法中已經(jīng)包含了一個示例。你可以自由地添加你需要的調(diào)度任務到Schedule
對象。
下面是你唯一需要添加到服務器的Cron條目:
* * * * * php /path/to/artisan schedule:run 1>> /dev/null 2>&1
該Cron將會每分鐘調(diào)用Laravel命令調(diào)度,然后,Laravel評估你的調(diào)度任務并運行到期的任務。
你可以在App\Console\Kernel
類的schedule
方法中定義所有調(diào)度任務。開始之前,讓我們看一個調(diào)度任務的例子,在這個例子中,我們將會在每天午夜調(diào)度一個被調(diào)用的閉包。在這個閉包中我們將會執(zhí)行一個數(shù)據(jù)庫查詢來清空表:
<?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 = [
'App\Console\Commands\Inspire',
];
/**
* 定義應用的命令調(diào)度
*
* @param \Illuminate\Console\Scheduling\Schedule $schedule
* @return void
*/
protected function schedule(Schedule $schedule)
{
$schedule->call(function () {
DB::table('recent_users')->delete();
})->daily();
}
}
除了調(diào)度閉包調(diào)用外,還可以調(diào)度Artisan命令和操作系統(tǒng)命令。例如,可以使用command
方法來調(diào)度一個Artisan命令:
$schedule->command('emails:send --force')->daily();
exec
命令可用于發(fā)送命令到操作系統(tǒng):
$schedule->exec('node /home/forge/script.js')->daily();
當然,你可以分配多種調(diào)度到任務:
方法 | 描述 |
---|---|
->cron('* * * * *'); |
在自定義Cron調(diào)度上運行任務 |
->everyMinute(); |
每分鐘運行一次任務 |
->everyFiveMinutes(); |
每五分鐘運行一次任務 |
->everyTenMinutes(); |
每十分鐘運行一次任務 |
->everyThirtyMinutes(); |
每三十分鐘運行一次任務 |
->hourly(); |
每小時運行一次任務 |
->daily(); |
每天凌晨零點運行任務 |
->dailyAt('13:00'); |
每天13:00運行任務 |
->twiceDaily(1, 13); |
每天1:00 & 13:00運行任務 |
->weekly(); |
每周運行一次任務 |
->monthly(); |
每月運行一次任務 |
這些方法可以和額外的約束一起聯(lián)合起來創(chuàng)建一周特定時間運行的更加細粒度的調(diào)度,例如,要每周一調(diào)度一個命令:
$schedule->call(function () {
// 每周星期一13:00運行一次...
})->weekly()->mondays()->at('13:00');
下面是額外的調(diào)度約束列表:
方法 | 描述 |
---|---|
->weekdays(); |
只在工作日運行任務 |
->sundays(); |
每個星期天運行任務 |
->mondays(); |
每個星期一運行任務 |
->tuesdays(); |
每個星期二運行任務 |
->wednesdays(); |
每個星期三運行任務 |
->thursdays(); |
每個星期四運行任務 |
->fridays(); |
每個星期五運行任務 |
->saturdays(); |
每個星期六運行任務 |
->when(Closure); |
基于特定測試運行任務 |
when
方法用于限制任務在通過給定測試之后運行。換句話說,如果給定閉包返回true
,只要沒有其它約束條件阻止任務運行,該任務就會執(zhí)行:
$schedule->command('emails:send')->daily()->when(function () {
return true;
});
默認情況下,即使前一個任務仍然在運行調(diào)度任務也會運行,要避免這樣的情況,可使用withoutOverlapping
方法:
$schedule->command('emails:send')->withoutOverlapping();
在本例中,Artisan命令emails:send
每分鐘都會運行,如果該命令沒有在運行的話。如果你的任務在執(zhí)行時經(jīng)常大幅度的變化,那么withoutOverlapping
方法就非常有用,你不必再去預測給定任務到底要消耗多長時間。
Laravel調(diào)度器為處理調(diào)度任務輸出提供了多個方便的方法。首先,使用sendOutputTo
方法,你可以發(fā)送輸出到文件以便稍后檢查:
$schedule->command('emails:send')
->daily()
->sendOutputTo($filePath);
使用emailOutputTo
方法,你可以將輸出發(fā)送到電子郵件,注意輸出必須首先通過sendOutputTo
方法發(fā)送到文件。還有,使用電子郵件發(fā)送任務輸出之前,應該配置Laravel的電子郵件服務:
$schedule->command('foo')
->daily()
->sendOutputTo($filePath)
->emailOutputTo('foo@example.com');
注意:
emailOutputTo
和sendOutputTo
方法只對command
方法有效,不支持call
方法。
使用before
和after
方法,你可以指定在調(diào)度任務完成之前和之后要執(zhí)行的代碼:
$schedule->command('emails:send')
->daily()
->before(function () {
// Task is about to start...
})
->after(function () {
// Task is complete...
});
使用pingBefore
和thenPing
方法,調(diào)度器可以在任務完成之前和之后自動ping給定的URL。該方法在通知外部服務時很有用,例如Laravel Envoyer,在調(diào)度任務開始或完成的時候:
$schedule->command('emails:send')
->daily()
->pingBefore($url)
->thenPing($url);
使用pingBefore($url)
或thenPing($url)
特性需要安裝HTTP庫Guzzle,可以在composer.json
?文件中添加如下行來安裝Guzzle到項目:
"guzzlehttp/guzzle": "~5.3|~6.0"
更多建議: