Laravel Eloquent：同时筛选父子表数据的教程

本教程详细阐述了如何在 laravel 中利用 eloquent orm 同时对父表和子表数据进行筛选。文章将深入探讨两种核心方法：使用 `join` 子句进行直接数据库连接，以及采用 `wherehas` 方法实现更具 eloquent 风格的关联查询。通过实际代码示例，您将学会如何根据父表的字段（如年份）和子表的字段（如标签id）构建高效且可读的过滤逻辑，并集成到控制器和视图中。

在 Laravel 应用开发中，我们经常需要处理具有一对多或多对多关系的数据。当用户需要根据父表和其关联子表的字段同时进行筛选时，如何高效地构建查询是关键。本教程将以 Post (父表) 和 PostTag (子表) 为例，演示如何实现这一需求，具体涉及根据 Post 表的 year 字段和 PostTag 表的 tag_id 字段进行过滤。

1. 模型及关系定义

首先，确保您的 Eloquent 模型已正确定义了它们之间的关系。在本例中，Post 模型与 PostTag 模型之间存在一对多关系。

Post.php

hasMany(PostTag::class);
    }
}

PostTag.php

belongsTo(Post::class);
    }
}

2. 视图中的筛选表单

用户通过一个包含年份和标签选择的表单来提交筛选请求。

View (movies/search_form.blade.php)

    
        @lang('movies.movie_all')
        @if ($tags)
            @foreach ($tags AS $tag)
                {{ $tag->name }}
            @endforeach
        @endif
    
    
        @lang('public.public_year')
        @php
            $currentYear = date('Y');
            for ($i = $currentYear; $i > 1970; $i--) {
                echo "".$i."";
            }
        @endphp
    
    @lang('public.public_filter')

3. 路由定义

定义一个 GET 路由来处理筛选请求。

web.php

Route::prefix('/movies')->group(function () {
    Route::get('/search', [MovieController::class, 'MoviesDataSearch'])->name('movies.movie_search');
});

4. 控制器中的筛选逻辑

在控制器中，我们将介绍两种实现父子表同时筛选的方法：使用 join 子句和使用 whereHas 方法。

4.1 方法一：使用 join 子句

join 子句允许您直接在数据库层面连接两个或多个表，然后对连接后的结果进行筛选。这种方法通常在需要高性能或需要直接访问连接表中所有列时非常有用。

优点：

• 性能通常较好，尤其是在处理大量数据时。
• 可以直接在查询中访问所有连接表的列。

缺点：

• 如果不对 select 语句进行处理，可能会出现列名冲突。
• 如果一个父记录有多个匹配的子记录，可能会导致父记录重复出现，需要使用 distinct() 或 groupBy() 来避免。

MovieController.php (使用 join)

where('posts.post_type', "movie")
              ->where('posts.is_delete', "0");

        // 如果存在标签筛选，则使用 join 连接 posts_tags 表
        if ($request->filled('tag')) {
            // 注意：'posts_tags.post_id' 是 PostTag 模型中指向 Post 模型的外键
            $query->join('posts_tags', 'posts.id', '=', 'posts_tags.post_id')
                  ->where('posts_tags.tag_id', $request->tag); // 假设 tag_id 是精确匹配
            // 如果需要模糊匹配，可以使用 ->where('posts_tags.tag_id', 'like', '%'.$request->tag.'%');
        }

        // 如果存在年份筛选
        if ($request->filled('year')) {
            $query->where('posts.year', 'like', '%'.$request->year.'%');
        }

        // 避免因 join 导致重复的 Post 记录，并仅选择 Post 表的列
        $movies = $query->select('posts.*')
                        ->distinct() // 确保每个 Post 记录只出现一次
                        ->orderBy('posts.id', 'DESC')
                        ->paginate(12); // 分页大小可根据需求调整

        // 保持筛选参数在分页链接中
        return $movies->appends($request->all());
    }
}

注意事项：

