Laravel
タスクスケジューリング

タスクの作成

Artisanを使用してLaravelでタスク（コンソールコマンド）を作成することができます。あなたのコマンドラインから：

php artisan make:console MyTaskName

これにより、 app / Console / Commands / MyTaskName.phpにファイルが作成されます。それは次のようになります：

<?php

namespace App\Console\Commands;

use Illuminate\Console\Command;

class MyTaskName extends Command
{
    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'command:name';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Command description';

    /**
     * Create a new command instance.
     *
     * @return void
     */
    public function __construct()
    {
        parent::__construct();
    }

    /**
     * Execute the console command.
     *
     * @return mixed
     */
    public function handle()
    {
        //
    }
}

この定義の重要な部分は次のとおりです。

• $signatureプロパティは、あなたのコマンドを特定するものです。 Artisanを使用してコマンドラインでphp artisan command:nameを実行すると、このコマンドを後で実行することができますphp artisan command:name （ command:nameコマンドの$signature一致します）
• $descriptionプロパティは、コマンドが利用可能になったときに、そのコマンドの横にあるArtisanのヘルプ/使用状況の表示です。
• handle()メソッドは、コマンドのコードを記述する場所です。

最終的に、あなたのタスクはArtisanを通じてコマンドラインで利用できるようになります。 protected $signature = 'command:name';このクラスのプロパティは、それを実行するために使用するものです。

タスクを利用可能にする

Artisanとアプリケーションには、 app / Console / Kernel.phpファイルでタスクを利用できるようにすることができます。

Kernelクラスには$commandsという名前の配列が含まれているため、アプリケーションでコマンドを使用できるようになります。

Artisanとアプリケーションで使用できるように、この配列にコマンドを追加します。

<?php

namespace App\Console;

use Illuminate\Console\Scheduling\Schedule;
use Illuminate\Foundation\Console\Kernel as ConsoleKernel;

class Kernel extends ConsoleKernel
{
    /**
     * The Artisan commands provided by your application.
     *
     * @var array
     */
    protected $commands = [
        Commands\Inspire::class,
        Commands\MyTaskName::class // This line makes MyTaskName available
    ];

    /**
     * Define the application's command schedule.
     *
     * @param  \Illuminate\Console\Scheduling\Schedule  $schedule
     * @return void
     */
    protected function schedule(Schedule $schedule)
    {
    
    }
}

これが完了したら、Artisanを使用してコマンドラインからコマンドにアクセスできるようになりました。コマンドの$signatureプロパティがmy:task設定されmy:taskいると仮定すると、次のコマンドを実行してタスクを実行できます。

php artisan my:task

タスクのスケジューリング

アプリケーションでコマンドを使用できるようになったら、Laravelを使用して、CRONと同じようにあらかじめ定義された間隔で実行するようスケジュールできます。

App / Console / Kernel.phpファイルには、タスクをスケジュールするために使用できるschedule方法があります。

<?php

namespace App\Console;

use Illuminate\Console\Scheduling\Schedule;
use Illuminate\Foundation\Console\Kernel as ConsoleKernel;

class Kernel extends ConsoleKernel
{
    /**
     * The Artisan commands provided by your application.
     *
     * @var array
     */
    protected $commands = [
        Commands\Inspire::class,
        Commands\MyTaskName::class
    ];

    /**
     * Define the application's command schedule.
     *
     * @param  \Illuminate\Console\Scheduling\Schedule  $schedule
     * @return void
     */
    protected function schedule(Schedule $schedule)
    {
        $schedule->command('my:task')->everyMinute();
        // $schedule->command('my:task')->everyFiveMinutes();
        // $schedule->command('my:task')->daily();
        // $schedule->command('my:task')->monthly();
        // $schedule->command('my:task')->sundays();
    }
}

あなたのタスクの$signatureがmy:taskと仮定すると、 Schedule $scheduleオブジェクトを使用して上記のようにスケジュールすることができます。 Laravelには、上にコメントアウトされているように、コマンドをスケジュールするためのさまざまな方法が用意されています。

実行するスケジューラの設定

スケジューラは次のコマンドを使用して実行できます。

php artisan schedule:run

スケジューラは、正しく動作するために毎分実行する必要があります。これを設定するには、バックグラウンドで毎分スケジューラを実行する次の行でcronジョブを作成します。

* * * * * php /path/to/artisan schedule:run >> /dev/null 2>&1