【Laravel】artisanのmake:jobコマンドを解説

チートシート

Laravel 10.xのartisanの「make:job」コマンドを解説します。

Description

新しいジョブクラスを作成します。

Usage

php artisan make:job [-f|--force] [--sync] [--test] [--pest] [--] <name>

Arguments

引数必須説明
name必須ジョブ名

Options

オプション省略形必須説明
forcefジョブが既に存在する場合でもクラスを作成
syncジョブが同期的であることを示す
testJobに付随するPHPUnitのテストを生成
pestジョブに付随するペストテストを生成

Examples

no options

php artisan make:job FooJob
   INFO  Job [app/Jobs/FooJob.php] created successfully.  
<?php

namespace App\Jobs;

use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldBeUnique;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Bus\Dispatchable;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Queue\SerializesModels;

class FooJob implements ShouldQueue
{
    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;

    /**
     * Create a new job instance.
     */
    public function __construct()
    {
        //
    }

    /**
     * Execute the job.
     */
    public function handle(): void
    {
        //
    }
}

sync

php artisan make:job --sync FooJob
   INFO  Job [app/Jobs/FooJob.php] created successfully.  
<?php

namespace App\Jobs;

use Illuminate\Foundation\Bus\Dispatchable;

class FooJob
{
    use Dispatchable;

    /**
     * Create a new job instance.
     */
    public function __construct()
    {
        //
    }

    /**
     * Execute the job.
     */
    public function handle(): void
    {
        //
    }
}

Stub

OptionStub file name
job.stub
syncjob.queued.stub

Source

10.x

framework/src/Illuminate/Foundation/Console/JobMakeCommand.php at 10.x · laravel/framework
Laravel is a web application framework with expressive, elegant syntax. - laravel/framework

11.x

framework/src/Illuminate/Foundation/Console/JobMakeCommand.php at 11.x · laravel/framework
Laravel is a web application framework with expressive, elegant syntax. - laravel/framework
著者

Webエンジニア歴30年、フリーランスバックエンドエンジニア。

PHP歴約30年(Laravel 7年・FuelPHP 5年・CakePHP・自作FW)、
JavaScript歴約20年(React・Vue各4年)。
AWS(EC2 / CloudFront / RDS / API Gateway など)・
GCP(BigQuery)を使ったバックエンド開発を中心に、
複数の事業会社・受託案件でシステム設計から実装・運用まで担当しています。

PHPがバージョン4の時代から書いており、
Laravelが普及する前のフレームワーク乱立期も経験しています。
「昔はこう書いていたが今はこう」という変遷を肌で知っているエンジニアとして、
単なるコマンドの使い方だけでなく、なぜそうするのかの背景まで伝えることを意識して書いています。

このブログでは、実務で実際に詰まった箇所・調べたこと・気づいたことを
そのまま記事にしています。誰かの「詰まり」が解決するきっかけになれば幸いです。

千原 耕司をフォローする

役にたったと思ったら応援をお願いします m(._.)m

チートシート
スポンサーリンク
シェアする
千原 耕司をフォローする
タイトルとURLをコピーしました