如何在 Eloquent 建立一個含 or 的 where 條件式 ?

不使用 whereRaw() 也可以寫得出來

實務上在 Eloquent 下 where 條件式時，其中可能包含一個 or 條件判斷，這種需求該如何使用 Eloquent 的 query builder 建立呢?

Version

Laravel 5.2.29

Migration

create_posts_table.php1 1GitHub Commit : 建立 Post model 與 migration

database/migration/2016_04_10_143945_create_posts_table.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;

class CreatePostsTable extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::create('posts', function (Blueprint $table) {
            $table->increments('id');
            $table->string('title');
            $table->string('description');
            $table->text('content');
            $table->tinyInteger('status'); // 0: normal, 1:draft, 2:deleted
            $table->timestamps();
        });
    }

    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        Schema::drop('posts');
    }
}

13行

1
2
3
4
5
6
7
8
Schema::create('posts', function (Blueprint $table) {
    $table->increments('id');
    $table->string('title');
    $table->string('description');
    $table->text('content');
    $table->tinyInteger('status'); // 0: normal, 1:draft, 2:deleted
    $table->timestamps();
});

posts table 有 status 欄位，其中 0 為正常文章，1 為草稿文章，2 為已刪除文章。

SQL

需求為列出所有正常與草稿文章，若使用 SQL，我們會這樣寫 :

1
2
3
SELECT * 
FROM posts
WHERE (status = 0 or status = 1)

whereRaw()

若使用 Eloquent，我們該怎麼寫呢?很多人會想到 whereRaw() :
PostRepository.php2 2GitHub Commit : PostRepository.php 使用 whereRaw()

app/Repositories/PostRepository.php
1
2
3
4
5
6
7
8
9
10
11
12
namespace App\Repositories;

use App\Models\Post;

class PostRepository
{
    public function getUndeletedPosts()
    {
        return Post::whereRaw('status = 0 or status = 1')
            ->get();
    }
}

這樣寫當然可以，不過 whereRaw() 的程式可讀性較差，畢竟 whereRaw() 裡面是SQL字串。

where() + closure

PostRepository.php3 3GitHub Commit : PostRepository.php 使用 where() + closure

app/Repositories/PostRepository.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
namespace App\Repositories;

use App\Models\Post;

class PostRepository
{
    public function getUndeletedPosts()
    {
        return Post::where(function ($query) {
            $query->where('status', 0)
                ->orWhere('status', 1);
        })->get();

    }
}

比較好的寫法是將 or 部分，寫成 closure 傳入 where()，這比較符合物件導向與 Eloquent 風格。

Conclusion

  • 這 3 種寫法所產出的 SQL 都一樣，沒有執行效率問題。
  • 實務上建議少使用 DB::raw() 或 whereRaw()，可讀性較差，盡量使用 Eloquent 寫法。

Sample Code

完整的範例可以在我的 GitHub 上找到。

2016-04-09
▲