Laravel多对多关联条件筛选技巧

复杂关联查询的挑战

在Laravel应用开发中，处理多对多（Many-to-Many, M:M）关系是常见的场景。例如，一个“应用”（App）可以属于多个“分类”（Category），反之亦然。当我们需要从主表（如apps）中筛选记录，而筛选条件却依赖于其关联表（如categories）的某个字段时，传统的数据库查询方式可能会显得繁琐。

假设我们有两个模型App和Category，它们通过中间表apps_categories建立了M:M关系，并且在模型中正确定义了BelongsToMany关系。

模型关系定义示例：

App模型：

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsToMany;

class App extends Model
{
    /**
     * The categories that belong to the App.
     */
    public function categories(): BelongsToMany
    {
        return $this->belongsToMany(Category::class, 'apps_categories', 'app_id', 'category_id');
    }
}

Category模型：

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsToMany;

class Category extends Model
{
    /**
     * The apps that belong to the Category.
     */
    public function apps(): BelongsToMany
    {
        return $this->belongsToMany(App::class, 'apps_categories', 'category_id', 'app_id');
    }
}

现在，如果需要根据一组特定的category_id来筛选出所有关联了这些分类的App记录，我们可能会首先想到使用DB门面进行原始的SQL拼接，例如：

use Illuminate\Support\Facades\DB;

$categoriesToFilter = [1, 5, 10]; // 假设要筛选的分类ID数组

$apps = DB::table('apps')
  ->join('apps_categories', 'apps.id', '=', 'apps_categories.app_id')
  ->whereIn('apps_categories.category_id', $categoriesToFilter)
  ->select('apps.*')
  ->get();

这种方法虽然能够解决问题，但它脱离了Eloquent ORM的范式，降低了代码的可读性和可维护性，并且难以与其他Eloquent查询方法链式调用。在处理更复杂的关联查询（例如，一个应用同时与多个M:M关系表关联）时，这种方式会变得更加笨重。

使用 whereHas 方法优雅地过滤

Laravel Eloquent ORM提供了whereHas方法，专门用于根据关联关系的存在性或关联模型的属性来过滤主模型记录。它是解决上述M:M关系过滤问题的理想方案。

whereHas方法的基本语法如下：

Model::whereHas('relationName', function ($query) {
    // 在这里添加针对关联模型的查询条件
})->get();

其中：

• relationName：是主模型中定义关联关系的方法名（例如，在App模型中的categories方法）。
• $query：是Eloquent查询构建器的一个实例，它允许你对关联模型应用任何查询条件。

应用 whereHas 过滤示例：

假设我们有一个 $categoriesToFilter 数组，其中包含我们希望筛选的分类ID。

use App\Models\App;

$categoriesToFilter = [1, 5, 10]; // 假设要筛选的分类ID数组

$apps = App::whereHas('categories', function ($query) use ($categoriesToFilter) {
    $query->whereIn('categories.id', $categoriesToFilter);
})->get();

在这个例子中：

1. App::whereHas('categories', ...)：告诉Eloquent我们希望在App模型上应用一个条件，该条件基于其categories关联关系。
2. function ($query) use ($categoriesToFilter) { ... }：这是一个闭包，它接收一个$query实例，这个$query是针对categories表的查询构建器。
3. $query->whereIn('categories.id', $categoriesToFilter);：在关联表categories上应用whereIn条件，筛选出id在$categoriesToFilter数组中的分类。注意，这里需要明确指定表名categories.id，以避免列名冲突。

使用箭头函数（PHP 7.4+）的简洁写法：

对于简单的闭包，可以使用PHP 7.4引入的箭头函数使其更简洁：

use App\Models\App;

$categoriesToFilter = [1, 5, 10];

$apps = App::whereHas('categories', fn ($query) => $query->whereIn('categories.id', $categoriesToFilter))->get();

这两种写法的功能是完全相同的，开发者可以根据个人偏好和项目规范选择。

whereHas 的优势与注意事项

1. ORM范式统一： whereHas使查询保持在Eloquent ORM的框架内，与where、orderBy等方法无缝衔接，提升代码一致性。
2. 可读性与可维护性： 代码意图清晰，一眼就能看出是基于关联关系进行的筛选，降低了理解成本。
3. 链式调用： whereHas返回的是一个查询构建器实例，可以继续链式调用其他Eloquent方法，如orderBy、limit、with等，构建更复杂的查询。

   $apps = App::whereHas('categories', function ($query) use ($categoriesToFilter) {
       $query->whereIn('categories.id', $categoriesToFilter);
   })->with('categories')->orderBy('name')->get();

4. 性能考量： whereHas在底层会生成一个子查询（通常是EXISTS子查询），这在大多数情况下是高效的。对于非常大的数据集和复杂的关联，始终建议监控数据库查询性能，并根据需要添加索引。
5. 模型关系定义： 使用whereHas的前提是，主模型中必须正确定义了与目标关联模型的关联关系方法（如categories()）。

总结

whereHas方法是Laravel Eloquent ORM中处理多对多关系过滤的强大工具。它提供了一种优雅、符合ORM范式的方式，让开发者能够轻松地根据关联表的条件筛选主表记录。通过掌握whereHas的使用，开发者可以编写出更具可读性、可维护性且高效的Eloquent查询，从而更好地利用Laravel的强大功能来构建复杂的Web应用。在需要基于关联关系存在性或其属性进行过滤时，whereHas无疑是首选的解决方案。