Laravel Eloquent 搜索的常見挑戰(zhàn)

在 Laravel 應(yīng)用中，當(dāng)需要對(duì)主模型（如 User）及其關(guān)聯(lián)模型（如 Role、Department）進(jìn)行多條件模糊搜索時(shí)，開發(fā)者常會(huì)遇到查詢結(jié)果不符合預(yù)期的問題。一個(gè)典型的場(chǎng)景是，用戶希望通過一個(gè)搜索詞，同時(shí)匹配用戶的姓名、郵箱，以及其所屬的角色或部門的標(biāo)題。

原始代碼嘗試通過 User::with([...])->search(...) 的方式來實(shí)現(xiàn)，但這種方法存在根本性誤解：

$query = User::with([
    'roles' => function($query) use($searchValues) {
        return $query->where('title', 'LIKE','%'.$searchValues.'%');
    },
    'departments' => function($query) use($searchValues) {
        return $query->where('title', 'LIKE','%'.$searchValues.'%');
    }
])
->search($searchValues) // 這里的 search scope 僅針對(duì) User 模型字段
->orderBy($orderColumnName,$order)
->limit($request->length)
->get();

上述代碼中，with() 方法用于預(yù)加載關(guān)聯(lián)數(shù)據(jù)，以便在獲取 User 模型實(shí)例后，能夠方便地訪問其 roles 和 departments。with() 中的閉包條件只是限制了預(yù)加載的關(guān)聯(lián)數(shù)據(jù)，而不是用來過濾主模型（User）的。這意味著，即使某個(gè)用戶不滿足 roles 或 departments 的搜索條件，只要他滿足 User 自身的 search 條件，該用戶仍然會(huì)被查詢出來，只是其關(guān)聯(lián)的 roles 或 departments 可能為空或被過濾。這與我們期望的“通過關(guān)聯(lián)模型條件來篩選主模型”的目的背道而馳。

理解 orWhereHas 的作用

要解決上述問題，我們需要使用 whereHas 或 orWhereHas 方法。這些方法允許我們根據(jù)關(guān)聯(lián)模型的條件來過濾主模型。

• whereHas(relation, callback): 僅當(dāng)關(guān)聯(lián)模型滿足 callback 條件時(shí)，才返回主模型實(shí)例。這相當(dāng)于 SQL 中的 INNER JOIN 或 EXISTS 子句。
• orWhereHas(relation, callback): 在 OR 邏輯下，當(dāng)關(guān)聯(lián)模型滿足 callback 條件時(shí)，返回主模型實(shí)例。這通常用于將關(guān)聯(lián)模型的條件與主模型的條件進(jìn)行聯(lián)合搜索。

在我們的多條件模糊搜索場(chǎng)景中，用戶可能希望匹配任意一個(gè)條件（用戶姓名、郵箱，或角色標(biāo)題，或部門標(biāo)題），因此 orWhereHas 是更合適的選擇。

構(gòu)建多條件關(guān)聯(lián)搜索

為了實(shí)現(xiàn)既能搜索用戶自身屬性，又能搜索關(guān)聯(lián)模型屬性的復(fù)雜查詢，我們需要將 scopeSearch 與 orWhereHas 結(jié)合起來，并注意 orWhere 的邏輯分組。

首先，確保 User 模型中的 scopeSearch 方法正確定義，用于搜索用戶自身的 first_name, last_name, email：

// app/Models/User.php
class User extends Authenticatable
{
    // ... 其他屬性和方法 ...

    /**
     * 作用域：根據(jù)姓名和郵箱進(jìn)行模糊搜索。
     */
    public function scopeSearch($query, $searchValues)
    {
        // 注意：這里的 orWhere 是針對(duì) User 模型的字段
        return $query->where('first_name', 'like', '%'.$searchValues.'%')
                     ->orWhere('last_name', 'like', '%'.$searchValues.'%')
                     ->orWhere('email', 'like', '%'.$searchValues.'%');
    }

    // ... 關(guān)聯(lián)關(guān)系定義 ...
    public function departments()
    {
        return $this->belongsToMany(Department::class, 'users_departments', 'user_id', 'department_id');
    }

    public function roles()
    {
       return $this->belongsToMany(Role::class, 'users_roles', 'user_id', 'role_id');
    }
}

