如何使用Mongoose更新MongoDB子文档且不覆盖现有字段？

问题背景 #

我有一个Organization Schema，其中包含AddressSchema定义的address子文档。使用findByIdAndUpdate更新address的单个字段时，整个address子文档会被仅含更新字段的内容替换，导致原有其他字段丢失。我需要只更新变更的字段，保留子文档其余内容。

相关Schema代码 #

Address Schema

export const AddressSchema = new Schema<IAddress, AddressModel>({
    city: {
        type: String,
        required: true,
    },
    woreda: {
        type: String,
    },
    subcity: {
        type: String,
        required: true,
    },
    telephoneNum: {
        type: String,
        required: true,
    },
    createdAt: {
        type: Date,
        default: Date.now,
    },
    updatedAt: {
        type: Date,
        default: Date.now,
    }
})

Organization Schema

const OrganizationSchema = new Schema<IOrganization, OrganizationModel>({
    ...
    address: AddressSchema,
    ...
});

当前更新函数 #

async function updateOrg(id: mongoose.Types.ObjectId, update: UpdateOrgBody): Promise<IOrganizationDoc> {
    try {
        const org = await Organization.findByIdAndUpdate(id, update, { new: true });
        if (!org) throw new Error("Organization not found");
        return org;
    } catch (error) {
        throw new Error(error.message);
    }
}

问题示例 #

更新前的文档：

{
    ...
    "_id": "60e81294f08bb856127a47a7",
    "address": {
        "city": "New York",
        "woreda": "123",
        "subcity": "Manhattan",
        "telephoneNum": "555-1234",
        "createdAt": "2022-04-14T10:00:00.000Z",
        "updatedAt": "2022-04-14T10:00:00.000Z"
    },
    ...
}

执行更新：

const update = { address: { city: 'Chicago' } };
await updateOrg('60e81294f08bb856127a47a7', update);

更新后address子文档被整体替换，丢失其他字段：

{
    ...
    "_id": "60e81294f08bb856127a47a7",
    "address": {
        "city": "Chicago",
        "updatedAt": "2022-04-14T11:00:00.000Z"
    },
    ...
}

解决方案 #

方法1：使用MongoDB点语法构造更新对象 #

MongoDB支持通过点路径指定子文档的单个字段进行更新，这样不会覆盖整个子文档。

修改更新调用的参数：

// 不再传递嵌套的address对象，而是用点语法指定字段
const update = { "address.city": 'Chicago', "address.updatedAt": new Date() };
await updateOrg('60e81294f08bb856127a47a7', update);

方法2：自动转换更新参数为点语法（封装更新函数） #

如果不想每次手动写点语法，可以在updateOrg函数里自动处理嵌套的address参数，转换成点路径格式：

async function updateOrg(id: mongoose.Types.ObjectId, update: UpdateOrgBody): Promise<IOrganizationDoc> {
    try {
        const processedUpdate: Record<string, any> = {};
        // 处理address子文档的更新
        if (update.address) {
            for (const [key, value] of Object.entries(update.address)) {
                processedUpdate[`address.${key}`] = value;
            }
            // 删除原有的address嵌套对象
            delete update.address;
        }
        // 合并其他更新字段
        Object.assign(processedUpdate, update);
        // 自动更新address的updatedAt
        processedUpdate["address.updatedAt"] = new Date();

        const org = await Organization.findByIdAndUpdate(id, processedUpdate, { new: true });
        if (!org) throw new Error("Organization not found");
        return org;
    } catch (error) {
        throw new Error(error.message);
    }
}

这样调用时依然可以用原来的嵌套格式：

const update = { address: { city: 'Chicago' } };
await updateOrg('60e81294f08bb856127a47a7', update);

方法3：启用Mongoose的时间戳自动更新 #

可以在Schema里启用timestamps选项，让Mongoose自动维护createdAt和updatedAt，不需要手动设置：

修改AddressSchema：

export const AddressSchema = new Schema<IAddress, AddressModel>({
    city: {
        type: String,
        required: true,
    },
    woreda: {
        type: String,
    },
    subcity: {
        type: String,
        required: true,
    },
    telephoneNum: {
        type: String,
        required: true,
    }
}, { timestamps: true }); // 启用自动时间戳

这样更新子文档时，Mongoose会自动更新address.updatedAt，无需手动设置。

验证效果 #

使用上述方法更新后，文档会保留address的其他字段，仅更新指定字段：

{
    ...
    "_id": "60e81294f08bb856127a47a7",
    "address": {
        "city": "Chicago",
        "woreda": "123",
        "subcity": "Manhattan",
        "telephoneNum": "555-1234",
        "createdAt": "2022-04-14T10:00:00.000Z",
        "updatedAt": "2022-04-14T11:00:00.000Z"
    },
    ...
}

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