如何在Laravel模型retrieved事件中判断关联是否已预加载？

问题回顾 #

我们的Post模型使用HasComments Trait，该Trait会在模型retrieved事件触发时自动加载comments关联，但无法判断关联是否已预加载，导致重复加载；同时尝试添加开关控制自动加载的方案也失败。

原因分析 #

1. 关联判断失效：原代码中判断逻辑本身没问题，但可能存在预加载名称不匹配、查询后有代码修改relations属性的情况；另外需注意，Laravel预加载是在模型实例化后、retrieved事件触发前完成的，正常情况下relationLoaded()可以正确识别。
2. 开关控制失败：原方案中闭包内使用$this->load是错误的——bootHasComment是静态方法，闭包中的$this不指向模型实例，且实例属性无法在查询前提前设置。

可行解决方案 #

方案1：正确判断关联是否已加载 #

确保使用relationLoaded()方法正确判断，同时检查预加载关联名称与Trait中定义的一致性：

trait HasComments
{
    public static function bootHasComments(): void
    {
        self::retrieved(function ($model) {
            // 仅当关联未加载时才执行加载
            if (!$model->relationLoaded('comments')) {
                $model->load('comments');
            }
        });
    }

    public function comments(): BelongsTo
    {
        return $this->belongsTo(Comment::class);
    }
}

若仍失效，需排查：

• 预加载时使用的关联名称是否为comments
• 是否有其他代码在retrieved事件前修改了模型的relations属性

方案2：静态开关控制自动加载 #

改用静态属性作为开关，在查询前调用静态方法禁用自动加载：

trait HasComments
{
    protected static bool $autoLoadComments = true;

    public static function bootHasComments(): void
    {
        self::retrieved(function ($model) {
            if (static::$autoLoadComments && !$model->relationLoaded('comments')) {
                $model->load('comments');
            }
            // 重置开关，避免影响后续查询
            static::$autoLoadComments = true;
        });
    }

    public function comments(): BelongsTo
    {
        return $this->belongsTo(Comment::class);
    }

    // 静态方法：禁用自动加载
    public static function disableAutoLoadComments(): void
    {
        static::$autoLoadComments = false;
    }
}

使用示例：

// 查询前禁用自动加载
Post::disableAutoLoadComments();
$posts = Post::with('comments')->get();

方案3：查询作用域控制 #

通过查询作用域标记是否需要自动加载：

trait HasComments
{
    public static function bootHasComments(): void
    {
        self::retrieved(function ($model) {
            // 检查查询构建器的标记，决定是否加载
            if (!isset($model->getQuery()->withoutAutoLoadComments) && !$model->relationLoaded('comments')) {
                $model->load('comments');
            }
        });
    }

    public function comments(): BelongsTo
    {
        return $this->belongsTo(Comment::class);
    }

    // 查询作用域：标记无需自动加载
    public function scopeWithoutAutoLoadComments($query)
    {
        $query->withoutAutoLoadComments = true;
        return $query;
    }
}

使用示例：

// 查询时添加作用域，禁用自动加载
$posts = Post::with('comments')->withoutAutoLoadComments()->get();

额外注意事项 #

• 统一Trait名称：模型中使用的是HasComments，Trait定义也应保持同名，避免类找不到的错误
• 闭包中必须使用$model实例访问属性，不能用$this（静态方法中$this不指向模型实例）

内容的提问来源于stack exchange，提问作者Vlad