任務排程
簡介
過去,你可能曾為伺服器上每個需要排程的任務編寫一條 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
job
方法可用於排程一個佇列 Job。這個方法提供了一種方便的方式來排程佇列 Job,而無需使用 call
方法來定義閉包以將 Job 放入佇列:
use App\Jobs\Heartbeat;
use Illuminate\Support\Facades\Schedule;
Schedule::job(new Heartbeat)->everyFiveMinutes();
可以向 job
方法提供可選的第二和第三個參數,這些參數指定了應用於將 Job 放入佇列的佇列名稱和佇列連線:
use App\Jobs\Heartbeat;
use Illuminate\Support\Facades\Schedule;
// 將 Job 放入 "sqs" 連線上的 "heartbeats" 佇列...
Schedule::job(new Heartbeat, 'heartbeats', 'sqs')->everyFiveMinutes();
排程 Shell 命令
exec
方法可用於向作業系統發出命令:
use Illuminate\Support\Facades\Schedule;
Schedule::exec('node /home/forge/script.js')->daily();
排程頻率選項
我們已經看過一些如何設定任務在特定時間間隔執行的範例。然而,您可以為任務指定更多的排程頻率選項:
方法 | 描述 |
---|---|
->cron('* * * * *'); | 依自訂 cron 排程執行任務。 |
->everySecond(); | 每秒執行任務。 |
->everyTwoSeconds(); | 每兩秒執行任務。 |
->everyFiveSeconds(); | 每五秒執行任務。 |
->everyTenSeconds(); | 每十秒執行任務。 |
->everyFifteenSeconds(); | 每十五秒執行任務。 |
->everyTwentySeconds(); | 每二十秒執行任務。 |
->everyThirtySeconds(); | 每三十秒執行任務。 |
->everyMinute(); | 每分鐘執行任務。 |
->everyTwoMinutes(); | 每兩分鐘執行任務。 |
->everyThreeMinutes(); | 每三分鐘執行任務。 |
->everyFourMinutes(); | 每四分鐘執行任務。 |
->everyFiveMinutes(); | 每五分鐘執行任務。 |
->everyTenMinutes(); | 每十分鐘執行任務。 |
->everyFifteenMinutes(); | 每十五分鐘執行任務。 |
->everyThirtyMinutes(); | 每三十分鐘執行任務。 |
->hourly(); | 每小時執行任務。 |
->hourlyAt(17); | 每小時的第 17 分鐘執行任務。 |
->everyOddHour($minutes = 0); | 每隔一小時(奇數小時)執行任務。 |
->everyTwoHours($minutes = 0); | 每兩小時執行任務。 |
->everyThreeHours($minutes = 0); | 每三小時執行任務。 |
->everyFourHours($minutes = 0); | 每四小時執行任務。 |
->everySixHours($minutes = 0); | 每六小時執行任務。 |
->daily(); | 每天午夜執行任務。 |
->dailyAt('13:00'); | 每天 13:00 執行任務。 |
->twiceDaily(1, 13); | 每天 1:00 和 13:00 執行任務。 |
->twiceDailyAt(1, 13, 15); | 每天 1:15 和 13:15 執行任務。 |
->weekly(); | 每週日 00:00 執行任務。 |
->weeklyOn(1, '8:00'); | 每週一 8:00 執行任務。 |
->monthly(); | 每月的第一天 00:00 執行任務。 |
->monthlyOn(4, '15:00'); | 每月 4 號 15:00 執行任務。 |
->twiceMonthly(1, 16, '13:00'); | 每月 1 號和 16 號的 13:00 執行任務。 |
->lastDayOfMonth('15:00'); | 每月最後一天 15:00 執行任務。 |
->quarterly(); | 每季度第一天 00:00 執行任務。 |
->quarterlyOn(4, '14:00'); | 每季度 4 號 14:00 執行任務。 |
->yearly(); | 每年第一天 00:00 執行任務。 |
->yearlyOn(6, 1, '17:00'); | 每年 6 月 1 日 17:00 執行任務。 |
->timezone('America/New_York'); | 設定任務的時區。 |
這些方法可以與額外限制結合使用,以建立更精確的排程,使其僅在特定的星期幾執行。例如,您可以排程一個命令在每週一執行:
use Illuminate\Support\Facades\Schedule;
// 每週一於下午 1 點執行一次...
Schedule::call(function () {
// ...
})->weekly()->mondays()->at('13:00');
// 在工作日從上午 8 點到下午 5 點每小時執行一次...
Schedule::command('foo')
->weekdays()
->hourly()
->timezone('America/Chicago')
->between('8:00', '17:00');
額外排程限制的列表可在下方找到:
方法 | 描述 |
---|---|
->weekdays(); | 將任務限制在工作日執行。 |
->weekends(); | 將任務限制在週末執行。 |
->sundays(); | 將任務限制在星期日執行。 |
->mondays(); | 將任務限制在星期一執行。 |
->tuesdays(); | 將任務限制在星期二執行。 |
->wednesdays(); | 將任務限制在星期三執行。 |
->thursdays(); | 將任務限制在星期四執行。 |
->fridays(); | 將任務限制在星期五執行。 |
->saturdays(); | 將任務限制在星期六執行。 |
->days(array|mixed); | 將任務限制在特定日期執行。 |
->between($startTime, $endTime); | 將任務限制在開始時間與結束時間之間執行。 |
->unlessBetween($startTime, $endTime); | 將任務限制在開始時間與結束時間之間不執行。 |
->when(Closure); | 根據條件測試限制任務。 |
->environments($env); | 將任務限制在特定環境中執行。 |
日期限制
可以使用 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
方法根據給定條件測試的結果來限制任務的執行。換句話說,如果給定的閉包(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
條件都返回 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' => '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 命令來清除這些快取鎖定。這通常僅在任務因意外的伺服器問題而卡住時才需要。
在單一伺服器上執行任務
⚠️ 警告
若要使用此功能,您的應用程式必須使用 database
、memcached
、dynamodb
或 redis
快取驅動程式作為應用程式的預設快取驅動程式。此外,所有伺服器必須與相同的中央快取伺服器進行通訊。
如果您的應用程式的排程器在多個伺服器上運行,您可以將排程的 Job 限制為僅在單一伺服器上執行。例如,假設您有一個排程任務,它會在每個週五晚上產生一份新報告。如果任務排程器在三個工作伺服器上運行,排程任務將在所有三個伺服器上運行並產生三次報告。這不好!
若要指示任務應僅在一個伺服器上執行,請在定義排程任務時使用 onOneServer
方法。第一個獲得任務的伺服器將獲得該 Job 的原子鎖定,以防止其他伺服器同時運行相同的任務:
use Illuminate\Support\Facades\Schedule;
Schedule::command('report:generate')
->fridays()
->at('17:00')
->onOneServer();
命名單一伺服器 Job
有時您可能需要排程相同的 Job 以不同的參數分派,同時仍指示 Laravel 在單一伺服器上運行 Job 的每個排列。為此,您可以透過 name
方法為每個排程定義指派一個唯一的名稱:
Schedule::job(new CheckUptime('https://laravel.com'))
->name('check_uptime:laravel.com')
->everyFiveMinutes()
->onOneServer();
Schedule::job(new CheckUptime('https://vapor.laravel.com'))
->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();
⚠️ 警告
runInBackground
方法只能在使用 command
和 exec
方法排程任務時使用。
維護模式
當應用程式處於維護模式時,應用程式的排程任務將不會運行,因為我們不希望您的任務干擾您可能在伺服器上執行的任何未完成的維護。但是,如果您想強制任務即使在維護模式下也能運行,您可以在定義任務時呼叫 evenInMaintenanceMode
方法:
Schedule::command('emails:send')->evenInMaintenanceMode();
排程群組
當定義多個具有相似設定的排程任務時,您可以使用 Laravel 的任務分組功能來避免為每個任務重複相同的設定。分組任務簡化了您的程式碼,並確保相關任務之間的一致性。
若要建立排程任務群組,請呼叫所需的任務設定方法,然後呼叫 group
方法。group
方法接受一個閉包,該閉包負責定義共享指定設定的任務:
use Illuminate\Support\Facades\Schedule;
Schedule::daily()
->onOneServer()
->timezone('America/New_York')
->group(function () {
Schedule::command('emails:send --force');
Schedule::command('emails:prune');
});
執行排程器
既然我們已經學會如何定義排程任務,接下來將討論如何在我們的伺服器上實際執行這些任務。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 job 的執行頻率最高限制為每分鐘一次。然而,Laravel 的排程器允許您以更頻繁的間隔排程任務,甚至可以每秒執行一次:
use Illuminate\Support\Facades\Schedule;
Schedule::call(function () {
DB::table('recent_users')->delete();
})->everySecond();
當在應用程式中定義次分鐘任務時,schedule:run
命令將會持續執行直到當前分鐘結束,而不會立即退出。這使得命令可以在該分鐘內呼叫所有必要的次分鐘任務。
由於執行時間超乎預期的次分鐘任務可能會延遲後續次分鐘任務的執行,因此建議所有次分鐘任務都分派佇列 job 或背景命令來處理實際的任務執行:
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]');
[!WARNING] emailOutputTo
、emailOutputOnFailure
、sendOutputTo
和 appendOutputTo
方法僅限用於 command
和 exec
方法。
任務 Hooks
使用 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...
});
如果命令有輸出,您可以在 after
、onSuccess
或 onFailure
hooks 中,透過類型提示 (type-hinting) Illuminate\Support\Stringable
實例作為 hook 閉包定義的 $output
參數來存取它:
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);
pingOnSuccess
和 pingOnFailure
方法可用於僅在任務成功或失敗時 ping 指定的 URL。失敗表示排程的 Artisan 或系統命令以非零結束代碼終止:
Schedule::command('emails:send')
->daily()
->pingOnSuccess($successUrl)
->pingOnFailure($failureUrl);
pingBeforeIf
、thenPingIf
、pingOnSuccessIf
和 pingOnFailureIf
方法可用於僅在指定條件為 true
時 ping 指定的 URL:
Schedule::command('emails:send')
->daily()
->pingBeforeIf($condition, $url)
->thenPingIf($condition, $url);
Schedule::command('emails:send')
->daily()
->pingOnSuccessIf($condition, $successUrl)
->pingOnFailureIf($condition, $failureUrl);
事件
Laravel 在排程過程中會分派各種 事件。您可以為以下任何事件 定義監聽器:
事件名稱 |
---|
Illuminate\Console\Events\ScheduledTaskStarting |
Illuminate\Console\Events\ScheduledTaskFinished |
Illuminate\Console\Events\ScheduledBackgroundTaskFinished |
Illuminate\Console\Events\ScheduledTaskSkipped |
Illuminate\Console\Events\ScheduledTaskFailed |