🌿

Laravel Model::shouldBeStrict() で何をやっているのか

に公開

はじめに

Model::shouldBeStrict()はLaravel 9.35.0で追加されたEloquentの厳格モードの設定です。

https://laravel-news.com/laravel-9-35-0#content-eloquent-strict-mode

この設定を有効にすると、以下の3つが有効になります。

  1. N + 1 の検出
  2. fillable / guarded の設定漏れによる属性破棄の検出
  3. 存在しないプロパティへのアクセスの検出

これらがどのような挙動をするのか実際に確認します。

環境

  • PHP 8.5.7
  • Laravel 13.17.0

設定の有効化

まずは厳格モードを有効化が必要です。

全てのリクエストで最初に動く処理で設定するのが良さそうなので、AppServiceProviderのboot()メソッドで設定しましょう。

app/Providers/AppServiceProvider.php
<?php

namespace App\Providers;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\ServiceProvider;

class AppServiceProvider extends ServiceProvider
{
    public function boot(): void
    {
        Model::shouldBeStrict();
    }
}

Model::shouldBeStrict()が実際に何をやっているから、Laravelのコードを見てください。

https://github.com/laravel/framework/blob/v13.17.0/src/Illuminate/Database/Eloquent/Model.php#L561-L572

N + 1 の検出

例えば以下のコードがあります。

    $user_ids = [];
    $tasks = Task::all();
    foreach ($tasks as $task) {
        $user_ids[] = $task->user->id;
    }

厳格モードが有効な状態で実行するとLazyLoadingViolationExceptionが発生し、N+1を検出できます。

   Illuminate\Database\LazyLoadingViolationException

  Attempted to lazy load [user] on model [App\Models\Task] but lazy loading is disabled.

次のようにwith()メソッドを使うように書き換えると例外は起きなくなります。

    $user_ids = [];
    $tasks = Task::with('user')->get();
    foreach ($tasks as $task) {
        $user_ids[] = $task->user->id;
    }

fillable / guarded の設定漏れによる属性破棄の検出

例えば以下のコードがあります。

app/Models/User.php
use Illuminate\Database\Eloquent\Attributes\Fillable;

#[Fillable(['name', 'password'])]
class User extends Authenticatable
{

この状態でUserクラスのデータを作成すると厳格モードが有効な状態ではMassAssignmentExceptionが発生し、fillableの設定漏れを検出できます。

    User::query()->create([
        'name' => 'Test User',
        'email' => Str::random(10) . '@example.com',
        'password' => 'password',
    ]);
   Illuminate\Database\Eloquent\MassAssignmentException

  Add fillable property [email] to allow mass assignment on [App\Models\User].

guardedについても設定漏れがあれば同様です。

app/Models/User.php
use Illuminate\Database\Eloquent\Attributes\Guarded;

#[Guarded(['email'])]
class User extends Authenticatable
{

先ほどのUserクラスのデータを作成すると例外が発生します。

   Illuminate\Database\Eloquent\MassAssignmentException

  Add [email] to fillable property to allow mass assignment on [App\Models\User].

fillable / guarded のどちらを使うかはお任せですが、意図しない属性破棄が発生しない設定すると例外は起きないです。

app/Models/User.php
use Illuminate\Database\Eloquent\Attributes\Fillable;

#[Fillable(['name', 'email', 'password'])]
class User extends Authenticatable
{

存在しないプロパティへのアクセスの検出

例えば以下のコードがあります。

    $user = User::first();

    echo $user->email1;

厳格モードを有効な状態で実行するとMissingAttributeExceptionが発生し、存在しないプロパティへのアクセスを検出できます。

   Illuminate\Database\Eloquent\MissingAttributeException

  The attribute [email1] either does not exist or was not retrieved for model [App\Models\User].

存在するプロパティに修正することで例外は起きなくなります。

    $user = User::first();

    echo $user->email;

まとめ

Model::shouldBeStrict()で有効になる設定を見ました。
こちらは開発環境/CIなどで有効化し、Eloquentの不備を早期発見に役立ちそうです。

// 本番環境以外で有効
Model::shouldBeStrict(! app()->isProduction());

また、一括で3つの設定を有効化しないでも、どれか1つだけ有効化するやり方でも良さそうです。

app/Providers/AppServiceProvider.php
<?php

namespace App\Providers;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\ServiceProvider;

class AppServiceProvider extends ServiceProvider
{
    public function boot(): void
    {
        // n + 1の検出だけ有効
        Model::preventLazyLoading(! $this->app->isProduction());
    }
}
GitHubで編集を提案

Discussion