Eloquent多对多关联同步：保留现有pivot值并设置默认值

问题 #

在Laravel Eloquent多对多关联场景中，需要同步Item关联的User（新增/移除关联），同时满足两个核心需求：

1. 新增的关联条目需为中间表field字段设置基于当前Item的默认值
2. 已存在的关联条目保留原有的field值

现有模型代码：

<?php

class Item {
    protected $attributes = [
        'default_field' => false,
    ];

    public function users(): BelongsToMany
    {
        return $this->belongsToMany(User::class)->withPivot('field');
    }
}

class User {
    // ...
}

遇到的问题：

• 使用$item->users()->sync([1,2,3])时，新增条目的field字段不会自动填充默认值
• 使用$item->users()->syncWithPivotValues([1,2,3], ['field' => $item->default_field])时，会覆盖已有关联的field原有值

示例场景：
同步前中间表数据：

执行同步代码：

<?php
$item->users()->sync([2,3]);

预期结果：
移除user_id=1的关联，新增user_id=3的关联并设置field为Item的默认值false，保留user_id=2的原field值：

解决方案 #

方法一：手动构建带条件的同步数组 #

先获取当前已关联用户的field值，再与目标同步ID合并，对新增用户设置默认值，已有用户保留原值：

<?php
// 获取当前已关联用户的user_id与对应field值
$existingPivots = $item->users()->pluck('field', 'user_id')->toArray();

// 目标同步的用户ID列表
$targetUserIds = [2, 3];

// 构建同步数组
$syncData = [];
foreach ($targetUserIds as $userId) {
    $syncData[$userId] = [
        'field' => $existingPivots[$userId] ?? $item->default_field
    ];
}

// 执行同步
$item->users()->sync($syncData);

方法二：使用sync的回调函数 #

利用Laravelsync方法的回调特性，仅对新增的关联条目设置默认值，已存在条目不修改：

<?php
$item->users()->sync([2, 3], function ($existingPivot, $isNew) use ($item) {
    // 仅新增条目设置默认值，已有条目返回空数组不修改字段
    return $isNew ? ['field' => $item->default_field] : [];
});

方法三：封装自定义同步方法 #

在Item模型中封装专属同步方法，简化日常调用：

<?php
class Item {
    protected $attributes = [
        'default_field' => false,
    ];

    public function users(): BelongsToMany
    {
        return $this->belongsToMany(User::class)->withPivot('field');
    }

    /**
     * 同步用户并保留已有pivot值，新增条目用默认值
     */
    public function syncUsersWithDefault(array $userIds)
    {
        $existingPivots = $this->users()->pluck('field', 'user_id')->toArray();
        $syncData = [];
        
        foreach ($userIds as $userId) {
            $syncData[$userId] = ['field' => $existingPivots[$userId] ?? $this->default_field];
        }
        
        return $this->users()->sync($syncData);
    }
}

// 调用示例
$item->syncUsersWithDefault([2, 3]);

方法四：数据库层面设置默认值（全局场景） #

若所有Item的field默认值统一，可直接给中间表字段设置数据库默认值，新增关联时自动填充：

ALTER TABLE item_user MODIFY COLUMN field BOOLEAN DEFAULT FALSE;

注：此方法仅适用于全局默认值场景，不同Item需不同默认值时不适用。

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