lalavelで他テーブルに参照(Relation)している場合のREST応答

Question

Laravel5.5でスマホアプリの開発しています。
他のテーブルに参照(Relation)している名前をREST応答はどのようにすればよいでしょうか？
Table1ではUser_idのみ保有していて、Usersテーブルに「氏名」を保持しています

その場合に、APIで処理していてREST-APIの返答で「氏名」もデータとしていれたい場合はどのようにすればよいでしょうか？

Controllerでの処理は以下のようなイメージで処理したいと考えています

$users = Tables1::where('tokuten', '>' ,60)->get();
return $users;

データベース構成は以下の通りです。
Table1:user_id,tokuten
Table2:user_id,user_name

Modelは
Table1-Modelは

public function belong_user() {
return $this->belongsTo(Table2::class);
}

で、Table2-Modelは

public function has_table1() {
return $this->hasOne(Table1::class);
}

よろしくお願いします。

Comments

[masaya_ohashi]

リレーションしているプロパティ名も書いてくれると回答をもっと詳しくできます。

Answer 1

withを使います。

$users = Tables1::where('tokuten', '>' ,60)->with('belong_user')->get();

こうすることで、RESTのレスポンスとしては以下のような形になります。

[
  {
    user_id:1,
    tokuten:100,
    belong_user: {
      user_id:1,
      user_name: 'John'
    }
  }
]

withはget等の取得の時点でリレーションしたモデルも全て取得するためのメソッドです。Eloquentで取得したモデルは、$user->belong_userとリレーションした要素にアクセスするまで、$userにはbelong_userのデータは含まれておりません。->belong_userとアクセスしたとき、初めてSQLが実行されてbelong_userの中身が埋め込まれます。これは「別にアクセスしないかもしれないデータまで全部取っとくとメモリも処理速度も無駄」という仕組みで、「遅延ロード」と呼ばれます。しかし、この場合逆に「for等で全てのuserのbelong_userにアクセスする場合、アクセスしたuserの数分だけSQLがガンガン実行される」というデメリットもあります。

これを「最初にuser取ってくるときに、ついでに一つのクエリでbelong_userもまとめて取ってしまおうぜ！」というのがwithメソッドです。こういった「先取りロード」のことを「Eagerロード」といいます。
試しにwithありとなしでdd等で$user->toArray()を表示してみてください。withを使った場合、belong_user以下が含まれているのが確認できるかと思います。

Comments

[yamayamak]

すごい、Laravelって感動です。と思って試してますが、私には難しすぎました。
Table1:user_id,tokuten
Table2:user_id,user_name
とした場合に
---------
$users = Tables1::where('tokuten', '>' ,60)->with('user_name')->get();
---------
でいけますでしょうか？
Modelに何か記載が必要でしょうか？
すみません、ご教授をお願いします。

[masaya_ohashi]

Tables1でどのような名前でリレーションを組んでいるかが必要です。hasOneとかbelongsToとかでリレーション組んでいませんか？

[masaya_ohashi]

Modelのコードと、DBのテーブル定義を質問文に追記してもらえると答えやすいです。

[yamayamak]

なるほど、ありがとうございます。
Modelは
-----Table1-Model------
public function belong_user() {
return $this->belongsTo(Table2::class);
}
---------------------
で
-----Tables2-Model------
public function has_table1() {
return $this->hasOne(Table1::class);
}
---------------------
のような感じです。

[masaya_ohashi]

できればこちらのコメントではなく質問文を編集して追記していただけますか？今後同じ問題を抱えた人の参考になるので、質問文と回答を見るだけで分かるようにしておきたいのです。
とりあえず情報はいただけたので、回答を更新しますね。

[yamayamak]

ありがとうございます！
助かりました。ただ、よく考えると以下のようなものでもいけそうでした。。。。
--------------
$users = \DB::table('table1s')
->join('table2s', 'table1s.user_id', '=', 'table2s.user_id')
->select('table1s.*', 'table2s.user_name')
->get();
--------------

[masaya_ohashi]

あー、モデルを通さずにするならそうですね。そのやり方で問題ないならそちらのほうが無駄にレスポンスの階層も増えないし、いいと思います。

[masaya_ohashi]

「自己解決」の欄にそのやり方も残しておくと、今後同じ問題を抱えた人の参考になるので書き足しておくとGoodだと思います。

[yamayamak]

どちらにしてもありがとうございます。Laravelがいまいち理解できていないので助かりました。
また、お願いします！

[yamayamak]

ありがとうございます。自己解決にも入れときました。備忘録にもなりますので。。。

Answer 2

こちらのリファレンスはご覧になられましたでしょうか？
もしまだご覧になられていない場合はご覧ください。
https://readouble.com/laravel/5.5/ja/eloquent-relationships.html

「Tables1の情報を、その行のUser_idに対応するidのユーザの氏名を加えて返す」ということをやりたい場合、こんな感じになると思います。

※変数名、カラム名、リレーションを定義するメソッド名などは適当につけてます。
※別途Tables1モデルでリレーションを定義する必要があります。
※DBのカラム名はスネークケース、キャメルケース統一した方がいいです。

$items = Tables1::where('tokuten', '>' ,60)->with("user")->get();

$users = [];
foreach ($items as $item) {
    $users[] = [
        "id"   => $item->User_id,
        "name" => $item->user->name,
        "tokuten" => $item->tokuten,
        ・
        ・
        ・
    ];
}

return $users;

Comments

[yamayamak]

回答ありがとうございます！参考になります。

Answer 3

ただ、よく考えると以下のようなものでもいけそうでした。。。。

$users = \DB::table('table1s')
->join('table2s', 'table1s.user_id', '=', 'table2s.user_id')
->select('table1s.*', 'table2s.user_name')
->get();