如何使用Mongoose填充MongoDB中Chat集合messages数组的sender字段

背景代码 #

Chat Schema：

const ChatSchema = new mongoose.Schema({
    users: [
        {
            type: mongoose.Schema.Types.ObjectId,
            ref: 'user'
        }
    ],
    messages: [
        {
            sender: {
                type: mongoose.Schema.Types.ObjectId,
                ref: 'user'
            },
            text: {
                type: String,
                trim: true
            }
        }
    ]
},
    {
        timestamps: true
    }
)

module.exports = Chat = mongoose.model('chat', ChatSchema)

User Schema：

const UserSchema = new mongoose.Schema({
    name: {
        type: String,
        required: true
    },
    email: {
        type: String,
        required: true,
        unique: true
    },
    password: {
        type: String,
        required: true
    }
},
    {
        timestamps: true
    }
)

module.exports = User = mongoose.model('user', UserSchema)

解决方案 #

通过mongoose的populate()方法精准指定嵌套填充路径，即可实现只填充messages数组内的sender引用，同时保留顶层users字段为原始ObjectId数组。

基础用法

直接在查询时指定messages.sender作为populate的路径：

// 回调函数写法
Chat.findById(你的聊天ID)
  .populate('messages.sender')
  .exec((err, chat) => {
    if (err) {
      console.error(err);
      return;
    }
    // chat.messages中每个元素的sender已被填充为完整User文档
    // chat.users仍为ObjectId数组，未被填充
    console.log(chat);
  });

// async/await写法（更推荐）
async function getChatWithSenders(chatId) {
  try {
    const chat = await Chat.findById(chatId).populate('messages.sender');
    return chat;
  } catch (err) {
    console.error(err);
    throw err;
  }
}

自定义返回字段（可选）

如果不想返回User文档中的敏感字段（比如password），可以通过select参数控制返回字段：

await Chat.findById(chatId).populate({
  path: 'messages.sender',
  select: 'name email createdAt' // 只返回指定字段，默认排除password
});

原理说明 #

populate('messages.sender')中的路径是mongoose的嵌套字段语法，精准指向了Chat文档中messages数组内每个元素的sender字段。mongoose只会对这个指定路径的引用进行填充，顶层的users字段因为未被包含在populate参数中，所以保持原始的ObjectId数组状态。

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