Mongoose 中的 Populate 方法指南-JavaScript中文网-JavaScript教程资源分享门户

在 Node.js 后端开发中，Mongoose 是一个非常流行的 MongoDB 数据库 ODM（Object-Document Mapping）库。它提供了很多方便的 API，使开发者可以更加方便地对 MongoDB 进行 CRUD 操作。其中，Populate 方法是 Mongoose 中一个非常重要的功能，它可以帮助我们解决 MongoDB 中的关联查询问题。本文将详细介绍 Mongoose 中的 Populate 方法，包括使用方法、参数设置以及示例代码。

什么是 Populate 方法

在 MongoDB 中，我们可以通过嵌套文档的方式来实现关联查询，比如一个用户文档中嵌套了多个订单文档。但是，当我们需要查询用户信息以及其对应的订单信息时，就需要使用到 Populate 方法。Populate 方法可以帮助我们在查询用户信息的同时，将其对应的订单信息也一并查询出来。具体来说，Populate 方法可以将一个文档中的某个字段替换为其它集合中的文档，从而实现关联查询的功能。

如何使用 Populate 方法

在 Mongoose 中，使用 Populate 方法非常简单，只需要在查询时指定要替换的字段即可。比如，我们有两个集合，一个是用户集合，一个是订单集合，它们的结构如下：

// www.javascriptcn.com code example
// 用户集合
const UserSchema = new mongoose.Schema({
  name: String,
  age: Number,
  orders: [{ type: mongoose.Schema.Types.ObjectId, ref: 'Order' }]
})

// 订单集合
const OrderSchema = new mongoose.Schema({
  title: String,
  price: Number,
  user: { type: mongoose.Schema.Types.ObjectId, ref: 'User' }
})

其中，用户集合中的 orders 字段表示该用户对应的订单 ID 数组，订单集合中的 user 字段表示该订单对应的用户 ID。如果我们需要查询某个用户的信息以及其对应的订单信息，就可以使用 Populate 方法来实现。具体来说，我们可以使用以下代码：

// www.javascriptcn.com code example
User.findById(userId).populate('orders').exec((err, user) => {
  if (err) {
    // 处理错误
  } else {
    // 处理用户信息
    console.log(user.name)
    console.log(user.age)

    // 处理订单信息
    user.orders.forEach(order => {
      console.log(order.title)
      console.log(order.price)
    })
  }
})

在上面的代码中，我们通过 populate 方法指定要替换的字段为 orders，表示将用户集合中的 orders 字段替换为其对应的订单文档。接着，我们可以通过 exec 方法执行查询操作，并在回调函数中处理查询结果。

Populate 方法的参数设置

除了最基本的使用方法外，Populate 方法还支持一些参数设置，可以帮助我们更加灵活地进行关联查询。下面是一些常用的参数设置：

path

path 参数用于指定要替换的字段，它可以是一个字符串或一个对象。如果是一个字符串，表示要替换的字段名；如果是一个对象，可以指定要替换的字段名以及一些额外的选项。比如，我们可以使用以下代码来查询某个订单信息以及其对应的用户信息：

// www.javascriptcn.com code example
Order.findById(orderId).populate({ path: 'user' }).exec((err, order) => {
  if (err) {
    // 处理错误
  } else {
    // 处理订单信息
    console.log(order.title)
    console.log(order.price)

    // 处理用户信息
    console.log(order.user.name)
    console.log(order.user.age)
  }
})

在上面的代码中，我们通过 populate 方法指定要替换的字段为 user，表示将订单集合中的 user 字段替换为其对应的用户文档。由于 path 参数默认值为字段名，因此我们可以简写为 populate('user')。

select

select 参数用于指定要查询的字段，它可以是一个字符串或一个对象。如果是一个字符串，表示要查询的字段名，多个字段名之间用空格隔开；如果是一个对象，可以指定要查询的字段名以及一些额外的选项。比如，我们可以使用以下代码来查询某个用户信息以及其对应的订单信息，但只查询订单的标题和价格：

