Eloquent を使ったデータ取得のあれこれ【PHP/Laravel】｜ブログ

はじめに 弊社ではPHPのフレームワークとして、殆どが Laravel を利用しています。 Laravel でデータベースからデータを取得する際は、専用のModelファイルを作成し、そこからクエリを作成したりしてデータを取得することが多いと思います。 ただ一言モデルのデータを取得するといっても、取得方法は様々です。 ここでは、Laravel で主に使うモデル取得のメソッドをどういった用途で使い分けて行くべきかを簡単に解説していければと思います。 なお、Laravel には多くのデータ取得のメソッドがあるため、基本的なメソッドのみのご紹介に留めて起きます。 また、あくまで「筆者はこういうときはこの関数を使っている」程度の紹介なので、ここで紹介するのが絶対ではありませんし、ユースケースによってまた変わってくることもあるので、そこはご留意ください。 Laravelでのモデルデータ取得 get(), all() まず複数のモデルデータを取得する関数です。 複数のモデルを取得するので、返り値は Laravel の Collection が返り値となります。 all() メソッドは、全てのデータを取得するメソッドです。Modelから直接呼び出すことしかできない static メソッドとなっています。 get() メソッドは指定したクエリに該当するデータを全て取得するメソッドです。 なお、引数として取得するカラムを指定することも可能です。 // 商品テーブルから price カラムの値が 3000 以下に該当するデータを全て取得する $models = Product::query()->where('price', ' get(); // データを全て取得 $models = Product::all(); このメソッドの用途としては、「条件にあったデータを全て取得したいとき」となります。 一般的には商品の一覧といった、一覧で表示するデータを取得するときに利用するのではないでしょうか。 first(), firstWhere() つぎに単一のモデルデータを取得する関数です。 単一のモデルを取得するので返り値は、利用している Eloquent Model が返り値となります。 first() メソッドは、指定したクエリに該当するデータの一番最初のデータを取得するメソッドです。 SQL 的に言えば、”LIMIT 1″ を指定していると思ってください。 また、first() メソッドを少し簡略して記載する方法として、firstWhere() メソッドがあります。 なお、データが存在しない場合は “null” が返されます。 // 商品テーブルから price カラムの値が 3000 以下に該当するデータの一番最初を取得する $model = Product::query()->where('price', ' first(); // 上記を firstWhere() で書き換え $model = Product::query()->firstWhere('price', ' where('productcode', $code)->get()[0]; // first() メソッドの方が少し楽に書けるし、意図もわかりやすい $model = Product::query()->where('productcode', $code)->first(); また orderBy() と組み合わせることで、特定の条件のデータを取得するといったことも可能です。 // 価格が一番安いデータを取得する $minPriceProduct = Product::query()->orderBy('price')->first(); firstOr(), firstOrCreate(), firstOrNew(), firstOrFail() これらは全て first() メソッドの派生形です。 単一のモデルデータを取得するのは変わりませんが、データが存在しない場合に “null” を返すのではなくそれぞれ決まった挙動をするようになっています。 // firstOr(): 存在しない場合の動作を、自分で定義する $model = Product::query()->where(...)->firstOr(function(){ ... }); // firstOrCreate(): 存在しない場合、指定したデータでデータベースに作成し、そのModelクラスを返す $model = Product::query()->where(...)->firstOrCreate([ .... ]); // firstOrNew(): 存在しない場合、指定したデータが格納されたModelクラスを返す $model = Product::query()->where(...)->firstOrNew([ .... ]); // firstOrFail(): 存在しない場合、例外を投げる $model = Product::query()->where(...)->firstOrFail(); それぞれ、存在しない場合に行いたい動作によって、使い分けましょう。 find(), findMany() get() メソッドで複数データ、first() メソッドで単一のデータが取得できることは分かったと思います。 Laravel ではさらに、よく使われる「IDでの検索」に特化したメソッドが用意されています。 それが、find() および findMany() メソッドです。 これらは ID （正確にはPrimaryキー）での検索を行う場合の用途に利用します。 // ID (PrimaryKey) が "1" のデータを取得する $model = Product::query()->find(1); // 以下のコードと同一 $model = Product::query()->where('id', 1)->first() $model = Product::query()->whereKey(1)->first(); // findMany() は複数データを取得する $models = Product::query()->findMany([1, 2, 3]); // find() でも複数データの取得は可能 (内部的には findMany() を呼び出している) $models = Product::query()->find([1, 2, 3]); リレーションデータの取得 Laravel にはデータベースのリレーションを Model 上で定義することで簡単に紐づくデータを取得することが可能です。 ただし、考えなしにリレーションのデータを取得してしまうとパフォーマンス的に問題になることがあります。 N+1 問題 Laravel のリレーションデータにはよく、「N+1問題」が取り上げられます。 hasMany や BelongsToMany といった、リレーション先のデータが「多」になる場合に発生する問題です。 // N+1問題が発生するケース / 投稿データを管理する Model / class Post extends Model { public function comments() { return $this->hasMany(Comment::class); } } / 投稿に紐づくコメントデータを管理する Model / class Comment extends Model { } // 投稿データを取得 $post = Post::query()->find(1); // 紐づくcommentモデルに対して処理を行う foreach($post->comments as $comment){ //N+1問題が発生する } この場合、投稿データを管理する Post モデルに対して Comment という複数のデータが紐づいています。この各 Comment データにアクセスしようとした場合、Laravel では 1件1件データベースから取得することになります。つまりそのたびにSQLが発行されてデータベースにアクセスすることになります。 それを回避するのが with() メソッドです。 これを使うことで、リレーション先のデータをEagerロードされ、1回のクエリで全てのリレーションデータを先に読み込むようになります。 // with() メソッドで comments データを eager load する // この時点で comments データを取得するクエリが1つだけ発行される $post = Post::query()->with('comments')->find(1); // 紐づくcommentモデルに対して処理を行う foerach($post->comments as $comment){ //先にデータを読み込んでいるので N+1問題は発生しない } hasMany や belongsToMany などの「多」と紐づくリレーションの場合、リレーション先のデータを利用するのであれば、常に with() メソッドを利用するべきです。 Eagerロードを利用することで、パフォーマンスが大幅に改善します。 // 基本的に with を使うべきです。 $post = Post::query()->with('comments')->find(1); // with を使わないのは、リレーション先のデータが不要なときくらいです。 $post = Post::query()->find(1); with() と join() laravel ではリレーション先のデータを取得する場合、リレーションを定義し、with() で取得するのが良いというのは分かったかと思います。 ただ、Laravel にはリレーションデータを取得するもう一つの方法として、join() メソッドがあります。 これは、SQLでいう INNER JOIN となります。 // join で紐づけて取得 $post = Post::query()->join('comments', 'posts.id', '=', 'comments.postid')->find(1); この場合、with() と違い1回のクエリでリレーション先のデータも含めて取得することが可能です。そのため、with() で取得するよりかは高速になる可能性があります。 ただし、こちらはデータの取得が “SQL寄り” になります。 どういうことかというと、例えば id = 1 の Post データに comments データが 5件紐づいていたとします。その場合、with() と join() で取得したときのデータは以下のようになります。 // with() で取得した場合のデータ // relation プロパティに紐づくデータが格納されている [0 => App\Model\Post { .... relations => [ 'comments' => [ 0 => App\Models\Comment { }, 1 => App\Models\Comment { }, .... ] ] }] // join() で取得した場合のデータ // SQLで join した場合 内部結合され posts × comments の数だけデータが取得されるが、 // Laravel でも同様のデータ数となる [0 => App\Model\Post { .... // 紐づくcommentsデータが含まれている }, 1 => App\Model\Post { .... // 0 番目と Post のデータは同一だが、comments のデータは異なっている }, .... ] つまり、同じ データを取得した場合、with() の場合は Post データの数だけデータが返されることになりますが、join() の場合は Post データ × Comment データの数だけデータが返されることになります。 少し難しいかもしれませんが、with() は Laravel の Eloquent 的なデータが返ってくるため、Laravel で扱う場合に直感的にわかりやすいデータが返ってくる。 join() はどちらかというと SQL 的なデータが返ってくるので、Laravel で扱うときに直感的にはわかりにくいと思っていただければいいかと思います。 join() の使い所は？ 先程の話を聞いて、「じゃあ join() 使わないほうが良くない？」と思ったかもしれません。 実はその通りで、基本的に Laravel ではリレーションのデータを取得するのは with() で充分なことが多いです。しかし、with() ではできないこともあり、それをするためには join() を使わないといけないこともあります。 その例を少しだけ紹介しておきます。 ・リレーション先のカラムで並び替えたい with() メソッドの場合、まずリレーション元のデータを取得するクエリが発行され、その後にリレーション先のデータを取得するクエリが発行されます。 つまり、posts テーブルへのアクセスと、comments テーブルのアクセスが別々に行われています。 この場合、例えば 「Post データを Comment データのいいねが多い順に取得したい」といった事ができません。Postデータを取得する際には、comments テーブルにはアクセスしていません。なので、comments テーブルのカラムは存在しないのでエラーとなります。 // Comment データの いいね数 (likes) で並び替えたい $posts = Post::query()->orderBy('comments.likes')->get(); -> エラー! Unknown column 'comments.likes' $posts = Post::query()->join('comments', 'posts.id', '=', 'comments.postid') ->orderBy('comments.likes')->get(); -> エラーとならない ・リレーション先のカラムで集計などを行いたい リレーション元とリレーション先のクエリが別々ということは、当然リレーション先のカラムで集計関数などを使うことはできません。 例えば、投稿一覧のページで、Comment データは表示しないけど、Comment のいいね数の合計は表示したいとします。 with() を使う場合は以下のようになるでしょう。 $posts = Post::query()->with('comments')->get(); // 描画時 foreach( $posts as $post ){ echo $post->comments->sum('likes'); } これでも確かに動きますが、Comment データ自体は表示する必要ないのに、Comment データの全てを取得してきています。もちろんここでクエリが余計に発行されています。 また、Comment数が多い場合、sum() を実行するのにも内部的には collection をループして計算しているため、処理時間がかかってしまうかもしれません。 そこで join() を使うと以下のように取得できます。 $posts = Post::query() ->select([ '', DB::raw('SUM(comments.likes) as likestotal'), // 集計関数を利用してSQL上で合計を取得 ]) ->join(....) ->grouBy('posts.id') // 集計関数の基準となる groupBy ->ge(); // 描画時 foreach( $posts as $post ){ echo $post->likestotal; } 記述は少し複雑に思えるかもしれませんが、join() を使うことでクエリの発行数を減らし、目的のデータが取得できています。また集計をデータベースに任せることで、PHP側で合計を算出するためにデータのループも不要となります。 まとめ Laravel でよく使われそうな、基本的なモデルデータ取得のメソッドについて見てきました。 それぞれで、用途や役割が異なるので、目的に合ったメソッドを使うことで保守性やコードの可読性が上がるかと思います。 Laravel にはリレーションでのデータ取得もありますが、ここがN+1問題などパフォーマンスに関わってくる部分でもありますので、アプリの速度などを気にする場合はここも重要になっていきます。