Laravelの多対多リレーションを復習+a
..
久しぶりにLaravelで多対多リレーションをやったので、復習＋ついでに学習したことをまとめます。
一般的なモデルの設定
2つのモデルと、関連付け用の中間モデル。普通の形です。
-
Library（図書館）
- id
-
Book（書籍情報マスタ）
- id
-
LibraryBook（蔵書）
- library_id
- book_id
各モデルはphp artisan make:modelで作成されています。
関連付け
図書館モデルからそこの蔵書リストを作りたい、という場合は、LibraryモデルにbelongsToManyメソッドを記述するだけで可能になります。
/**
* 蔵書一覧を取得
*
* @return void
*/
public function books()
{
return $this->belongsToMany(Book::class);
}
$library->books; // 全取得
$library->books()->where('title', $request->input('title'))->get(); // 絞り込み
// 取得してから絞り込み
$library->books->filter(function ($value, $key) {
return $value->title === $request->input('title');
});
特定の本が所蔵されている図書館のリストを作る場合でも全く同様です。
/**
* 蔵書一覧を取得
*
* @return void
*/
public function libraries()
{
return $this->belongsToMany(Library::class);
}
Pivotでもうちょい便利にする
php artisan make:modelで生成されたモデルクラスは、必ずModelクラスを継承したものとなります。
多対多リレーションの中間モデルに、ModelではなくPivotを継承したPivotモデルクラスを使用すると、より簡単に応用的なリレーションを組めるようになります。
php artisan make:model LibraryBook --pivot
Pivotモデルクラスにするとどう便利なのか
今回の例では「図書館」と「蔵書」の関係ですが、例えば中間モデルが「貸出中」という状態を持つとします。
- LibraryBook
- library_id
- book_id
- checked_out （trueが入ると「貸出中」）
先程の蔵書一覧取得のような形で「貸出中の蔵書一覧」を取得したい、という場合は、このようなリレーションを組むことができます。
/**
* 貸出中の蔵書一覧を取得
*
* @return void
*/
public function lendingBooks()
{
return $this->belongsToMany(Book::class)
->wherePivot('checked_out', true);
}
whereメソッド同様、カラムと値を指定して絞り込むことができます。
処理内で中間テーブルの値を使いたい場合は、wherePivotと並べてwithPivotメソッドをつなげれば、引数で指定したカラムを一緒に取得できます。
$library->lendingBooks; // 貸出中の蔵書を取得
他にどんなメソッドが使えるかはReadouble.comから。
これをやるのに必要な作業
補足：ルートモデル結合で親子モデル両方を取得するとき
ルートモデル結合でこのように書いたとき、
Route::get('/library/{library}/book/{book}/'....
指定のlibraryの蔵書内にbook_idがあるかどうかを自動的に参照してもらえますが、このときテーブル名をlibrary_booksにしていたらエラーになりました。
ルートモデル結合の処理時には、自動的に2つのモデル名がアルファベット順に連結されたテーブル名を参照しようとするため、「book_librariesテーブルがないですよ」というエラーに。
任意のテーブル名を使うときは、belongsToManyメソッドの第二引数にテーブル名を入れるだけで参照先が上書きされます。
/**
* 貸出中の蔵書一覧を取得
*
* @return void
*/
public function lendingBooks()
{
return $this->belongsToMany(Book::class, 'library_books')
->wherePivot('lending', true);
}
リレーションについて理解しておくべきこと
中間テーブルの値を使ってリレーション先の状態を定義する場合、テストコード等でちょっとハマりました。ちょっと考えればわかったことかもしれませんが、まあ筆者はアホなんだなあと
遅延読み込み
さて筆者は、貸出中の書籍だけを取り出すためのこんなリレーションを定義しました。
/**
* 貸出中の蔵書を取得
*
* @return void
*/
public function checkedOutBooks()
{
return $this->belongsToMany(Book::class, 'library_books')
->using(LibraryBook::class)
->withPivot('checked_out')
->wherePivot('checked_out', true);
}
この記述によって、こう書くことで貸出中の蔵書だけ取得できるようになったわけなので、
$library->checkedOutBooks;
返却処理のテストの中で、返却処理の前後で貸出中の蔵書を数えるアサーションをいれました。
$this->createCheckedOutBooks($request_books); // 3冊の貸出を行う
$this->assertCount(3, $library->checkedOutBooks);
// ~~~~~~返却処理を実行~~~~~~
$this->assertCount(0, $library->checkedOutBooks);
筆者は、こう書けばいい感じにテーブルの状態を比較できると思っちゃったわけです。
でも実際は、処理の前後で$library->checkedOutBooksの中身はなにも変わっていません。
一度取ってきたらもう取らない
クエリログを出力するメソッドを使って実験したところ、こんな結果でした。
処理前に出力
\DB::enableQueryLog();
$library->checkedOutBooks;
dump(\DB::getQueryLog());
// 出力されたクエリ
* array:1 [
* 0 => array:3 [
* "query" => "select `books`.*, `library_books`.`library_id` as `pivot_library_id`, `library_books`.`book_id` as `pivot_book_id`, `library_books`.`checked_out` as `pivot_checked_out` from `books` inner join `library_books` on `books`.`id` = `library_books`.`book_id` where `library_books`.`library_id` = ? and `library_books`.`checked_out` = ?"
* "bindings" => array:2 [
* 0 => 6
* 1 => true
* ]
* "time" => 1.3
* ]
* ]
$this->createCheckedOutBooks($request_books); // 3冊の貸出を行う
$this->assertCount(3, $library->checkedOutBooks); // 貸出中を数えても0。通らない
処理後に出力
$this->createCheckedOutBooks($request_books); // 3冊の貸出を行う
$this->assertCount(3, $library->checkedOutBooks); // 通る
\DB::enableQueryLog();
$library->checkedOutBooks;
dump(\DB::getQueryLog());
// 出力されたクエリ
[]
このような結果に。
つまり、初回はDBを参照して値を取得するが、その後は取得済みの値を参照する仕様になっているということのようです。
一度取得した値は、単にDBから取り出した情報がメモリ空間に配置されているに過ぎないので、DBの状態が変わっても取得済みの値が変わってるはずありません。当たり前ですね。
ちなみに、Readouble.comのリレーションのページには、
プロパティとしてEloquentリレーションへアクセスすると、関連するモデルは「遅延読み込み」されます。
と記述されています。
つまり、
$library = Library::find(1);
が実行された時点では、Libraryのリレーション先は読み込まれていません。
そりゃそうですよね。リレーション先なんていくつ設定されるかわかりませんし。
$library = Library::find(1);
$library->checkedOutBooks;
2行目まで来て、初めてリレーション先を読み込むクエリが発行されます。
つまりデフォルトでは、
$library = Library::find(1); // 読み込まない
$library->checkedOutBooks; // 読み込む->保存される
$library->checkedOutBooks; // 読み込まない
こうなるように実装されており、なるべく余計なクエリを発行しないような作りになっていると。
ただReadouble.comで紹介されている通り、このままforeach ($library->books as $book)してしまうと、一冊ごとにクエリを発行して値を取ってきます。N+1問題発生。取得した値をただ返すだけでなく処理に用いる場合は、withでリレーション先を含めて取り出してから使うべきです。
筆者は$libraryの取得にはすべてルートモデル結合を使っているので、RouteServiceProvider内でwithメソッドを付けることでN+1を防止します。
public function boot()
{
+ Route::bind('library', function ($id) {
+ return Library::with('books')->findOrFail($id);
+ });
まとめ
夏以降はフロントエンドにかまけていたのでいろいろと思い出さないといけないことが多く、また知らなかった仕様などもあって、自分はまだまだ何も知らないんだなあと思わされました。