Laravelのモデルイベント（creating, updating）を使う方法
生徒
「Laravelでデータを保存するときに、自動で値を設定したりチェックしたりする方法ってありますか？」
先生
「はい、それにはEloquentのモデルイベントを使うと便利です。例えばcreatingやupdatingといったイベントがあります。」
生徒
「モデルイベントって何ですか？」
先生
「モデルイベントとは、モデルがデータベースに保存される前後など、特定のタイミングで自動的に処理を行う仕組みです。データが作られる前に値を加工したり、更新される前にチェックしたりできます。」
生徒
「なるほど、具体的にはどうやって使うんですか？」
先生
「では、基本的な使い方を順に見ていきましょう。」
1. creatingイベントで保存前に処理する
例えば、ユーザー登録時に自動でUUIDを設定したい場合、creatingイベントを使うと便利です。
namespace App\Models;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Str;
class User extends Model
{
protected static function booted()
{
static::creating(function ($user) {
$user->uuid = (string) Str::uuid();
});
}
}
この例では、ユーザーを作成する直前にuuidフィールドに自動でUUIDを設定しています。bootedメソッド内でイベントを登録することがポイントです。
2. updatingイベントで更新前に処理する
データを更新するときに、自動でタイムスタンプを設定したい場合はupdatingイベントを使います。
protected static function booted()
{
static::updating(function ($user) {
$user->updated_by = auth()->id();
});
}
ここでは、ユーザー情報が更新される前に、updated_byフィールドに現在ログインしているユーザーのIDを自動で設定しています。
3. イベントを使うメリット
モデルイベントを使うことで、コントローラやサービスクラスに同じ処理を書かずに済み、コードがすっきりします。また、データの一貫性や自動化も簡単に実現できます。
例えば、全てのユーザー登録にUUIDを設定したり、全ての更新操作に更新者IDを記録したりする処理を一箇所にまとめて書けます。これにより、ミスを減らし、保守性の高いアプリケーションが作れます。
4. 注意点とポイント
モデルイベントは自動で呼ばれるため、コントローラ側で重複して同じ処理を書かないように注意しましょう。また、creatingとupdatingは保存前のイベントなので、データベースに反映される前に値を加工できます。
イベントには他にもcreatedやupdatedなど、保存後に処理するタイプもあります。まずはcreatingとupdatingを覚えて、データ保存前の自動処理を実装できるようになることが大切です。
この仕組みを理解することで、Laravelで効率的にデータ管理ができ、アプリケーションの信頼性を高めることができます。
