Laravel 9中如何从API资源访问Pivot表字段

我正在使用Laravel Resource构建API，存在如下关联关系：Product（如巧克力蛋糕）与Property（如过敏原）为多对多关联，Property关联PropertiesProperty（如麸质），且每个Product的PropertiesProperty需按不同顺序展示。

数据库表结构 #

products:
id
name

product_property (第一个中间表)
product_id
property_id

properties:
id
name 

properties_properties
id
name

product_properties_property (带position字段的中间表) 
product_id
properties_property_id
position

期望API输出 #

访问/product接口期望返回JSON格式如下：

{
    "product": [{
        "product_id": 1,
        "name": "Choco Cake",
        "properties": [{
            "property_id": 1,
            "name": "Allergies",
            "properties_properties": [{
                "properties_property_id": 1,
                "name": "Gluten",
                "position": 1
            }]
        }]
    }]
}

现有代码 #

1. PropertiesProperty模型中已定义与Product的多对多关联并指定withPivot('position')：

public function products () {
  return $this->belongsToMany(Product::class)->withPivot('position');
}

2. 路由中返回所有Product的集合：

Route::get('/product', function () {
    return new ProductCollection(Product::all());
});

我已创建ProductResource、PropertyResource和PropertiesPropertyResource，资源间相互关联。现在需要在PropertiesPropertyResource中访问product_properties_property中间表的position字段，尝试过直接调用$this->products->pivot->position报错“Property[pivot] does not exist on this collection”，用查询过滤的方法会产生额外加载，尝试whenPivotLoaded方法后position字段未显示。请问有没有更符合Laravel风格的高效实现方式？

1. 预加载关联并携带position字段（推荐） #

在路由查询时，通过预加载+关联查询的方式，把position字段直接注入到PropertiesProperty模型中，同时按position排序：

Route::get('/product', function () {
    $products = Product::with(['properties', 'properties.propertiesProperties' => function ($query) {
        $query->join('product_properties_property', 'properties_properties.id', '=', 'product_properties_property.properties_property_id')
              ->whereColumn('product_properties_property.product_id', 'products.id')
              ->select('properties_properties.*', 'product_properties_property.position')
              ->orderBy('product_properties_property.position');
    }])->get();

    return new ProductCollection($products);
});

然后在PropertiesPropertyResource中直接访问position字段即可：

// PropertiesPropertyResource.php
public function toArray($request)
{
    return [
        'properties_property_id' => $this->id,
        'name' => $this->name,
        'position' => $this->position,
    ];
}

2. 自定义关联实现按需加载 #

如果觉得join写法繁琐，可以在Property模型中定义一个针对特定Product的关联方法：

// Property.php
public function propertiesPropertiesForProduct($productId)
{
    return $this->hasMany(PropertiesProperty::class)
                ->join('product_properties_property', 'properties_properties.id', '=', 'product_properties_property.properties_property_id')
                ->where('product_properties_property.product_id', $productId)
                ->select('properties_properties.*', 'product_properties_property.position')
                ->orderBy('position');
}

接着在ProductResource中，为每个Property手动设置关联数据：

// ProductResource.php
public function toArray($request)
{
    return [
        'product_id' => $this->id,
        'name' => $this->name,
        'properties' => PropertyResource::collection(
            $this->properties->map(function ($property) {
                $property->setRelation('propertiesProperties', $property->propertiesPropertiesForProduct($this->id));
                return $property;
            })
        ),
    ];
}

问题根源说明 #

之前报错是因为$this->products是集合实例，而pivot属性只存在于单个关联模型实例中，不能直接通过集合访问。通过上述方法，我们要么把position字段直接查询到模型属性中，要么按需加载对应Product的关联数据，既避免N+1查询，又符合Laravel的关联设计逻辑。

内容的提问来源于stack exchange，提问作者St. Jan