如何在Laravel的Pivot模型中添加无数据库字段的附加属性？

问题背景 #

我想给Laravel模型添加一些仅在运行时计算、无对应数据库字段的附加属性，普通模型可以通过Accessor方法（get...Attribute()）搭配$appends数组实现，但在数据透视表（Pivot）模型里这么做却不生效。明明Pivot模型继承自Illuminate\Database\Eloquent\Model，还引入了AsPivot trait，为什么这种方法行不通？能不能给Pivot模型加无数据库字段的额外属性？求实现思路。

示例代码 #

Car模型代码 #

<?php

declare(strict_types=1);

namespace App\Models;

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

/**
 * @property int $id
 * @property-read Collection<Tyres> $tyres
 */
class Car extends Model
{
    /**
     * m:n relation to Tyres
     */
    public function tyres(): BelongsToMany
    {
        return $this->belongsToMany(Tyres::class);
    }
}

自定义Pivot模型（CarTyres）代码 #

<?php

declare(strict_types=1);

namespace App\Models;

use Illuminate\Database\Eloquent\Relations\Pivot;
use Illuminate\Support\Carbon;

/**
 * @property-read int $car_id
 * @property-read int $tyre_id
 * @property-read Carbon $created_at
 * @property-read Carbon $updated_at
 */
class CarTyres extends Pivot
{
    protected $appends = ['test'];

    public function getTestAttribute(): string
    {
        return 'testing value';
    }
}

解决方法 #

问题核心在于你没有在多对多关联中指定自定义的Pivot模型，Laravel默认会使用内置的Pivot实例，根本不会加载你写的CarTyres类，所以你的Accessor和$appends配置完全没起作用。

步骤1：在关联中指定自定义Pivot模型 #

修改Car模型的tyres()关联方法，通过using()方法绑定你的自定义Pivot类：

public function tyres(): BelongsToMany
{
    return $this->belongsToMany(Tyres::class)->using(CarTyres::class);
}

步骤2：验证效果 #

当你获取关联数据时，就能正常访问到附加属性了：

$car = Car::with('tyres')->first();
// 直接访问pivot的test属性
echo $car->tyres->first()->pivot->test;
// 序列化后查看所有属性
dd($car->tyres->first()->pivot->toArray());

此时test属性会和其他pivot字段一起显示。

额外说明 #

Pivot模型确实是Eloquent模型的子类，但Laravel处理多对多关联时，默认不会自动识别自定义Pivot类，必须显式声明。如果后续需要给Pivot模型添加更多逻辑（比如额外关联、业务方法），都要确保先在关联中通过using()指定该模型。

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