Laravel Eloquent 多层级关联查询与数据筛选实践-php教程-PHP中文网

Laravel Eloquent 多层级关联查询与数据筛选实践

DDD

发布： 2025-10-09 13:35:01

原创

959人浏览过

laravel eloquent 多层级关联查询与数据筛选实践

本教程详细介绍了如何在 Laravel Eloquent 中处理多层级模型关联，特别是当需要通过中间模型查询并筛选深层关联数据时。我们将通过一个具体的案例，演示如何利用 belongsToMany 关系和局部作用域（scope）来高效地从 Sponsor 模型查询关联的 Participant 数据，并根据创建日期进行筛选，从而简化复杂的数据库查询逻辑。

场景描述与模型结构

在一个典型的业务场景中，我们可能有以下三个模型及其关联关系：

Sponsor（赞助商）: 拥有多个 Optin（选择加入记录）。
Optin（选择加入记录）: 属于一个 Sponsor，并且属于一个 Participant。
Participant（参与者）: 可以有多个 Optin。

初始的模型定义如下：

Sponsor 模型

<?php

namespace App\Models;

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

class Sponsor extends Model
{
    /**
     * 获取与赞助商关联的所有选择加入记录。
     */
    public function optins(): HasMany
    {
        return $this->hasMany(Optin::class);
    }
}

登录后复制

Optin 模型

<?php

namespace App\Models;

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

class Optin extends Model
{
    /**
     * 获取此选择加入记录所属的赞助商。
     */
    public function sponsor(): BelongsTo
    {
        return $this->belongsTo(Sponsor::class);
    }

    /**
     * 获取此选择加入记录所属的参与者。
     */
    public function participant(): BelongsTo
    {
        return $this->belongsTo(Participant::class);
    }
}

登录后复制

Participant 模型

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\HasMany;
use Illuminate\Database\Eloquent\Builder;
use Carbon\Carbon;

class Participant extends Model
{
    /**
     * 获取此参与者创建的所有选择加入记录。
     */
    public function optins(): HasMany
    {
        return $this->hasMany(Optin::class);
    }

    /**
     * 局部作用域，用于筛选今天创建的参与者。
     */
    public function scopeCreatedToday(Builder $query): Builder
    {
        return $query->whereDate('created_at', Carbon::today());
    }
}

登录后复制

我们的目标是，在一个每日定时任务中，获取所有今天创建的、并且通过特定 Sponsor 选择加入的 Participant，以便进行后续操作（例如发送邮件）。

挑战与解决方案

最初的思路可能是通过 Sponsor 逐级获取 Optin，再获取 Participant，但这会导致复杂的循环和低效的数据库查询：

$sponsor = Sponsor::find(1);
// 这种方式需要多次数据库查询，且难以直接应用筛选条件
$optins = $sponsor->optins()->get();
foreach($optins as $optin) {
    // 假设 $optin->participant_id 存在，但获取完整的 Participant 对象需要额外查询
    // 并且无法直接筛选 created_at
    echo($optin->participant_id . "\n");
}

登录后复制

为了更高效、更优雅地解决这个问题，我们可以利用 Eloquent 的 belongsToMany 关系，将 Sponsor 和 Participant 之间的多对多关系明确化，并指定 Optin 作为中间表。

蓝心千询

蓝心千询是vivo推出的一个多功能AI智能助手

查看详情

1. 定义 Sponsor 到 Participant 的多对多关系

在 Sponsor 模型中，添加一个 participants 关系，明确它通过 Optin 模型与 Participant 关联。

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\HasMany;
use Illuminate\Database\Eloquent\Relations\BelongsToMany; // 引入 BelongsToMany

class Sponsor extends Model
{
    /**
     * 获取与赞助商关联的所有选择加入记录。
     */
    public function optins(): HasMany
    {
        return $this->hasMany(Optin::class);
    }

    /**
     * 获取通过 Optin 模型与赞助商关联的所有参与者。
     *
     * @return BelongsToMany
     */
    public function participants(): BelongsToMany
    {
        // 第一个参数是目标模型，第二个参数是中间模型（作为枢纽表）
        return $this->belongsToMany(Participant::class, Optin::class);
    }
}

登录后复制

解释：belongsToMany(Participant::class, Optin::class) 表示 Sponsor 与 Participant 之间存在多对多关系，而 Optin 模型充当了连接这两个模型的“枢纽”或中间表。Eloquent 会自动查找 optins 表中的 sponsor_id 和 participant_id 字段来建立连接。

2. 利用局部作用域进行筛选

Participant 模型中已经定义了 scopeCreatedToday 局部作用域，用于筛选今天创建的参与者。

// Participant 模型中已存在
public function scopeCreatedToday(Builder $query): Builder
{
    return $query->whereDate('created_at', Carbon::today());
}

登录后复制

3. 执行高效查询

现在，我们可以通过 Sponsor 模型直接查询其关联的 Participant，并应用 createdToday 作用域：

<?php

use App\Models\Sponsor;
use App\Models\Participant;
use Carbon\Carbon;

// 假设我们正在处理 ID 为 1 的赞助商
$sponsor = Sponsor::find(1);

if ($sponsor) {
    // 通过 belongsToMany 关系链式调用 scopeCreatedToday
    $participants = $sponsor->participants()->createdToday()->get();

    echo "Sponsor ID {$sponsor->id} 的今天创建的参与者:\n";
    foreach ($participants as $participant) {
        // 对每个符合条件的参与者执行操作，例如发送邮件
        echo " - Participant ID: {$participant->id}, Name: {$participant->name ?? 'N/A'}\n";
        // 例如: Mail::to($participant->email)->send(new SponsorWelcomeEmail($sponsor));
    }
} else {
    echo "Sponsor with ID 1 not found.\n";
}

登录后复制

代码解释：

Sponsor::find(1)：获取特定的 Sponsor 实例。
$sponsor-youjiankuohaophpcnparticipants()：访问 Sponsor 模型上定义的 participants 多对多关系，这会返回一个 BelongsToMany 查询构建器实例。
->createdToday()：在查询构建器上直接调用 Participant 模型中定义的 createdToday 局部作用域。Eloquent 会自动将这个筛选条件应用到 Participant 表。
->get()：执行查询并获取所有符合条件的 Participant 模型集合。

这种方法将复杂的跨模型筛选逻辑封装在 Eloquent 关系和局部作用域中，使得查询代码更加简洁、可读性更强，并且能够利用 Eloquent 内部的优化机制，通常只执行一次高效的数据库查询。

注意事项与总结

关系命名: 确保 belongsToMany 关系的命名清晰，例如 participants 明确表示它返回 Participant 集合。
中间模型: belongsToMany 的第二个参数是中间模型的类名，而不是中间表的表名。Eloquent 会根据模型类名自动推断表名（例如 Optin -> optins）。
外键约定: 确保 optins 表包含 sponsor_id 和 participant_id 字段，它们分别作为 sponsors 表和 participants 表的外键。
可读性与维护性: 这种方法极大地提高了代码的可读性和可维护性。将筛选逻辑封装在局部作用域中，可以重复利用，避免代码重复。

通过上述实践，我们成功地利用 Laravel Eloquent 的强大功能，优雅地解决了多层级关联数据查询和筛选的问题，显著提升了开发效率和代码质量。

以上就是Laravel Eloquent 多层级关联查询与数据筛选实践的详细内容，更多请关注php中文网其它相关文章！