// www.javascriptcn.com code example
User.findById(userId).populate({ path: 'orders', select: 'title price' }).exec((err, user) => {
  if (err) {
    // 处理错误
  } else {
    // 处理用户信息
    console.log(user.name)
    console.log(user.age)

    // 处理订单信息
    user.orders.forEach(order => {
      console.log(order.title)
      console.log(order.price)
    })
  }
})

在上面的代码中，我们通过 populate 方法指定要替换的字段为 orders，表示将用户集合中的 orders 字段替换为其对应的订单文档。接着，我们通过 select 参数指定要查询的字段为 title price，表示只查询订单文档中的标题和价格字段。

match

match 参数用于指定查询条件，它可以是一个对象或一个函数。如果是一个对象，表示要查询的条件；如果是一个函数，可以根据自定义的条件来判断是否符合查询条件。比如，我们可以使用以下代码来查询某个用户信息以及其对应的订单信息，但只查询价格大于 100 的订单：

// www.javascriptcn.com code example
User.findById(userId).populate({
  path: 'orders',
  match: { price: { $gt: 100 } }
}).exec((err, user) => {
  if (err) {
    // 处理错误
  } else {
    // 处理用户信息
    console.log(user.name)
    console.log(user.age)

    // 处理订单信息
    user.orders.forEach(order => {
      console.log(order.title)
      console.log(order.price)
    })
  }
})

在上面的代码中，我们通过 populate 方法指定要替换的字段为 orders，表示将用户集合中的 orders 字段替换为其对应的订单文档。接着，我们通过 match 参数指定要查询的条件为 price > 100，表示只查询价格大于 100 的订单文档。

示例代码

最后，我们来看一个完整的示例代码，它可以帮助大家更好地理解 Mongoose 中的 Populate 方法的使用方法和参数设置：

// www.javascriptcn.com code example
const mongoose = require('mongoose')

// 连接 MongoDB 数据库
mongoose.connect('mongodb://localhost/test', {
  useNewUrlParser: true,
  useUnifiedTopology: true
})

// 用户集合
const UserSchema = new mongoose.Schema({
  name: String,
  age: Number,
  orders: [{ type: mongoose.Schema.Types.ObjectId, ref: 'Order' }]
})
const User = mongoose.model('User', UserSchema)

// 订单集合
const OrderSchema = new mongoose.Schema({
  title: String,
  price: Number,
  user: { type: mongoose.Schema.Types.ObjectId, ref: 'User' }
})
const Order = mongoose.model('Order', OrderSchema)

// 创建用户和订单
const user = new User({ name: '张三', age: 20 })
const order1 = new Order({ title: '苹果', price: 10, user: user._id })
const order2 = new Order({ title: '香蕉', price: 15, user: user._id })
user.orders.push(order1._id, order2._id)

// 保存用户和订单
Promise.all([
  user.save(),
  order1.save(),
  order2.save()
]).then(() => {
  // 查询用户信息以及其对应的订单信息
  User.findById(user._id).populate({
    path: 'orders',
    select: 'title price',
    match: { price: { $gt: 10 } }
  }).exec((err, user) => {
    if (err) {
      console.error(err)
      return
    }

    console.log(user.name)
    console.log(user.age)
    user.orders.forEach(order => {
      console.log(order.title)
      console.log(order.price)
    })
  })
})

在上面的代码中，我们首先创建了一个用户文档和两个订单文档，并将订单 ID 添加到用户文档的 orders 字段中。接着，我们通过 populate 方法查询用户信息以及其对应的订单信息，但只查询价格大于 10 的订单，并将查询结果输出到控制台中。运行以上代码，输出结果如下：

张三
20
香蕉
15

从输出结果可以看出，我们成功查询到了用户信息以及其对应的订单信息，符合我们的预期。因此，通过这个示例代码，我们可以更加深入地理解 Mongoose 中的 Populate 方法的使用方法和参数设置。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/67d8b7d8a941bf7134f3be9a

Mongoose 中的 Populate 方法指南