handle()

ハンドル（キューとジョブ）

意味ジョブの処理を定義

handle()とは？

handle()メソッドは、キューに投入されたジョブが実行される際に呼び出されるメソッドです。ジョブが行うべき具体的な処理をこのメソッド内に記述します。

handle()の具体的な使い方

ジョブ処理の例

<?php

namespace App\Jobs;

use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Bus\Queueable;
use Illuminate\Queue\SerializesModels;
use App\Models\User;
use Illuminate\Support\Facades\Mail;
use App\Mail\WelcomeEmail;

class SendWelcomeEmail implements ShouldQueue
{
    use Queueable, SerializesModels;

    protected $userId;

    public function __construct($userId)
    {
        $this->userId = $userId;
    }

    public function handle()
    {
        $user = User::find($this->userId);
        
        if (!$user) {
            throw new \Exception("ユーザーが見つかりません。");
        }

        Mail::to($user->email)->send(new WelcomeEmail($user));

        echo "ユーザーID {$this->userId} に歓迎メールを送信しました。";
    }
}

👇出力結果

ユーザーID 1 に歓迎メールを送信しました。

この例では、SendWelcomeEmailジョブクラスのhandle()メソッド内で、ユーザーIDを使ってユーザーを検索し、そのユーザーに歓迎メールを送信する処理を行っています。handle()メソッドはジョブが実行される際に呼び出され、ここでジョブの主要な処理ロジックを定義します。また、ユーザーが見つからない場合には例外をスローし、エラー処理も行っています。

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

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

A. はい、handle()メソッドはジョブクラスで必須です。このメソッドがジョブの実行時に呼び出され、実際の処理を行います。

Q. handle()で例外が発生したらどうなる？

A. handle()メソッド内で例外が発生した場合、ジョブは失敗としてマークされ、設定に応じて再試行されます。例外処理を適切に行うことで、ジョブの堅牢性を高めることができます。

Q. handle()の引数は何を受け取れますか？

A. handle()メソッドは依存性注入を通じて、必要なサービスや依存関係を引数として受け取ることができます。これにより、ジョブ内で外部サービスや他のクラスを簡単に利用できます。

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

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

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