LaravelでのSQL直書きについての質問です。

Question

Laravelについて、質問なのですが、現在Laravelを使って、システム開発を行なっています。
以前に、Fuel PHPを使ったことがありフレームワークには慣れてはいますが、
Laravelに関して疑問に思って、可能かどうか調べてもあまり出てこないのでこちらで質問させていただきます。

DBにPostgresSQLをつかっており、データを取ってくる際はクエリビルダを基本的には使ってデータを取っています。
where,join等、問題なく利用できており今まで困っていませんでしたが、
複雑なSQLがあり、SQL文を直書きする必要が出てきました。

その際に
①、SQL文を書く場所は　Controllerでいいのか。
②、Fuel PHPではModelにSQLを書いて、Contorllerで必要な際に呼び出して、データを取ることができました。
（Moedelにget_date()というSQLが書かれたメソッドがある際は、Controllerでモデル::get_date()で使えてました）
Laravelでも、SQL文をモデルに記載して、それをコントローラーで呼び出すことはできるのでしょうか。もしくはモデル以外に記載して、呼び出すことができるのでしょうか。
③、②ができるとしたら、どのように記載を行えばいいのか、また引数を渡したい場合はどのようにしたらいいのか。

の以上3点を教えていただきたいです。
直接書きたいSQL文が、結構長くてこのままControllerに書いていると長くなりそうなのでそれを避けたいです。
現在はまだ規模が大きくないシステムなので、ServiceContorollerや、FormRequest、ユースケースはまだ使用していませんが、
後々面倒になりそうなので、それぞれ作成して製造を進めていくつもりです。

長くなりましたが、わかるかたがいらっしゃいましたら教えていただきたいです、
よろしくお願いいたします。

Answer 1

基本Modelにデータベース検索、更新の処理を書いて下さい
サンプルで書き捨てならどこでもいいですが
コントローラに以下のように書くのが見られますが
MVCの考え方からは推奨できません

・他のコントローラにもwhere書きそうでDRYじゃない
・そもそもコントローラに処理をゴリゴリ書くものではない

public function index(Request $request)
{
    $users = User::where('name', 'like', '%'.$request->input('keyword').'%')->get();
}

なので、Model内に書くのが良いと思います
ただし、インジェクションには気をつけて下さい

Comments

[kaihotate]

ありがとうございます。Model内に記載を行います。ありがとうございました。

Answer 2

①、SQL文を書く場所は　Controllerでいいのか。

Modelに書いたほうがいいと思います。

②、Fuel PHPではModelにSQLを書いて、Contorllerで必要な際に呼び出して、データを取ることができました。
（Moedelにget_date()というSQLが書かれたメソッドがある際は、Controllerでモデル::get_date()で使えてました）
Laravelでも、SQL文をモデルに記載して、それをコントローラーで呼び出すことはできるのでしょうか。もしくはモデル以外に記載して、呼び出すことができるのでしょうか。

Laravelは個人的にFuel PHPよりもユルく、大体どこに書いても呼び出せそうな雰囲気です。

③、②ができるとしたら、どのように記載を行えばいいのか、また引数を渡したい場合はどのようにしたらいいのか。

例えばUserモデルに、生SQLを使ったメソッドを追加する例を書いてみます。

• app/User.php

<?php

namespace App;

use Illuminate\Contracts\Auth\MustVerifyEmail;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Support\Facades\DB;

class User extends Authenticatable
{
    ...省略
    /**
     * 現在のユーザで挨拶を返す
     * @return array
     */
    public function greeting() {
        $sql = <<<SQL
SELECT CONCAT('私の名前は、「',name,'」です') AS hello FROM users
WHERE id = ?
-- この先死ぬほど複雑予定
SQL;
        return DB::select($sql,[$this->id]);
    }
    /**
     * みんなの挨拶を返す
     * @return array
     */
    public static function greetingAll() {
        $sql = <<<SQL
SELECT CONCAT('私の名前は、「',name,'」です') AS hello FROM users
-- この先死ぬほど複雑予定
SQL;
        return DB::select($sql);
    }
}

コントローラに記載してもいいですが、今回は手っ取り早くroutesに直接かきます。

• app/routes/web.php

<?php
...省略
Route::get('/greeting/{id}',function ($id){
    return \App\User::find($id)->greeting();
});
Route::get('/greeting',function (){
    return \App\User::greetingAll();
});

• ブラウザから/greeting/1にアクセスした結果

[
  {
    "hello": "私の名前は、「テスト 太郎」です"
  }
]

• ブラウザから/greetingにアクセスした結果

[
  {
    "hello": "私の名前は、「テスト 太郎」です"
  },
  {
    "hello": "私の名前は、「テスト 花子」です"
  }
]

Comments

[kaihotate]

大変助かりました。参考にさせていただきます。ありがとうございました。

Answer 3

ざっくりな答えになりますが、①②ともに良いといえば良いし、できるといえばできるでしょう。Laravelはフレームワークですが、どこにどの処理を書いてもそれで動けば問題ないという考えもあると思います。

ただ、保守性や可読性などを考慮すると、Fat ModelやFat Controllerになることは避けるのが無難です。Eloquentを使おうがクエリビルダを使おうが生SQLを使おうが、これは共通の認識になると思います。

これを避ける上でLaravelで一番定番なのはリポジトリパターンと呼ばれる手法だと思います。説明するとめちゃくちゃ長くなりますので、"Laravel リポジトリパターン"で検索してみてください。

参考）
https://qiita.com/karayok/items/d7740ab2bd0adbab2e06

ただ、むやみにリポジトリを分けたり複雑なクエリをリポジトリにまるっと委ねるとそれはそれで悪影響があるので、その辺は色んなサイトを見ながら学んでいってください。

参考）
https://qiita.com/mikesorae/items/ff8192fb9cf106262dbf

Comments

[kaihotate]

参考サイトまで、ありがとうございます。解決できました。またお力添えお願いいたします。