イントロダクションIntroduction
以前は、サーバでスケジュールする必要のあるタスクごとにcron設定エントリを作成する必要がありました。しかしながら、タスクスケジュールがソース管理されないため、これはすぐに苦痛になる可能性があります。既存のcronエントリを表示したり、エントリを追加したりするには、サーバへSSHで接続する必要がありました。In the past, you may have written a cron configuration entry for each task you needed to schedule on your server. However, this can quickly become a pain because your task schedule is no longer in source control and you must SSH into your server to view your existing cron entries or add additional entries.
Laravelのコマンドスケジューラは、サーバ上のタスクのスケジュールを管理する新しいアプローチを提供します。このスケジューラを使用すると、Laravelアプリケーション内でコマンドスケジュールをスムーズかつ表現的に定義できます。スケジューラを使用する場合、サーバ上に必要なcronエントリーは1つだけです。タスクスケジュールは通常、アプリケーションのroutes/console.php
ファイルで定義します。Laravel's command scheduler offers a fresh approach to managing scheduled tasks on your server. The scheduler allows you to fluently and expressively define your command schedule within your Laravel application itself. When using the scheduler, only a single cron entry is needed on your server. Your task schedule is typically defined in your application's routes/console.php
file.
スケジュール定義Defining Schedules
アプリケーションのroutes/console.php
ファイルですべてのスケジュールタスクを定義できます。始めに、例を見てみましょう。この例では、毎日午前0時に呼び出すクロージャをスケジュールしています。クロージャの中で、テーブルをクリアするためにデータベースクエリを実行しています。You may define all of your scheduled tasks in your application's routes/console.php
file. To get started, let's take a look at an example. In this example, we will schedule a closure to be called every day at midnight. Within the closure we will execute a database query to clear a table:
<?php
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Facades\Schedule;
Schedule::call(function () {
DB::table('recent_users')->delete();
})->daily();
クロージャを使用したスケジュールに加えて、呼び出し可能なオブジェクトをスケジュールすることもできます。呼び出し可能なオブジェクトは、__invoke
メソッドを含む単純なPHPクラスです。In addition to scheduling using closures, you may also schedule invokable objects[https://secure.php.net/manual/en/language.oop5.magic.php#object.invoke]. Invokable objects are simple PHP classes that contain an __invoke
method:
Schedule::call(new DeleteRecentUsers)->daily();
routes/console.php
ファイルをコマンド定義のためだけに使用したい場合は、アプリケーションのbootstrap/app.php
ファイルでwithSchedule
メソッドを使用して、スケジュールするタスクを定義できます。このメソッドは、スケジューラのインスタンスを受け取るクロージャを引数に取ります。If you prefer to reserve your routes/console.php
file for command definitions only, you may use the withSchedule
method in your application's bootstrap/app.php
file to define your scheduled tasks. This method accepts a closure that receives an instance of the scheduler:
use Illuminate\Console\Scheduling\Schedule;
->withSchedule(function (Schedule $schedule) {
$schedule->call(new DeleteRecentUsers)->daily();
})
スケジュールしたタスクの概要と、次に実行がスケジュールされている時間を表示したい場合は、schedule:list
Artisanコマンドを使用します。If you would like to view an overview of your scheduled tasks and the next time they are scheduled to run, you may use the schedule:list
Artisan command:
php artisan schedule:list
ArtisanコマンドのスケジュールScheduling Artisan Commands
クロージャのスケジュールに加えて、Artisanコマンドおよびシステムコマンドをスケジュールすることもできます。たとえば、command
メソッドを使用して、コマンドの名前またはクラスのいずれかを使用してArtisanコマンドをスケジュールできます。In addition to scheduling closures, you may also schedule Artisan commands[/docs/{{version}}/artisan] and system commands. For example, you may use the command
method to schedule an Artisan command using either the command's name or class.
コマンドのクラス名を使用してArtisanコマンドをスケジュールする場合、コマンドが呼び出されたときにコマンドに提供する必要がある追加のコマンドライン引数の配列を渡せます。When scheduling Artisan commands using the command's class name, you may pass an array of additional command-line arguments that should be provided to the command when it is invoked:
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クロージャコマンドのスケジュールScheduling Artisan Closure Commands
クロージャで定義したArtisanコマンドをスケジューリングしたい場合は、コマンド定義の後にスケジューリング関連のメソッドをチェーンしてください。If you want to schedule an Artisan command defined by a closure, you may chain the scheduling related methods after the command's definition:
Artisan::command('delete:recent-users', function () {
DB::table('recent_users')->delete();
})->purpose('Delete recent users')->daily();
クロージャコマンドへ引数を渡す必要がある場合は、schedule
メソッドへ渡してください。If you need to pass arguments to the closure command, you may provide them to the schedule
method:
Artisan::command('emails:send {user} {--force}', function ($user) {
// ...
})->purpose('Send emails to the specified user')->schedule(['Taylor', '--force'])->daily();
キュー投入するジョブのスケジュールScheduling Queued Jobs
キュー投入するジョブをスケジュールするには、job
メソッドを使います。このメソッドを使うと、ジョブをキューに入れるためのクロージャを自前で作成するcall
メソッドを使わずとも、ジョブをスケジュール実行できます。The job
method may be used to schedule a queued job[/docs/{{version}}/queues]. This method provides a convenient way to schedule queued jobs without using the call
method to define closures to queue the job:
use App\Jobs\Heartbeat;
use Illuminate\Support\Facades\Schedule;
Schedule::job(new Heartbeat)->everyFiveMinutes();
オプションの2番目と3番目の引数をjob
メソッドに指定して、ジョブのキューに入れるために使用するキュー名とキュー接続を指定できます。Optional second and third arguments may be provided to the job
method which specifies the queue name and queue connection that should be used to queue the job:
use App\Jobs\Heartbeat;
use Illuminate\Support\Facades\Schedule;
// "sqs"接続の"heartbeats"キューにジョブをディスパッチ
Schedule::job(new Heartbeat, 'heartbeats', 'sqs')->everyFiveMinutes();
シェルコマンドのスケジュールScheduling Shell Commands
オペレーティングシステムでコマンドを実行するためにはexec
メソッドを使います。The exec
method may be used to issue a command to the operating system:
use Illuminate\Support\Facades\Schedule;
Schedule::exec('node /home/forge/script.js')->daily();
繰り返しのスケジュールオプションSchedule Frequency Options
指定間隔で実行するようにタスクを設定する方法の例をいくつか見てきました。しかし、タスクに割り当てることができるタスクスケジュールの間隔は他にもたくさんあります。We've already seen a few examples of how you may configure a task to run at specified intervals. However, there are many more task schedule frequencies that you may assign to a task:
メソッドMethod | 説明Description |
---|---|
->cron('* * * * *'); ->cron('* * * * *'); |
カスタムcronスケジュールでタスクを実行Run the task on a custom cron schedule. |
->everySecond(); ->everySecond(); |
毎秒タスク実行Run the task every second. |
->everyTwoSeconds(); ->everyTwoSeconds(); |
2秒毎にタスク実行Run the task every two seconds. |
->everyFiveSeconds(); ->everyFiveSeconds(); |
5秒毎にタスク実行Run the task every five seconds. |
->everyTenSeconds(); ->everyTenSeconds(); |
10秒ごとにタスク実行Run the task every ten seconds. |
->everyFifteenSeconds(); ->everyFifteenSeconds(); |
15秒毎にタスク実行Run the task every fifteen seconds. |
->everyTwentySeconds(); ->everyTwentySeconds(); |
20秒ごとにタスク実行Run the task every twenty seconds. |
->everyThirtySeconds(); ->everyThirtySeconds(); |
30秒ごとにタスク実行Run the task every thirty seconds. |
->everyMinute(); ->everyMinute(); |
毎分タスク実行Run the task every minute. |
->everyTwoMinutes(); ->everyTwoMinutes(); |
2分毎にタスク実行Run the task every two minutes. |
->everyThreeMinutes(); ->everyThreeMinutes(); |
3分毎にタスク実行Run the task every three minutes. |
->everyFourMinutes(); ->everyFourMinutes(); |
4分毎にタスク実行Run the task every four minutes. |
->everyFiveMinutes(); ->everyFiveMinutes(); |
5分毎にタスク実行Run the task every five minutes. |
->everyTenMinutes(); ->everyTenMinutes(); |
10分毎にタスク実行Run the task every ten minutes. |
->everyFifteenMinutes(); ->everyFifteenMinutes(); |
15分毎にタスク実行Run the task every fifteen minutes. |
->everyThirtyMinutes(); ->everyThirtyMinutes(); |
30分毎にタスク実行Run the task every thirty minutes. |
->hourly(); ->hourly(); |
毎時タスク実行Run the task every hour. |
->hourlyAt(17); ->hourlyAt(17); |
1時間ごと、毎時17分にタスク実行Run the task every hour at 17 minutes past the hour. |
->everyOddHour($minutes = 0); ->everyOddHour($minutes = 0); |
奇数時間ごとにタスク実行Run the task every odd hour. |
->everyTwoHours($minutes = 0); ->everyTwoHours($minutes = 0); |
2時間毎にタスク実行Run the task every two hours. |
->everyThreeHours($minutes = 0); ->everyThreeHours($minutes = 0); |
3時間毎にタスク実行Run the task every three hours. |
->everyFourHours($minutes = 0); ->everyFourHours($minutes = 0); |
4時間毎にタスク実行Run the task every four hours. |
->everySixHours($minutes = 0); ->everySixHours($minutes = 0); |
6時間毎にタスク実行Run the task every six hours. |
->daily(); ->daily(); |
毎日深夜12時に実行Run the task every day at midnight. |
->dailyAt('13:00'); ->dailyAt('13:00'); |
毎日13:00に実行Run the task every day at 13:00. |
->twiceDaily(1, 13); ->twiceDaily(1, 13); |
毎日1:00と13:00に実行Run the task daily at 1:00 & 13:00. |
->twiceDailyAt(1, 13, 15); ->twiceDailyAt(1, 13, 15); |
毎日1:15と13:15に実行Run the task daily at 1:15 & 13:15. |
->weekly(); ->weekly(); |
毎週日曜日の00:00にタスク実行Run the task every Sunday at 00:00. |
->weeklyOn(1, '8:00'); ->weeklyOn(1, '8:00'); |
毎週月曜日の8:00に実行Run the task every week on Monday at 8:00. |
->monthly(); ->monthly(); |
毎月1日の00:00にタスク実行Run the task on the first day of every month at 00:00. |
->monthlyOn(4, '15:00'); ->monthlyOn(4, '15:00'); |
毎月4日の15:00に実行Run the task every month on the 4th at 15:00. |
->twiceMonthly(1, 16, '13:00'); ->twiceMonthly(1, 16, '13:00'); |
毎月1日と16日の13:00にタスク実行Run the task monthly on the 1st and 16th at 13:00. |
->lastDayOfMonth('15:00'); ->lastDayOfMonth('15:00'); |
毎月最終日の15:00に実行Run the task on the last day of the month at 15:00. |
->quarterly(); ->quarterly(); |
四半期の初日の00:00にタスク実行Run the task on the first day of every quarter at 00:00. |
->quarterlyOn(4, '14:00'); ->quarterlyOn(4, '14:00'); |
四半期の4日の14:00に実行Run the task every quarter on the 4th at 14:00. |
->yearly(); ->yearly(); |
毎年1月1日の00:00にタスク実行Run the task on the first day of every year at 00:00. |
->yearlyOn(6, 1, '17:00'); ->yearlyOn(6, 1, '17:00'); |
毎年6月1日の17:00にタスク実行Run the task every year on June 1st at 17:00. |
->timezone('America/New_York'); ->timezone('America/New_York'); |
タスクのタイムゾーンを設定Set the timezone for the task. |
これらの方法を追加の制約と組み合わせてると、特定の曜日にのみ実行する、さらに細かく調整したスケジュールを作成できます。たとえば、毎週月曜日に実行するようにコマンドをスケジュールできます。These methods may be combined with additional constraints to create even more finely tuned schedules that only run on certain days of the week. For example, you may schedule a command to run weekly on Monday:
use Illuminate\Support\Facades\Schedule;
// 週に1回、月曜の13:00に実行
Schedule::call(function () {
// ...
})->weekly()->mondays()->at('13:00');
// ウィークデーの8時から17時まで1時間ごとに実行
Schedule::command('foo')
->weekdays()
->hourly()
->timezone('America/Chicago')
->between('8:00', '17:00');
追加のスケジュール制約のリストを以下にリストします。A list of additional schedule constraints may be found below:
メソッドMethod | 説明Description |
---|---|
->weekdays(); ->weekdays(); |
ウィークデーのみに限定Limit the task to weekdays. |
->weekends(); ->weekends(); |
ウィークエンドのみに限定Limit the task to weekends. |
->sundays(); ->sundays(); |
日曜だけに限定Limit the task to Sunday. |
->mondays(); ->mondays(); |
月曜だけに限定Limit the task to Monday. |
->tuesdays(); ->tuesdays(); |
火曜だけに限定Limit the task to Tuesday. |
->wednesdays(); ->wednesdays(); |
水曜だけに限定Limit the task to Wednesday. |
->thursdays(); ->thursdays(); |
木曜だけに限定Limit the task to Thursday. |
->fridays(); ->fridays(); |
金曜だけに限定Limit the task to Friday. |
->saturdays(); ->saturdays(); |
土曜だけに限定Limit the task to Saturday. |
->days(array|mixed); ->days(array|mixed); |
特定の日付だけに限定Limit the task to specific days. |
->between($startTime, $endTime); ->between($startTime, $endTime); |
開始と終了時間間にタスク実行を制限Limit the task to run between start and end times. |
->unlessBetween($startTime, $endTime); ->unlessBetween($startTime, $endTime); |
開始と終了時間間にタスクを実行しないよう制限Limit the task to not run between start and end times. |
->when(Closure); ->when(Closure); |
クロージャの戻り値がtrue の時のみに限定Limit the task based on a truth test. |
->environments($env); ->environments($env); |
指定の環境でのみタスク実行を限定Limit the task to specific environments. |
曜日の限定Day Constraints
days
メソッドはタスクを週の指定した曜日に実行するように制限するために使用します。たとえば、日曜日と水曜日に毎時コマンドを実行するようにスケジュールするには次のように指定します。The days
method may be used to limit the execution of a task to specific days of the week. For example, you may schedule a command to run hourly on Sundays and Wednesdays:
use Illuminate\Support\Facades\Schedule;
Schedule::command('emails:send')
->hourly()
->days([0, 3]);
または、タスクを実行する日を定義するときに、Illuminate\Console\Scheduling\Schedule
クラスで使用可能な定数を使用することもできます。Alternatively, you may use the constants available on the Illuminate\Console\Scheduling\Schedule
class when defining the days on which a task should run:
use Illuminate\Support\Facades;
use Illuminate\Console\Scheduling\Schedule;
Facades\Schedule::command('emails:send')
->hourly()
->days([Schedule::SUNDAY, Schedule::WEDNESDAY]);
時間制限Between Time Constraints
between
メソッドは一日の時間に基づき、実行時間を制限するために使用します。The between
method may be used to limit the execution of a task based on the time of day:
Schedule::command('emails:send')
->hourly()
->between('7:00', '22:00');
同じように、unlessBetween
メソッドは、その時間にタスクの実行を除外するために使用します。Similarly, the unlessBetween
method can be used to exclude the execution of a task for a period of time:
Schedule::command('emails:send')
->hourly()
->unlessBetween('23:00', '4:00');
論理テスト制約Truth Test Constraints
when
メソッドを使用して、特定の論理テストの結果に基づいてタスクの実行を制限できます。言い換えると、指定するクロージャがtrue
を返す場合、他の制約条件がタスクの実行を妨げない限り、タスクは実行されます。The when
method may be used to limit the execution of a task based on the result of a given truth test. In other words, if the given closure returns true
, the task will execute as long as no other constraining conditions prevent the task from running:
Schedule::command('emails:send')->daily()->when(function () {
return true;
});
skip
メソッドはwhen
をひっくり返したものです。skip
メソッドへ渡したクロージャがtrue
を返した時、スケジュールタスクは実行されません。The skip
method may be seen as the inverse of when
. If the skip
method returns true
, the scheduled task will not be executed:
Schedule::command('emails:send')->daily()->skip(function () {
return true;
});
when
メソッドをいくつかチェーンした場合は、全部のwhen
条件がtrue
を返すときのみスケジュールされたコマンドが実行されます。When using chained when
methods, the scheduled command will only execute if all when
conditions return true
.
環境制約Environment Constraints
environments
メソッドは、指定する環境でのみタスクを実行するために使用できます(APP_ENV
環境変数で定義されます。)The environments
method may be used to execute tasks only on the given environments (as defined by the APP_ENV
environment variable[/docs/{{version}}/configuration#environment-configuration]):
Schedule::command('emails:send')
->daily()
->environments(['staging', 'production']);
タイムゾーンTimezones
timezone
メソッドを使い、タスクのスケジュールをどこのタイムゾーンとみなすか指定できます。Using the timezone
method, you may specify that a scheduled task's time should be interpreted within a given timezone:
use Illuminate\Support\Facades\Schedule;
Schedule::command('report:generate')
->timezone('America/New_York')
->at('2:00')
すべてのスケジュールタスクに同じタイムゾーンを繰り返し割り当てている場合は、アプリケーションのapp
設定ファイルでschedule_timezone
オプションを定義すれば、すべてのスケジュールに割り当てるタイムゾーンを指定できます。If you are repeatedly assigning the same timezone to all of your scheduled tasks, you can specify which timezone should be assigned to all schedules by defining a schedule_timezone
option within your application's app
configuration file:
'timezone' => env('APP_TIMEZONE', 'UTC'),
'schedule_timezone' => 'America/Chicago',
[!WARNING]
Warning! タイムゾーンの中には夏時間を取り入れているものがあることを忘れないでください。夏時間の切り替えにより、スケジュールしたタスクが2回実行されたり、まったくされないことがあります。そのため、可能であればタイムゾーンによるスケジュールは使用しないことを推奨します。
Remember that some timezones utilize daylight savings time. When daylight saving time changes occur, your scheduled task may run twice or even not run at all. For this reason, we recommend avoiding timezone scheduling when possible.
タスク多重起動の防止Preventing Task Overlaps
デフォルトでは以前の同じジョブが起動中であっても、スケジュールされたジョブは実行されます。これを防ぐには、withoutOverlapping
メソッドを使用してください。By default, scheduled tasks will be run even if the previous instance of the task is still running. To prevent this, you may use the withoutOverlapping
method:
use Illuminate\Support\Facades\Schedule;
Schedule::command('emails:send')->withoutOverlapping();
この例の場合、emails:send
Artisanコマンドは実行中でない限り毎分実行されます。withoutOverlapping
メソッドは指定したタスクの実行時間の変動が非常に大きく、予想がつかない場合にとくに便利です。In this example, the emails:send
Artisan command[/docs/{{version}}/artisan] will be run every minute if it is not already running. The withoutOverlapping
method is especially useful if you have tasks that vary drastically in their execution time, preventing you from predicting exactly how long a given task will take.
必要であれば、「重起動の防止(without overlapping)」ロックを期限切れにするまでに、何分間経過させるかを指定できます。時間切れまでデフォルトは、24時間です。If needed, you may specify how many minutes must pass before the "without overlapping" lock expires. By default, the lock will expire after 24 hours:
Schedule::command('emails:send')->withoutOverlapping(10);
withoutOverlapping
メソッドは、動作の裏でアプリケーションのキャッシュを利用してロックを取得します。必要であれば、schedule:clear-cache
Artisanコマンドを使用して、これらのキャッシュ・ロックを解除できます。これは通常、予期しないサーバの問題でタスクがスタックした場合のみ必要です。Behind the scenes, the withoutOverlapping
method utilizes your application's cache[/docs/{{version}}/cache] to obtain locks. If necessary, you can clear these cache locks using the schedule:clear-cache
Artisan command. This is typically only necessary if a task becomes stuck due to an unexpected server problem.
単一サーバ上でのタスク実行Running Tasks on One Server
Warning! この機能を利用するには、アプリケーションのデフォルトのキャッシュドライバとして
database
、memcached
、dynamodb
、redis
キャッシュドライバを使用している必要があります。さらに、すべてのサーバが同じ中央キャッシュサーバと通信している必要があります。[!WARNING]
To utilize this feature, your application must be using thedatabase
,memcached
,dynamodb
, orredis
cache driver as your application's default cache driver. In addition, all servers must be communicating with the same central cache server.
アプリケーションのスケジューラを複数のサーバで実行する場合は、スケジュールしたジョブを単一のサーバでのみ実行するように制限できます。たとえば、毎週金曜日の夜に新しいレポートを生成するスケジュールされたタスクがあるとします。タスクスケジューラが3つのワーカーサーバで実行されている場合、スケジュールされたタスクは3つのサーバすべてで実行され、レポートを3回生成してしまいます。これは良くありません!If your application's scheduler is running on multiple servers, you may limit a scheduled job to only execute on a single server. For instance, assume you have a scheduled task that generates a new report every Friday night. If the task scheduler is running on three worker servers, the scheduled task will run on all three servers and generate the report three times. Not good!
タスクをサーバひとつだけで実行するように指示するには、スケジュールタスクを定義するときにonOneServer
メソッドを使用します。このタスクを最初に取得したサーバが、同じタスクを同じCronサイクルで他のサーバで実行しないように、ジョブにアトミックなロックを確保します。To indicate that the task should run on only one server, use the onOneServer
method when defining the scheduled task. The first server to obtain the task will secure an atomic lock on the job to prevent other servers from running the same task at the same time:
use Illuminate\Support\Facades\Schedule;
Schedule::command('report:generate')
->fridays()
->at('17:00')
->onOneServer();
サーバジョブに一意名を付けるNaming Single Server Jobs
Laravelに対して単一サーバ上でジョブの各順列を実行するように指示しながら、同じジョブを異なるパラメータでディスパッチするようにスケジュールする必要がある場合があります。これを実現するには、name
メソッドを使用して各スケジュール定義に一意の名前を割り当てます。Sometimes you may need to schedule the same job to be dispatched with different parameters, while still instructing Laravel to run each permutation of the job on a single server. To accomplish this, you may assign each schedule definition a unique name via the name
method:
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();
同様に、1サーバで実行することを意図している場合、スケジュールするクロージャへ名前を割り当てる必要があります。Similarly, scheduled closures must be assigned a name if they are intended to be run on one server:
Schedule::call(fn () => User::resetApiRequestCount())
->name('reset-api-request-count')
->daily()
->onOneServer();
バックグランドタスクBackground Tasks
デフォルトでは、同時にスケジュールされた複数のタスクは、schedule
メソッドで定義された順序に基づいて順番に実行されます。長時間実行されるタスクがある場合、これにより、後続のタスクが予想よりもはるかに遅く開始される可能性があります。タスクをすべて同時に実行できるようにバックグラウンドで実行する場合は、runInBackground
メソッドを使用できます。By default, multiple tasks scheduled at the same time will execute sequentially based on the order they are defined in your schedule
method. If you have long-running tasks, this may cause subsequent tasks to start much later than anticipated. If you would like to run tasks in the background so that they may all run simultaneously, you may use the runInBackground
method:
use Illuminate\Support\Facades\Schedule;
Schedule::command('analytics:report')
->daily()
->runInBackground();
Warning!
runInBackground
メソッドはcommand
かexec
メソッドにより、タスクをスケジュールするときにのみ使用してください。[!WARNING]
TherunInBackground
method may only be used when scheduling tasks via thecommand
andexec
methods.
メンテナンスモードMaintenance Mode
アプリケーションがメンテナンスモードの場合、アプリケーションのスケジュールされたタスクは実行されません。これは、タスクがそのサーバで実行している未完了のメンテナンスに干渉することを望まないためです。ただし、メンテナンスモードでもタスクを強制的に実行したい場合は、タスクを定義するときにevenInMaintenanceMode
メソッドを呼び出すことができます。Your application's scheduled tasks will not run when the application is in maintenance mode[/docs/{{version}}/configuration#maintenance-mode], since we don't want your tasks to interfere with any unfinished maintenance you may be performing on your server. However, if you would like to force a task to run even in maintenance mode, you may call the evenInMaintenanceMode
method when defining the task:
Schedule::command('emails:send')->evenInMaintenanceMode();
スケジューラの実行Running the Scheduler
スケジュールするタスクを定義する方法を学習したので、サーバで実際にタスクを実行する方法について説明しましょう。schedule:run
Artisanコマンドは、スケジュールしたすべてのタスクを評価し、サーバの現在の時刻に基づいてタスクを実行する必要があるかどうかを判断します。Now that we have learned how to define scheduled tasks, let's discuss how to actually run them on our server. The schedule:run
Artisan command will evaluate all of your scheduled tasks and determine if they need to run based on the server's current time.
したがって、Laravelのスケジューラを使用する場合、サーバに1分ごとにschedule:run
コマンドを実行する単一のcron設定エントリを追加するだけで済みます。サーバにcronエントリを追加する方法がわからない場合は、Laravel Forgeなどのcronエントリを管理できるサービスの使用を検討してください。So, when using Laravel's scheduler, we only need to add a single cron configuration entry to our server that runs the schedule:run
command every minute. If you do not know how to add cron entries to your server, consider using a service such as Laravel Forge[https://forge.laravel.com] which can manage the cron entries for you:
* * * * * cd /path-to-your-project && php artisan schedule:run >> /dev/null 2>&1
秒単位のタスクスケジュールSub-Minute Scheduled Tasks
ほとんどのオペレーティングシステムでは、cronジョブの実行は最短で1分に1回に制限されています。しかし、Laravelのスケジューラーを使えば、1秒に1回など、より細かい間隔でタスクを実行できます。On most operating systems, cron jobs are limited to running a maximum of once per minute. However, Laravel's scheduler allows you to schedule tasks to run at more frequent intervals, even as often as once per second:
use Illuminate\Support\Facades\Schedule;
Schedule::call(function () {
DB::table('recent_users')->delete();
})->everySecond();
アプリケーション内で秒単位実行タスクが定義されている場合、schedule:run
コマンドは実行後即時終了せず、現在の分が終了するまで実行し続けます。これにより、その分内で実行する必要がある、全ての秒単位実行タスクを起動します。When sub-minute tasks are defined within your application, the schedule:run
command will continue running until the end of the current minute instead of exiting immediately. This allows the command to invoke all required sub-minute tasks throughout the minute.
秒単位実行タスクの実行に予想以上の時間がかかると、後の秒単位実行タスクの実行が遅れる可能性があるため、すべての秒単位実行タスクは、キュー投入ジョブまたはバックグラウンドコマンドをディスパッチし、確実にタスクを処理できるようにすることを推奨します。Since sub-minute tasks that take longer than expected to run could delay the execution of later sub-minute tasks, it is recommended that all sub-minute tasks dispatch queued jobs or background commands to handle the actual task processing:
use App\Jobs\DeleteRecentUsers;
Schedule::job(new DeleteRecentUsers)->everyTenSeconds();
Schedule::command('users:delete')->everyTenSeconds()->runInBackground();
秒単位のタスクの中断Interrupting Sub-Minute Tasks
schedule:run
コマンドは秒単位実行タスクが定義されている場合、起動した分の間ずっと実行を持続するため、アプリケーションをデプロイするときにコマンドを中断する必要があるかもしれません。そうしないと、すでに実行されているschedule:run
コマンドのインスタンスは現在の分が終了するまで、アプリケーションの以前にデプロイされたコードを使い続けることになります。As the schedule:run
command runs for the entire minute of invocation when sub-minute tasks are defined, you may sometimes need to interrupt the command when deploying your application. Otherwise, an instance of the schedule:run
command that is already running would continue using your application's previously deployed code until the current minute ends.
実行中のschedule:run
コマンドを中断するには、アプリケーションのデプロイスクリプトへ、schedule:interrupt
コマンドを追加します。このコマンドはアプリケーションのデプロイが終わった後に実行する必要があります:To interrupt in-progress schedule:run
invocations, you may add the schedule:interrupt
command to your application's deployment script. This command should be invoked after your application is finished deploying:
php artisan schedule:interrupt
スケジュールをローカルで実行Running the Scheduler Locally
通常、ローカル開発マシンにスケジューラのcronエントリを追加することはありません。代わりに、schedule:work
Artisanコマンドを使用できます。このコマンドはフォアグラウンドで実行し、コマンドを終了するまで1分ごとにスケジューラーを呼び出します。Typically, you would not add a scheduler cron entry to your local development machine. Instead, you may use the schedule:work
Artisan command. This command will run in the foreground and invoke the scheduler every minute until you terminate the command:
php artisan schedule:work
タスク出力Task Output
Laravelスケジューラはスケジュールしたタスクが生成する出力を取り扱う便利なメソッドをたくさん用意しています。最初にsendOutputTo
メソッドを使い、後ほど内容を調べられるようにファイルへ出力してみましょう。The Laravel scheduler provides several convenient methods for working with the output generated by scheduled tasks. First, using the sendOutputTo
method, you may send the output to a file for later inspection:
use Illuminate\Support\Facades\Schedule;
Schedule::command('emails:send')
->daily()
->sendOutputTo($filePath);
出力を指定したファイルに追加したい場合は、appendOutputTo
メソッドを使います。If you would like to append the output to a given file, you may use the appendOutputTo
method:
Schedule::command('emails:send')
->daily()
->appendOutputTo($filePath);
emailOutputTo
メソッドを使用して、選択した電子メールアドレスへ出力を電子メールで送信できます。タスクの出力をメールで送信する前に、Laravelのメールサービスを設定する必要があります。Using the emailOutputTo
method, you may email the output to an email address of your choice. Before emailing the output of a task, you should configure Laravel's email services[/docs/{{version}}/mail]:
Schedule::command('report:generate')
->daily()
->sendOutputTo($filePath)
->emailOutputTo('taylor@example.com');
スケジュールしたArtisanまたはシステムコマンドが、ゼロ以外の終了コードで終了した場合にのみ出力を電子メールで送信する場合は、emailOutputOnFailure
メソッドを使用します。If you only want to email the output if the scheduled Artisan or system command terminates with a non-zero exit code, use the emailOutputOnFailure
method:
Schedule::command('report:generate')
->daily()
->emailOutputOnFailure('taylor@example.com');
Warning!
emailOutputTo
、emailOutputOnFailure
、sendOutputTo
、appendOutputTo
メソッドは、command
とexec
メソッドに対してのみ指定できます。[!WARNING]
TheemailOutputTo
,emailOutputOnFailure
,sendOutputTo
, andappendOutputTo
methods are exclusive to thecommand
andexec
methods.
タスクフックTask Hooks
before
およびafter
メソッドを使用して、スケジュール済みのタスクを実行する前後に実行するコードを指定できます。Using the before
and after
methods, you may specify code to be executed before and after the scheduled task is executed:
use Illuminate\Support\Facades\Schedule;
Schedule::command('emails:send')
->daily()
->before(function () {
// タスクが実行されようとしている
})
->after(function () {
// タスクが実行された
});
onSuccess
メソッドとonFailure
メソッドを使用すると、スケジュールされたタスクが成功または失敗した場合に実行されるコードを指定できます。失敗は、スケジュールされたArtisanまたはシステムコマンドがゼロ以外の終了コードで終了したことを示します。The onSuccess
and onFailure
methods allow you to specify code to be executed if the scheduled task succeeds or fails. A failure indicates that the scheduled Artisan or system command terminated with a non-zero exit code:
Schedule::command('emails:send')
->daily()
->onSuccess(function () {
// タスク成功時…
})
->onFailure(function () {
// タスク失敗時…
});
コマンドから出力を利用できる場合は、フックのクロージャの定義で$output
引数としてIlluminate\Support\Stringable
インスタンスを型指定することで、after
、onSuccess
、またはonFailure
フックでアクセスできます。If output is available from your command, you may access it in your after
, onSuccess
or onFailure
hooks by type-hinting an Illuminate\Support\Stringable
instance as the $output
argument of your hook's closure definition:
use Illuminate\Support\Stringable;
Schedule::command('emails:send')
->daily()
->onSuccess(function (Stringable $output) {
// タスク成功時…
})
->onFailure(function (Stringable $output) {
// タスク失敗時…
});
URLへのPingPinging URLs
pingBefore
メソッドとthenPing
メソッドを使用すると、スケジューラーはタスクの実行前または実行後に、指定するURLに自動的にpingを実行できます。このメソッドは、Envoyerなどの外部サービスに、スケジュールされたタスクが実行を開始または終了したことを通知するのに役立ちます。Using the pingBefore
and thenPing
methods, the scheduler can automatically ping a given URL before or after a task is executed. This method is useful for notifying an external service, such as Envoyer[https://envoyer.io], that your scheduled task is beginning or has finished execution:
Schedule::command('emails:send')
->daily()
->pingBefore($url)
->thenPing($url);
pingBeforeIf
およびthenPingIf
メソッドは、特定の条件がtrue
である場合にのみ、特定のURLにpingを実行するために使用します。The pingBeforeIf
and thenPingIf
methods may be used to ping a given URL only if a given condition is true
:
Schedule::command('emails:send')
->daily()
->pingBeforeIf($condition, $url)
->thenPingIf($condition, $url);
pingOnSuccess
メソッドとpingOnFailure
メソッドは、タスクが成功または失敗した場合にのみ、特定のURLにpingを実行するために使用します。失敗は、スケジュールされたArtisanまたはシステムコマンドがゼロ以外の終了コードで終了したことを示します。The pingOnSuccess
and pingOnFailure
methods may be used to ping a given URL only if the task succeeds or fails. A failure indicates that the scheduled Artisan or system command terminated with a non-zero exit code:
Schedule::command('emails:send')
->daily()
->pingOnSuccess($successUrl)
->pingOnFailure($failureUrl);
イベントEvents
Laravelは、スケジュールの処理中に様々なイベントをディスパッチします。以下のイベントに対して、リスナを定義できます。Laravel dispatches a variety of events[/docs/{{version}}/events] during the scheduling process. You may define listeners[/docs/{{version}}/events] for any of the following events:
イベント名Event Name |
---|
Illuminate\Console\Events\ScheduledTaskStarting Illuminate\Console\Events\ScheduledTaskStarting |
Illuminate\Console\Events\ScheduledTaskFinished Illuminate\Console\Events\ScheduledTaskFinished |
Illuminate\Console\Events\ScheduledBackgroundTaskFinished Illuminate\Console\Events\ScheduledBackgroundTaskFinished |
Illuminate\Console\Events\ScheduledTaskSkipped Illuminate\Console\Events\ScheduledTaskSkipped |
Illuminate\Console\Events\ScheduledTaskFailed Illuminate\Console\Events\ScheduledTaskFailed |