Mongoose嵌入子schema属性无法随关联用户同步更新问题求助

问题本质 #

你当前使用的嵌入式子文档属于独立的数据快照，和User集合的数据没有关联，User集合的数据更新不会自动同步到Project的子文档中，这是MongoDB嵌入式文档的正常特性。以下是两种可落地的解决方案，优先推荐使用关联引用方案。

方案一：正确使用ObjectId关联引用（最优解） #

这种方案只在Project中存储用户的id，查询时自动关联最新的User数据，天然保证数据一致性，是此类场景的标准实现。

步骤1：修改Project Schema #

// 把原来的currentlyWorkingEmployees字段替换为以下内容
currentlyWorkingEmployees: [
  { type: mongoose.Schema.Types.ObjectId, ref: 'User', required: true }
]

步骤2：修改添加用户到项目的控制器逻辑 #

注意你原有代码中存在低级错误：查询项目不存在时的提示信息错误引用了userId，已修正。

const attachEmployeeToProject = async (req, res) => {
  const { projectId, userId } = req.params;

  const project = await Project.findOne({ _id: projectId });
  const user = await User.findOne({ _id: userId });

  if (!user) {
    throw new NotFoundError(`User with id ${userId} does not exists`);
  }

  if (!project) {
    throw new NotFoundError(`Project with id ${projectId} does not exists`);
  }

  // 避免重复添加同一个用户到项目
  if (project.currentlyWorkingEmployees.some(id => id.toString() === userId)) {
    throw new BadRequestError('该用户已加入当前项目');
  }

  // 仅存储用户id，用$push操作符比全量替换数组性能更高
  const updateProject = await Project.findOneAndUpdate(
    { _id: projectId },
    { $push: { currentlyWorkingEmployees: userId } },
    {
      new: true,
      runValidators: true,
    }
  ).populate('currentlyWorkingEmployees', 'email role status'); // 填充需要的用户字段，自动关联最新数据

  res.status(StatusCodes.OK).json({ updateProject });
};

步骤3：所有查询Project的接口统一添加populate逻辑 #

只要接口需要返回项目关联的用户属性，就需要调用populate方法关联查询User集合，示例：

// 查单个项目的示例
const getSingleProject = async (req, res) => {
  const project = await Project.findById(req.params.projectId)
    .populate('createdBy', 'username email') // 关联创建人信息
    .populate('currentlyWorkingEmployees', 'email role status firstname lastname status'); // 第二个参数指定要返回的用户字段，避免返回密码等敏感信息
  res.status(StatusCodes.OK).json({ project });
}

之前改引用后报错的常见原因 #

1. 旧数据不兼容：之前嵌入式模式存储的是完整用户对象，改为引用模式后旧数据的类型不符合Schema要求，清空测试数据或者写迁移脚本把旧数组中的用户id提取出来替换即可。
2. 未调用populate：查询时没有添加populate逻辑，拿到的只是用户id字符串，访问用户属性就会报错。
3. 存储逻辑未修改：仍然往数组中存入完整用户对象，不符合引用模式只存id的要求，触发类型校验报错。

方案二：保留嵌入式子文档，主动同步数据 #

如果业务场景必须使用嵌入式结构，可以在User模型中添加更新后置中间件，用户属性更新时主动同步所有关联的Project数据。

步骤1：优化SingleUserSchema，添加用户id用于匹配 #

const SingleUserSchema = new mongoose.Schema({
  userId: { type: mongoose.Schema.Types.ObjectId, ref: 'User', required: true }, // 新增用户id字段，用于精确匹配
  email: {
    type: String,
    required: true,
  },
  role: {
    type: String,
    required: true,
  },
  status: {
    type: String,
    required: true,
  },
});

步骤2：添加User更新的后置中间件 #

// 放在UserSchema导出之前
UserSchema.post('findOneAndUpdate', async function(doc) {
  const { _id: userId, email, role, status } = doc;
  // 批量更新所有包含该用户的Project的子文档数据
  await Project.updateMany(
    { 'currentlyWorkingEmployees.userId': userId },
    {
      $set: {
        'currentlyWorkingEmployees.$[elem].email': email,
        'currentlyWorkingEmployees.$[elem].role': role,
        'currentlyWorkingEmployees.$[elem].status': status
      }
    },
    { arrayFilters: [{ 'elem.userId': userId }] }
  )
})

这种方案的缺点是性能开销大，用户更新时需要扫描所有关联的Project，且如果有其他集合也嵌入了用户数据，需要同步维护多套更新逻辑，仅适合项目规模小、用户更新频率极低的场景。

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