もがき系プログラマの日常

もがき系エンジニアの勉強したこと、日常のこと、気になっている技術、備忘録などを紹介するブログです。

LaravelのN+1対策機能を試してみた

はじめに

こんばんは。

Laravel触ってて、N+1対策って with() 書くくらいしかやってなかったんですが、調べてたら便利そうな機能をいくつか見つけたので試してみました。

preventLazyLoading() を試してみた

Lazy Loadingが発生したら例外を投げてくれる機能らしい。

Laravel 8.43 からあるらしいんですが、全然知らなかった...。

設定

AppServiceProvider に追加。

public function boot(): void
{
    Model::preventLazyLoading(!$this->app->isProduction());
}

試してみる

適当に N+1 が発生するコードを書いて実行してみる。

$posts = Post::all();
foreach ($posts as $post) {
    echo $post->user->name;
}

おー、ちゃんと例外が出た。

Illuminate\Database\LazyLoadingViolationException
Attempted to lazy load [user] on model [App\Models\Post]

これ開発時に有効にしておけば with() の書き忘れに気づけていいですね。

本番でも検知だけしたい場合はこう書けるらしい。

public function boot(): void
{
    Model::preventLazyLoading();

    if ($this->app->isProduction()) {
        Model::handleLazyLoadingViolationUsing(function ($model, $relation) {
            logger()->warning(
                "Lazy loading detected: [{$relation}] on " . get_class($model)
            );
        });
    }
}

chaperone() を試してみた

これも知らなかった。Laravel 10.30 から使えるらしい。

子から親を参照するときのN+1を防ぐやつ。

何が問題なのか

こういうコード。

$posts = Post::with('comments')->get();

foreach ($posts as $post) {
    foreach ($post->comments as $comment) {
        echo $comment->post->title;  // ← ここ
    }
}

with('comments') してるから大丈夫かと思いきや、$comment->post で親を参照すると N+1 が発生する。

解決方法

リレーション定義に chaperone() を追加。

public function comments(): HasMany
{
    return $this->hasMany(Comment::class)->chaperone();
}

これで $comment->post がクエリなしで取れるようになった。

リレーション定義を変えたくない場合はクエリ時に指定もできる。

$posts = Post::with([
    'comments' => fn ($query) => $query->chaperone(),
])->get();

automaticallyEagerLoadRelationships() を試してみた

これが一番びっくりした。Laravel 12.8 から使える。

with() を書かなくても、アクセスしたリレーションを自動でバッチロードしてくれるらしい。

設定

public function boot(): void
{
    Model::automaticallyEagerLoadRelationships();
}

試してみる

$orders = Order::all();  // with() なし
foreach ($orders as $order) {
    echo $order->client->name;
    echo $order->client->owner->name;
    echo $order->client->owner->company->name;
}

Debugbar で確認したら、ちゃんとまとめてクエリが発行されてた。すごい。

クエリ単位で有効化することもできる。

$orders = Order::all()->withRelationshipAutoloading();

注意点

便利だけど、意図せず大量のリレーションをロードしてメモリ使いすぎる可能性もあるっぽい。

終わりに

色々知らないものありますね。

automaticallyEagerLoadRelationships() はもう少し調べてみてから検討しようと思います。

それ以外は早速使ってみます。

ではでは。