failed()

フェイルド（キューとジョブ）

意味ジョブ失敗時の処理を定義

failed()とは？

failed()メソッドは、ジョブの実行が失敗した場合に呼び出されるメソッドです。ジョブが失敗した際の後処理や通知などを行うために使用します。

failed()の具体的な使い方

ジョブ失敗時のエラーログ記録と通知

use Illuminate\Support\Facades\Log;
use Throwable;

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

    protected $user;
    protected $jobName;

    public function __construct($user, $jobName)
    {
        $this->user = $user;
        $this->jobName = $jobName;
    }

    public function handle()
    {
        // ジョブの主要な処理
    }

    public function failed(Throwable $exception)
    {
        // 失敗時の処理
        Log::error('ジョブが失敗しました: ' . $exception->getMessage());
        $this->user->notifyOfFailedJob($this->jobName);
    }
}

👇出力結果

// ログファイルに記録される内容
[2023-06-01 14:30:15] local.ERROR: ジョブが失敗しました: データベース接続エラー

// ユーザーに送信される通知
重要な処理ジョブの実行に失敗しました。システム管理者に連絡してください。

この例では、ジョブが失敗した際にエラーログを記録し、関連するユーザーに失敗通知を送信しています。failed()メソッド内で例外情報にアクセスし、詳細なエラーメッセージをログに記録しています。また、ユーザー固有の通知メソッドを呼び出して、ジョブの失敗を通知しています。

failed()に関するよくある質問

Q. failed()メソッドの役割は？

A. failed()メソッドは、ジョブの実行が失敗した場合に自動的に呼び出されるメソッドです。ここでエラーログの記録、管理者への通知、ユーザーへの失敗通知など、ジョブ失敗時の後処理を定義します。

Q. failed()メソッドは必須ですか？

A. failed()メソッドは必須ではありませんが、ジョブの失敗を適切に処理するために実装することが強く推奨されます。実装しない場合、ジョブの失敗が静かに無視される可能性があります。

Q. 例外情報にアクセスできますか？

A. はい、failed()メソッドは引数として発生した例外（Throwable $exception）を受け取ります。これを使用して、エラーの詳細情報にアクセスし、適切な処理を行うことができます。

failed()が学べる書籍の紹介

「プログラミング単語帳」を使って、プログラミングの単語を英単語のように学習してみませんか？
プログラミング単語帳には、Laravelのfailed()やchain()、Job::dispatchNow()、onConnection()、などのような実務でよく使われる単語が数百以上収録されています。
この書籍には、プログラミングの単語の意味や読み方、単語の使い方がわかる例文などが掲載されており、いつでもどこでもプログラミングの学習ができます。

よく使われる単語にだけ絞って学習することができるので、効率的にプログラミングが学習できます。