Laravel Eager Loading：获取唯一关联模型的最佳实践

本文深入探讨了在 laravel 中处理 `belongstomany` 关系时，如何通过 eager loading 高效地获取唯一的关联模型数据。当需要根据中间表（pivot table）条件过滤并确保关联模型（如产品）不重复时，直接的 `with` 查询可能导致重复项。文章详细介绍了如何结合使用 `distinct()` 和 `select()` 方法，在 eager loading 闭包中精确控制关联数据的唯一性，从而实现更精准的数据查询和展示。

问题阐述

在 Laravel 应用开发中，我们经常会遇到模型之间存在多对多（belongsToMany）关系的情况，例如一个 Collection（集合）可以包含多个 Product（产品）。当我们需要加载一个 Collection 及其关联的 Product，并且这些 Product 需要根据中间表（pivot table）的特定属性（如 size）进行过滤时，一个常见的挑战是如何确保加载的 Product 列表是唯一的，避免出现重复的产品条目。

例如，假设 Collection 和 Product 之间通过一个包含 size 字段的中间表关联。我们希望获取所有满足特定 size 条件的 Collection，并且每个 Collection 加载的 Product 列表也只包含唯一的 Product。

原始查询及分析

通常，我们会使用 with 方法进行 Eager Loading，并结合 whereHas 方法来过滤主模型。一个初步的查询可能如下所示：

$collections = Collection::with(['products' => function ($q) use ($request) {
            $q->whereIn('size', $sizes);
        }])->whereHas('products', function ($q) use ($request) {
            $q->whereIn('size', $sizes);
        })->active()->get();

这段代码的目的是：

1. 加载所有 active 状态的 Collection。
2. 只加载那些至少包含一个 size 满足 $sizes 数组中条件的 Product 的 Collection（通过 whereHas 实现）。
3. 对每个加载的 Collection，其关联的 products 只包含 size 满足 $sizes 条件的产品（通过 with 闭包实现）。

然而，这种方法存在一个问题：如果一个 Collection 通过不同的 size 关联了同一个 Product 多次（在中间表中有多条记录，但 product_id 相同，size 不同），那么在 Eager Loading 结果中，这个 Product 可能会在同一个 Collection 的 products 关系中出现多次，导致重复。尝试在主查询后使用 ->unique('products.id') 是无效的，因为 unique() 方法作用于 Collection 集合本身，而不是每个 Collection 内部的 products 关系。

豆包大模型

字节跳动自主研发的一系列大型语言模型

834

查看详情

解决方案：利用 distinct() 方法

要解决这个问题，我们需要在 Eager Loading 的查询闭包中，对关联模型（products）的查询应用 distinct() 方法。distinct() 方法会强制查询返回唯一的结果。为了确保 distinct() 能够正确地基于产品的唯一标识符（如 id）进行去重，通常还需要配合 select() 方法，明确指定要选择的列。

代码示例

以下是修正后的查询代码：

use Illuminate\Http\Request; // 假设 $request 是一个 Request 实例

// 假设 $sizes 数组包含需要过滤的尺寸，例如 ['small', 'medium']
$sizes = $request->input('sizes', ['small', 'medium']); 

$collections = Collection::with(['products' => function ($q) use ($sizes) {
            $q->whereIn('size', $sizes)
              ->select('products.id', 'products.name', /* 其他需要的产品字段 */) // 明确选择产品字段
              ->distinct(); // 确保产品唯一
        }])->whereHas('products', function ($q) use ($sizes) {
            $q->whereIn('size', $sizes);
        })->active()->get();

关键点与注意事项

1. distinct() 的位置： distinct() 必须应用于 Eager Loading 闭包内部的关联模型查询 ($q)。它作用于数据库层面，确保在将关联产品加载到内存之前，就已经去除了重复项。
2. 配合 select() 使用： 为了使 distinct() 能够有效工作，并确保它基于你期望的唯一标识（例如 products.id）进行去重，强烈建议明确使用 select() 方法选择关联模型的字段。
   • 如果你只选择 products.id 并调用 distinct()，那么结果将只包含唯一的 product_id。
   • 如果你选择 products.id, products.name 等多个字段，distinct() 将会基于这些所有选择字段的组合进行去重。如果两个产品虽然 id 相同，但 name 不同（这在实际中通常不会发生，因为 id 是主键），它们仍可能被视为不同的记录。因此，通常我们选择主键和任何其他需要显示的字段。
3. whereHas 的作用： whereHas 依然是必要的，它用于过滤主模型 Collection，确保只有那些至少包含一个满足条件的 Product 的 Collection 才会被加载。它与 with 闭包中的过滤是互补的。
4. 去重范围： 这个解决方案确保了每个 Collection 内部的 products 关系中，产品是唯一的。它不会在不同的 Collection 之间去重产品。如果目标是获取所有 Collection 中唯一的 Product 列表（全局唯一），则需要不同的查询策略，例如直接查询 Product 模型并使用 whereHas('collections', ...)。
5. 性能考量： distinct() 会在数据库层面增加一些开销，但通常对于解决重复数据问题而言，这是值得的。对于大数据量，应关注查询性能并进行适当的索引优化。

总结

在 Laravel 中通过 Eager Loading 获取多对多关系中的唯一关联模型数据，是处理复杂数据结构时的常见需求。通过在 with 闭包中巧妙地结合 select() 和 distinct() 方法，我们可以有效地在数据库层面过滤并确保关联数据的唯一性，避免在应用层进行额外的去重操作，从而使代码更简洁、效率更高。理解 distinct() 的作用范围和与 select() 的配合使用，是编写高效且准确的 Laravel 数据库查询的关键。

以上就是Laravel Eager Loading：获取唯一关联模型的最佳实践的详细内容，更多请关注php中文网其它相关文章！