Laravel Eloquent：高效过滤嵌套关联数据并保持层级结构

本文深入探讨了在Laravel Eloquent中，如何针对多层级关联数据（如`Categories -> Subcategories -> Products`）执行高效的条件过滤。通过结合使用`whereHas`方法对父级和中间级进行初步筛选，以及利用带闭包的`with`方法进行受限预加载，我们能够精确地获取满足特定条件的子级数据，同时确保返回的整个层级结构中不包含空父级或空中间级，从而实现数据的精准展示与优化。

引言

在构建复杂的Web应用时，我们经常需要处理多层级的关联数据。例如，一个电商平台可能包含“分类(Categories)”、“子分类(Subcategories)”和“产品(Products)”这三层模型，它们之间存在一对多（或多对一）的关系。当需要根据最底层的数据（如产品）的特定条件来检索整个层级结构时，如何高效且准确地获取所需数据，同时避免加载无关内容，是Laravel Eloquent中一个常见的挑战。

问题场景：多层级关联数据的过滤需求

假设我们有以下模型关系：Categories (一对多) Subcategories (一对多) Products。在前端，我们希望展示一个可折叠的产品列表，例如：

Category1
  - Subcategory1
    - Product1
    - Product2
Category2
  - SubCategory3
    - Product4

现在，我们的目标是根据产品的名称或文章编号进行搜索，并以完整的层级结构返回结果，但只包含匹配的产品及其相应的上级分类和子分类。例如，搜索“Product1”时，我们期望得到：

Category1
 - Subcategory1
  - Product1

理想情况下，返回的数据集中不应包含任何没有匹配产品的空子分类或空分类。

初步尝试与局限性

最初，开发者可能会尝试使用whereHas来过滤顶层模型：

<?php
$Categories = Categories::whereHas('subcategories', function ($q) use ($request) {
    $q->whereHas('products', function ($q) use ($request) {
        $q->where('name', 'LIKE', "%$request->search%")
          ->orWhere('article_number', 'LIKE', "%$request->search%");
    });
})->get();
?>

这段代码能够正确地过滤出那些包含符合条件产品的分类。然而，它的局限性在于，一旦分类被选中，它会预加载该分类下所有的子分类和子分类下所有的产品，而不仅仅是那些符合搜索条件的产品。这意味着我们虽然得到了正确的父级，但子级数据仍然包含冗余。

另外一种思路是直接从Products模型开始反向查询，但这通常难以重建原始的Category -youjiankuohaophpcn Subcategory -> Product层级结构。

解决方案：结合 whereHas 与受限预加载

要实现精确过滤并保持层级结构，我们需要结合使用whereHas来过滤父级和中间级，以及利用带闭包的with方法（即受限预加载）来过滤实际加载的关联数据。这种方法确保了只有满足条件的层级和数据才会被加载。

即构数智人

即构数智人是由即构科技推出的AI虚拟数字人视频创作平台，支持数字人形象定制、短视频创作、数字人直播等。

36

查看详情

以下是实现这一目标的完整代码示例：

<?php
use App\Models\Category; // 假设你的模型在 App\Models 命名空间下
use Illuminate\Http\Request;

// 假设 $request 包含 'search' 参数
$request = new Request(['search' => 'Product1']);

$Categories = Category::whereHas('subcategories', function ($q) use ($request) {
    // 确保只有包含匹配产品的分类才会被选中
    $q->whereHas('products', function ($q) use ($request) {
        $q->where('name', 'LIKE', "%$request->search%")
          ->orWhere('article_number', 'LIKE', "%$request->search%");
    });
})->with(['subcategories' => function ($q) use ($request) {
    // 对子分类进行筛选：只加载那些包含匹配产品的子分类
    $q->whereHas('products', function ($q) use ($request) {
        $q->where('name', 'LIKE', "%$request->search%")
          ->orWhere('article_number', 'LIKE', "%$request->search%");
    })->with(['products' => function ($q) use ($request) {
        // 对产品进行筛选：只加载那些匹配搜索条件的产品
        $q->where('name', 'LIKE', "%$request->search%")
          ->orWhere('article_number', 'LIKE', "%$request->search%");
    }]);
}])->get();

