Laravel更新模型时如何简洁同步其一对多关联子项数据

Laravel 的 hasMany 关联确实没有内置类似多对多的 sync 方法，但可以结合集合操作和 upsert 语法大幅简化代码，还可以封装为通用方法复用在所有同类场景下：

最简优化写法 #

不需要双重循环遍历比对，直接用查询构造器和内置方法完成逻辑：

public function update(User $user, Request $request)
{
    $validated = $request->validate([
        'userAttribute1' => 'required|string',
        'userAttribute2' => 'required|string',
        'items' => 'required|array',
        'items.*.name' => 'required|string',
        // 有其他字段补充验证规则即可
    ]);

    // 更新用户主属性
    $user->update($validated);

    // 提取新提交的items的唯一匹配字段集合
    $newItemNames = collect($validated['items'])->pluck('name');
    // 直接删除请求中不存在的旧关联项
    $user->items()->whereNotIn('name', $newItemNames)->delete();

    // 格式化待插入数据，用upsert跳过已存在的匹配项
    $insertData = collect($validated['items'])->map(fn($item) => [
        'userId' => $user->id,
        'name' => $item['name'],
        // 其他字段直接在这里补充赋值
    ])->toArray();
    // upsert第二参数为唯一匹配键，第三参数为空表示匹配到就不更新，符合跳过现有项的要求
    Item::upsert($insertData, ['userId', 'name'], []);

    // 刷新关联保证返回数据为最新
    $user->load('items');

    return [
        "user" => new UserResource($user),
    ];
}

通用复用封装 #

如果有多个同类关联场景，可以把同步逻辑封装为Trait，所有模型都可以直接调用：

1. 先创建同步Trait

<?php

namespace App\Traits;

trait SyncsHasMany
{
    /**
     * 同步hasMany关联数据
     * @param string $relation 关联方法名
     * @param array $newItems 新提交的关联项数组
     * @param string|array $uniqueKey 关联项的唯一匹配键
     * @param array $updateFields 匹配到旧项时需要更新的字段，为空则跳过不更新
     */
    public function syncHasMany(string $relation, array $newItems, string|array $uniqueKey, array $updateFields = [])
    {
        $relationQuery = $this->$relation();
        $relatedModel = $relationQuery->getRelated();
        $foreignKey = $relationQuery->getForeignKeyName();
        $uniqueKeys = (array)$uniqueKey;

        // 给所有新项补充外键值
        $formattedItems = collect($newItems)->map(fn($item) => array_merge($item, [
            $foreignKey => $this->id
        ]))->toArray();

        // 删除不在新提交列表里的旧关联项
        $newItemUniqueValues = collect($formattedItems)->pluck($uniqueKeys);
        $relationQuery->whereNot(function ($query) use ($uniqueKeys, $newItemUniqueValues) {
            foreach ($newItemUniqueValues as $values) {
                $query->orWhere(fn($q) => collect($uniqueKeys)
                    ->combine((array)$values)
                    ->each(fn($val, $key) => $q->where($key, $val))
                );
            }
        })->delete();

        // 执行upsert，跳过或更新已有项
        $relatedModel::upsert(
            $formattedItems,
            array_merge([$foreignKey], $uniqueKeys),
            $updateFields
        );

        // 刷新关联
        $this->load($relation);
    }
}

2. 在需要用的模型里引入Trait

class User extends Model
{
    use \App\Traits\SyncsHasMany;

    public function items()
    {
        return $this->hasMany(Item::class, "userId");
    }
}

3. 控制器调用仅需一行代码

public function update(User $user, Request $request)
{
    $validated = $request->validate([
        'userAttribute1' => 'required|string',
        'userAttribute2' => 'required|string',
        'items' => 'required|array',
        'items.*.name' => 'required|string',
    ]);

    $user->update($validated);
    // 直接调用同步方法，无需重复写逻辑
    $user->syncHasMany('items', $validated['items'], 'name');

    return [
        "user" => new UserResource($user),
    ];
}

注意事项 #

需要给关联表创建对应唯一索引保证upsert匹配正确，以Item表为例需要添加联合唯一索引：

// 迁移文件中添加
Schema::table('items', function (Blueprint $table) {
    $table->unique(['userId', 'name']);
});

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