• join('posts_tags', 'posts.id', '=', 'posts_tags.post_id'): 这里的 posts_tags.post_id 是 PostTag 表中关联 Post 表的外键。请根据您的实际数据库结构调整。
• select('posts.*'): 在使用 join 时，为了避免返回重复的列名或不必要的子表数据，通常建议明确指定要选择的列。
• distinct(): 如果一个 Post 记录有多个 PostTag 匹配筛选条件，join 可能会导致该 Post 记录在结果集中出现多次。distinct() 可以确保每个 Post 记录只返回一次。

4.2 方法二：使用 whereHas 方法

whereHas 是 Eloquent 提供的一种更高级、更具对象化风格的方法，用于根据关联模型的条件来筛选父模型。它会在底层生成一个 EXISTS 子查询。

优点：

• 代码更简洁，更符合 Eloquent 的设计理念。
• 自动处理连接逻辑，无需手动指定 join 条件。
• 避免了 join 可能导致的重复父记录问题。

缺点：

• 对于非常复杂的关联查询或需要高度优化性能的场景，有时 join 可能更直接高效。
• 无法直接选择关联模型的列。

MovieController.php (使用 whereHas)

where('post_type', "movie")
              ->where('is_delete', "0");

        // 如果存在年份筛选
        if ($request->filled('year')) {
            $query->where('year', 'like', '%'.$request->year.'%');
        }

        // 如果存在标签筛选，则使用 whereHas
        if ($request->filled('tag')) {
            $query->whereHas('PostTags', function ($q) use ($request) {
                // 在关联模型 PostTag 上应用筛选条件
                $q->where('tag_id', $request->tag); // 假设 tag_id 是精确匹配
                // 如果需要模糊匹配，可以使用 $q->where('tag_id', 'like', '%'.$request->tag.'%');
            });
        }

        $movies = $query->orderBy('id', 'DESC')
                        ->paginate(12);

        // 保持筛选参数在分页链接中
        return $movies->appends($request->all());
    }
}

注意事项：

• whereHas('PostTags', function ($q) use ($request) { ... }): PostTags 是在 Post 模型中定义的关系方法名。闭包函数 $q 代表了对 PostTag 模型进行的查询。
• $request->filled('year') 和 $request->filled('tag'): 使用 filled() 方法可以检查请求参数是否存在且非空，这有助于构建更健壮的条件查询。

5. 总结与最佳实践

• 选择方法：
  • 如果您需要直接从关联表中选择列，或者对性能有极高要求且熟悉 SQL JOIN 语句的优化，join 方法可能更适合。
  • 如果您追求代码的 Eloquent 风格、可读性，并且主要目的是根据关联条件筛选父模型，那么 whereHas 是更推荐的选择。它通常能满足大部分业务需求，并且更不容易引入重复记录的问题。
• 条件查询： 在控制器中，使用 if ($request->filled('param')) 或 Eloquent 的 when() 方法来根据请求参数的有无动态构建查询条件，可以使代码更加灵活和健壮。

  // 使用 when() 的示例
  $movies = Post::where('post_type', "movie")
      ->where('is_delete', "0")
      ->when($request->filled('year'), function ($query) use ($request) {
          return $query->where('year', 'like', '%'.$request->year.'%');
      })
      ->when($request->filled('tag'), function ($query) use ($request) {
          return $query->whereHas('PostTags', function ($q) use ($request) {
              $q->where('tag_id', $request->tag);
          });
      })
      ->orderBy('id', 'DESC')
      ->paginate(12);

• 分页链接： 务必使用 $movies->appends($request->all()) 来确保在分页时，所有当前的筛选参数都能被保留，从而提供更好的用户体验。
• 外键匹配： 无论是 join 还是 whereHas，都依赖于正确的外键关系。请确保您的数据库表和 Eloquent 模型中的外键定义是准确无误的。
• 输入验证： 在实际应用中，始终对用户输入进行验证（例如，使用 Laravel 的表单请求验证），以防止恶意数据或不符合预期的数据影响查询。

通过掌握 join 和 whereHas 这两种强大的 Eloquent 查询方法，您将能够灵活高效地处理 Laravel 中父子表数据的复杂筛选需求。