接下來，構(gòu)建正確的 Eloquent 查詢：

use App\Models\User;
use Illuminate\Http\Request;

// 假設(shè) $request->searchValues, $request->orderColumnName, $request->order, $request->length 已定義

// 定義一個(gè)可復(fù)用的閉包，用于關(guān)聯(lián)模型的搜索條件
$searchClosure = function ($query) use ($searchValues) {
    return $query->where('title', 'LIKE', "%{$searchValues}%");
};

$users = User::with(['roles' => $searchClosure, 'departments' => $searchClosure])
    ->where(function ($query) use ($searchValues, $searchClosure) {
        // 首先應(yīng)用 User 模型的自身搜索條件
        $query->search($searchValues);

        // 然后使用 orWhereHas 引入關(guān)聯(lián)模型的搜索條件
        // 注意：這里的 orWhereHas 會(huì)在外部的 where 閉包中與 scopeSearch 的條件進(jìn)行 OR 邏輯組合
        $query->orWhereHas('roles', $searchClosure);
        $query->orWhereHas('departments', $searchClosure);
    })
    ->orderBy($orderColumnName, $order)
    ->limit($request->length)
    ->get();

代碼解釋：

1. $searchClosure: 定義了一個(gè)可復(fù)用的閉包，封裝了對(duì)關(guān)聯(lián)模型 title 字段的模糊搜索邏輯。這提高了代碼的可讀性和維護(hù)性。
2. User::with(['roles' => $searchClosure, 'departments' => $searchClosure]): 這部分仍然用于預(yù)加載匹配條件的 roles 和 departments。雖然 orWhereHas 已經(jīng)過濾了主模型，但我們通常仍然需要加載這些關(guān)聯(lián)數(shù)據(jù)以便在視圖中顯示。
3. ->where(function ($query) use ($searchValues, $searchClosure) { ... }): 這是一個(gè)關(guān)鍵步驟。我們將所有的搜索條件（包括用戶自身字段和關(guān)聯(lián)字段）包裹在一個(gè) where 閉包中。這確保了所有 OR 條件被正確地分組，避免了與全局作用域或其他查詢條件產(chǎn)生意外的邏輯交叉。
   • $query->search($searchValues): 調(diào)用 User 模型上的 scopeSearch 方法，添加 first_name, last_name, email 的 OR 條件。
   • $query->orWhereHas('roles', $searchClosure): 添加一個(gè) OR 條件，如果用戶有任何角色滿足 $searchClosure 中的條件，則該用戶被選中。
   • $query->orWhereHas('departments', $searchClosure): 同樣，添加一個(gè) OR 條件，如果用戶有任何部門滿足 $searchClosure 中的條件，則該用戶被選中。 這整個(gè)閉包內(nèi)的條件將作為一個(gè)整體的 WHERE (condition1 OR condition2 OR condition3) 應(yīng)用到查詢中。

with 與 whereHas/orWhereHas 的區(qū)別

理解這兩者的核心區(qū)別至關(guān)重要：

• with() (預(yù)加載):

  • 目的: 優(yōu)化 N+1 查詢問題，一次性加載所有主模型實(shí)例的關(guān)聯(lián)數(shù)據(jù)。
  • 行為: 不會(huì)過濾主模型。它只是在主模型被查詢出來后，為每個(gè)主模型實(shí)例加載其關(guān)聯(lián)數(shù)據(jù)。閉包條件僅作用于加載的關(guān)聯(lián)數(shù)據(jù)集。
  • SQL: 通常會(huì)生成兩條或多條 SQL 查詢（一條用于主模型，一條或多條用于關(guān)聯(lián)模型，通過 IN 子句連接）。

• whereHas() / orWhereHas() (條件過濾):

  • 目的: 根據(jù)關(guān)聯(lián)模型的條件來過濾主模型。
  • 行為: 只有當(dāng)關(guān)聯(lián)模型滿足指定條件時(shí)，對(duì)應(yīng)的主模型實(shí)例才會(huì)被返回。
  • SQL: 通常會(huì)生成一條包含 JOIN 或 EXISTS 子句的 SQL 查詢，直接在數(shù)據(jù)庫(kù)層面進(jìn)行過濾。

