如何在 Laravel Eloquent 中为多对多关联按父模型限制预加载数据

本教程详细介绍了在 laravel eloquent 中如何解决多对多关系中按父模型（例如，每个分类获取指定数量的产品）限制预加载数据的问题。由于 laravel 默认的 `limit()` 方法会将限制应用于整体查询而非每个父模型实例，我们将引入 `staudenmeir/eloquent-eager-limit` 扩展包，并通过具体步骤、代码示例以及重要的数据库兼容性配置，指导开发者实现这一高级预加载需求。

在 Laravel 应用开发中，我们经常会遇到需要处理多对多关联关系的场景，例如一个商品可以属于多个分类，一个分类下也可以包含多个商品。当我们需要预加载这些关联数据时，有时会要求为每个父模型实例（如每个分类）只获取其关联子模型（如商品）中的一部分数据，例如每个分类只显示最新的10个商品。

然而，Laravel Eloquent 默认的 limit() 方法在定义关联关系时，如果直接应用于 belongsToMany 关联，它会将限制条件作用于整个查询结果集，而不是针对每个父模型实例。这意味着，如果在一个 Category 模型中定义 products() 关联并加上 limit(10)，当你查询所有分类并预加载商品时，你不会得到每个分类下的10个商品，而是所有分类关联商品的总数被限制为10个，这通常不是我们期望的行为。

为了解决这一问题，社区提供了一个强大的扩展包 staudenmeir/eloquent-eager-limit，它允许我们在预加载多对多关系时，对每个父模型实例的关联数据应用独立的限制。

实现步骤

1. 安装 eloquent-eager-limit 扩展包

首先，通过 Composer 将 staudenmeir/eloquent-eager-limit 扩展包安装到你的 Laravel 项目中。

composer require staudenmeir/eloquent-eager-limit

2. 在模型中应用 Trait

安装完成后，你需要在涉及多对多关联的父模型和子模型中都使用 HasEagerLimit Trait。

Category 模型 (app/Models/Category.php):

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsToMany;
use Staudenmeir\EloquentEagerLimit\HasEagerLimit; // 引入 Trait

class Category extends Model
{
    use HasEagerLimit; // 使用 Trait

    /**
     * 获取与分类关联的商品。
     */
    public function groceryProducts(): BelongsToMany
    {
        // 注意：在这里不添加 limit() 方法
        return $this->belongsToMany(Product::class, 'category_product');
    }
}

Product 模型 (app/Models/Product.php):

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Staudenmeir\EloquentEagerLimit\HasEagerLimit; // 引入 Trait

class Product extends Model
{
    use HasEagerLimit; // 使用 Trait

    // ... 其他模型定义
}

3. 定义关联关系（不带 limit()）

在父模型（例如 Category）中定义 BelongsToMany 关联时，不要在关联方法内部直接使用 limit() 或 take()。这些限制条件将在后续的预加载查询中动态应用。

绘蛙AI修图

绘蛙平台AI修图工具，支持手脚修复、商品重绘、AI扩图、AI换色

279

查看详情

// Category 模型中的关联方法
public function groceryProducts(): BelongsToMany
{
    return $this->belongsToMany(Product::class, 'category_product');
}

4. 在控制器中限制关联数据

现在，你可以在控制器或任何需要查询数据的地方，使用 with() 方法结合闭包函数来为每个分类限制关联商品的数量。

<?php

namespace App\Http\Controllers;

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

class CategoryController extends Controller
{
    /**
     * 获取每个分类下最新的5个商品。
     */
    public function index()
    {
        $categoriesWithLimitedProducts = Category::with(['groceryProducts' => function ($query) {
            $query->latest()->limit(5); // 为每个分类获取最新的5个商品
        }])->get();

        // 现在 $categoriesWithLimitedProducts 集合中的每个 Category 模型实例
        // 都将只包含其最新的5个关联 Product 模型实例。

        return view('categories.index', compact('categoriesWithLimitedProducts'));
    }
}

在上述示例中，$query->latest()->limit(5) 会被 eloquent-eager-limit 扩展包智能地应用于每个 Category 实例的关联查询，从而实现按父模型限制关联数据的需求。

5. 数据库兼容性配置

对于使用 MySQL 或 MariaDB 数据库的用户，为了确保 eloquent-eager-limit 扩展包的正常工作，你可能需要调整数据库连接的 strict 模式设置。

在 config/database.php 文件中，找到你的 MySQL 或 MariaDB 连接配置，并将 'strict' 选项设置为 false：

        'mysql' => [
            // ... 其他配置
            'strict' => false, // 将 strict 模式设置为 false
            // ...
        ],

重要提示： 修改 config/database.php 文件后，请务必重启你的开发服务器（例如，如果你使用 php artisan serve，则需要停止并重新启动），以使配置更改生效。

注意事项

• 默认 limit() 行为： 再次强调，Laravel Eloquent 默认的 limit() 方法在 BelongsToMany 关联定义中，会将限制应用于整个关联查询，而不是每个父模型。这是导致需要额外扩展包的根本原因。
• 性能考量： 尽管 eloquent-eager-limit 扩展包提供了强大的功能，但在处理海量数据时，仍需关注其对数据库查询性能的影响。该扩展包通常通过子查询或单独的查询来获取限制数据，这可能比简单的 with() 查询更复杂。
• 其他关联类型： eloquent-eager-limit 扩展包也支持 HasMany 和 MorphMany 等关联类型按父模型限制预加载数据。

总结

通过 staudenmeir/eloquent-eager-limit 扩展包，我们可以优雅地解决 Laravel Eloquent 在多对多关联中按父模型限制预加载数据的挑战。遵循上述步骤，包括安装扩展包、在模型中应用 Trait、正确定义关联关系以及在查询时应用限制条件，并注意数据库兼容性配置，你将能够灵活地控制预加载关联数据的数量，从而满足更复杂的业务需求。

以上就是如何在 Laravel Eloquent 中为多对多关联按父模型限制预加载数据的详细内容，更多请关注php中文网其它相关文章！