// $Categories 现在包含了符合条件的产品及其完整的上级层级，且没有空层级
foreach ($Categories as $category) {
    echo $category->name . PHP_EOL;
    foreach ($category->subcategories as $subcategory) {
        echo '  - ' . $subcategory->name . PHP_EOL;
        foreach ($subcategory->products as $product) {
            echo '    - ' . $product->name . PHP_EOL;
        }
    }
}
?>

代码解析

让我们逐层分析上述代码的工作原理：

1. 顶层 whereHas('subcategories', ...)

   • 作用：这是最外层的过滤器，它确保只有那些其下属子分类中最终包含符合搜索条件产品的Category才会被查询出来。这解决了“不返回空分类”的问题。
   • 内部逻辑：通过嵌套的whereHas('products', ...)，检查Subcategory是否关联了符合条件的产品。

2. with(['subcategories' => function ($q) use ($request) { ... }])

   • 作用：这是Laravel的受限预加载机制。它指示Eloquent在加载Category时，同时预加载其subcategories关联。关键在于闭包内部的逻辑，它允许我们对预加载的subcategories进行进一步的过滤。

3. $q->whereHas('products', function ($q) use ($request) { ... }) (在 subcategories 闭包内)

   • 作用：这是解决“不返回空子分类”的关键。它对正在预加载的Subcategory模型集合进行筛选，确保只有那些其下属直接关联了符合搜索条件产品的Subcategory才会被加载并附加到其父级Category上。

4. ->with(['products' => function ($q) use ($request) { ... }]) (在 subcategories 闭包内)

   • 作用：这再次使用了受限预加载，但这次是针对Subcategory的products关联。它确保了在加载每个Subcategory时，只加载那些符合搜索条件的产品。
   • 内部逻辑：直接在products关联上应用where条件，精确过滤出匹配的产品。

通过这种层层递进的whereHas和受限with的组合，我们不仅过滤了顶层父级，还过滤了中间层级，并最终只加载了满足条件的最底层数据，从而实现了精准的层级数据检索。

注意事项与最佳实践

• 条件复用：在实际项目中，如果搜索条件（如name LIKE %...% OR article_number LIKE %...%）在多个地方重复，可以考虑将其封装成一个局部作用域（Local Scope）或一个可重用的闭包变量，以提高代码的可维护性。
• 性能考量：虽然这种方法避免了N+1查询问题（因为使用了预加载），但多次嵌套的whereHas和with可能会生成相对复杂的SQL查询。对于超大数据量或极其频繁的查询，应监控数据库性能，并考虑是否可以通过数据库视图、索引优化或更简单的查询结构来进一步提升效率。
• 空结果处理：如果搜索条件没有匹配到任何产品，$Categories集合将为空。在前端展示时，应妥善处理这种情况，例如显示“未找到相关产品”的消息。
• 可读性：对于更深层次的嵌套关联，这种查询可能会变得冗长。保持代码清晰，适当添加注释，有助于理解其逻辑。

总结

在Laravel Eloquent中处理嵌套关联数据的条件过滤时，结合使用whereHas和带闭包的with方法是一种强大且高效的模式。whereHas用于在查询父级时排除不包含目标子级的父级，而带闭包的with则用于在预加载子级时，对子级本身及其更深层次的关联进行精确过滤。通过这种方式，我们能够构建出既能保持数据层级结构完整性，又能精准加载所需数据的查询，从而优化应用性能并提升用户体验。

以上就是Laravel Eloquent：高效过滤嵌套关联数据并保持层级结构的详细内容，更多请关注php中文网其它相关文章！