[Laravel]withメソッドでN＋１問題を解決する

はじめに

Laravelではリレーション定義を行ったモデルを使用することでN+1問題が発生します。

今回はN＋１問題を解決するためにwithメソッドを利用したので、備忘録として残しておきます。

環境

• Laravel：8.83.4

1. withメソッドとは

取得したModelインスタンスのリレーション先を事前に取得するメソッドです。
「Eagerロード」によってN＋１問題を解決するために利用されます。

2. N＋１問題を解決する

今回はUserモデルに以下のようなリレーションを定義して進めていきます。

Userモデル

app/Models/User.php

<?php

namespace App\Models;

use Illuminate\Contracts\Auth\MustVerifyEmail;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Relations\HasMany;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;
use Laravel\Sanctum\HasApiTokens;

class User extends Authenticatable
{
//略
    /**
     * リレーション - postsテーブル
     *
     * @return \Illuminate\Database\Eloquent\Relations\HasMany
     */
    public function posts(): HasMany
    {
        return $this->hasMany(Post::class);
    }
//略
}

まずはwithメソッドを使わずにデータを取得する場合から見ていきます。

2-1. withメソッドを使わない場合

全ユーザーを取得した後に、動的プロパティでユーザーに紐づく投稿記事をそれぞれ取得しています。

UserController.php

<?php

namespace App\Http\Controllers;

use App\Models\User;

class UserController extends Controller
{
    public function index()
    {
        $users = User::all();

        foreach ($users as $user) {
            $user->posts;
        }
    }
}

動的プロパティにはリレーション先のプロパティが参照されるまでロードされないという性質があります。
そのため、今回の場合でいうと、ユーザーの数が増えるにつれてクエリの発行回数も増えていきます。
このようなN＋１問題によるパフォーマンスの低下を招かないための対策としてwithメソッドを利用します。

2-1. withメソッドを使う場合

withメソッドでEagerロードすることでN＋１問題を解決します。

UserController.php

<?php

namespace App\Http\Controllers;

use App\Models\User;

class UserController extends Controller
{
    public function index()
    {
        $users = User::with('posts')->get();//変更

        foreach ($users as $user) {
            $user->posts;
        }
    }
}

今回の場合、ユーザー情報だけでなく投稿記事も一括で取得することでクエリの発行回数を減らしています。
withメソッドを使うことで、ユーザーの数が増えても、
usersテーブルのデータを取得するクエリとpostsテーブルのデータを取得するクエリ、計２回のクエリしか発行されません。
このようにして事前にリレーション先のデータを取得することでN+1問題を解決することができます。

以上で実装完了です。
N＋１問題はWebシステムのパフォーマンス悪化につながるので、普段から意識しながらコードを書いていきたいです。

3. 参考文献