Mongoose移除文档及数组元素中deletedAt字段的问题

问题背景 #

现有Mongoose文档结构如下：

{
  _id: ...,
  deletedAt: null,
  history: [
   {
     _id: ...,
     name: ...,
     deletedAt: null
   },
   {
     _id: ...,
     name: ...,
     deletedAt: null
   },
  ]
}

需求是保存文档后，返回的结果中移除顶层deletedAt字段，同时移除history数组每个元素中的deletedAt字段。

当前尝试的post('save')中间件仅能移除顶层deletedAt，无法处理数组内的字段；且已在Schema中为history.deletedAt设置select: false，但查询时仍会返回该字段。

解决方案 #

1. 修复post('save')中间件，移除数组元素的deletedAt #

Mongoose的Document.set()方法不支持$[]这类数组通配符语法，因此需要手动遍历history数组，逐个删除元素中的deletedAt字段：

mySchema.post('save', function () {
  // 移除顶层deletedAt
  this.set('deletedAt', undefined);
  // 遍历history数组，删除每个元素的deletedAt
  if (this.history) {
    this.history.forEach(item => {
      delete item.deletedAt;
    });
  }
});

2. 解决select: false不生效的问题 #

select: false仅对数据库查询操作生效，内存中的文档实例不会自动移除该字段。要让查询或保存后的文档都符合规则，可通过以下两种方式处理：

方式一：在post中间件中使用toObject/toJSON转换

toObject()/toJSON()方法会遵循Schema的select配置，自动过滤掉标记为select: false的字段：

mySchema.post('save', function (doc, next) {
  // 转换为普通对象，自动应用select规则
  const cleanedDoc = doc.toObject({ versionKey: false });
  // 将清理后的内容覆盖原文档
  Object.assign(doc, cleanedDoc);
  next();
});

方式二：配置Schema的toJSON转换规则

在Schema中全局设置toJSON的transform函数，这样所有文档转JSON时都会自动移除指定字段：

mySchema.set('toJSON', {
  transform: function(doc, ret) {
    // 移除顶层deletedAt
    delete ret.deletedAt;
    // 移除history数组每个元素的deletedAt
    if (ret.history) {
      ret.history.forEach(item => delete item.deletedAt);
    }
    return ret;
  }
});

该方式同时适用于保存后返回的文档，以及查询后得到的文档。

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