簡(jiǎn)而言之，with 是“獲取這些用戶，并把他們的角色和部門也帶上”，而 whereHas/orWhereHas 是“只獲取那些有特定角色或部門的用戶”。在復(fù)雜搜索中，兩者通常需要結(jié)合使用：先用 whereHas/orWhereHas 過濾出符合條件的主模型，再用 with 預(yù)加載這些主模型的關(guān)聯(lián)數(shù)據(jù)。

orWhere 邏輯分組的重要性

Laravel 官方文檔強(qiáng)烈建議在使用 orWhere 時(shí)進(jìn)行邏輯分組，以避免意外行為。例如：

// 推薦的做法
$query->where(function ($q) {
    $q->where('name', 'like', '%John%')
      ->orWhere('email', 'like', '%John%');
});

// 可能導(dǎo)致意外行為（尤其當(dāng)有全局作用域時(shí)）
$query->where('status', 'active')
      ->orWhere('name', 'like', '%John%')
      ->orWhere('email', 'like', '%John%');

在我們的解決方案中，我們將所有的 search 和 orWhereHas 條件都包裹在一個(gè) where 閉包中，這正是遵循了 orWhere 邏輯分組的最佳實(shí)踐，確保了整個(gè)搜索邏輯的清晰性和正確性。

注意事項(xiàng)與性能優(yōu)化

1. 索引: 確保 users 表的 first_name, last_name, email 字段，以及 roles 和 departments 表的 title 字段上建立了適當(dāng)?shù)臄?shù)據(jù)庫(kù)索引。對(duì)于 LIKE '%value%' 這種前綴模糊匹配，標(biāo)準(zhǔn)索引可能效率不高，但對(duì)于 LIKE 'value%' 或精確匹配則非常有效。考慮使用數(shù)據(jù)庫(kù)特定的全文搜索功能（如 MySQL 的 FULLTEXT 索引）來優(yōu)化復(fù)雜的模糊搜索。
2. 大數(shù)據(jù)量: 當(dāng)用戶量、角色或部門數(shù)量非常龐大時(shí)，頻繁進(jìn)行多表 JOIN 和 LIKE 查詢可能會(huì)導(dǎo)致性能瓶頸。
   • 考慮引入專業(yè)的搜索服務(wù)，如 Elasticsearch 或 Algolia，它們專門為復(fù)雜搜索和大數(shù)據(jù)量場(chǎng)景設(shè)計(jì)。
   • 對(duì)于簡(jiǎn)單的模糊搜索，可以考慮對(duì)搜索詞進(jìn)行分詞處理，或限制搜索結(jié)果的數(shù)量。
3. 查詢調(diào)試: 在開發(fā)過程中，使用 toSql() 和 getBindings() 方法來查看 Eloquent 生成的實(shí)際 SQL 語句及其綁定參數(shù)，這對(duì)于調(diào)試復(fù)雜的查詢非常有幫助。

   $usersQuery = User::with([...])->where(function ($query) { /* ... */ });
   dd($usersQuery->toSql(), $usersQuery->getBindings());

   登錄后復(fù)制

總結(jié)

在 Laravel Eloquent 中實(shí)現(xiàn)多條件、多關(guān)聯(lián)模型的復(fù)雜搜索，需要深入理解 with、whereHas 和 orWhereHas 的不同作用。核心要點(diǎn)在于：

• 使用 whereHas 或 orWhereHas 來根據(jù)關(guān)聯(lián)模型的條件過濾主模型。
• 使用 with 來預(yù)加載過濾后的主模型的關(guān)聯(lián)數(shù)據(jù)，以避免 N+1 問題。
• 始終將 orWhere 條件進(jìn)行邏輯分組，以確保查詢邏輯的準(zhǔn)確性和可預(yù)測(cè)性。

通過遵循這些最佳實(shí)踐，您可以構(gòu)建出高效、健壯且易于維護(hù)的 Laravel 搜索功能。

以上就是Laravel Eloquent 高級(jí)搜索：解決多關(guān)聯(lián)模型與多條件查詢難題的詳細(xì)內(nèi)容，更多請(qǐng)關(guān)注php中文網(wǎng)其它相關(guān)文章！