详细解释 Mongoose 中 populate 函数的使用方法

Mongoose 是基于 Node.js 的 MongoDB 对象模型工具库，因其功能强大、易于使用和灵活性备受前端开发者的青睐。Mongoose中，populate 函数是其中一个十分有用的方法，本文将会详细解释其使用方法。

Mongoose 中 populate 函数的基本概念

在 Mongoose 中，populate 函数用于从 MongoDB 中取得一个 document，然后将该 document 的某个或某些属性值替换为其他 collection 中的文档。这个过程通常被称作参考（Referencing）或者联合（Join）。

具体来说，populate 函数会处理包含了 reference 类型属性的 document，在查询时通过使用 populate 函数将这些 reference 类型属性“展开”，成为一份完整的、相关的 document 集合。这意味着开发者可以从一个文档集合中轻松地查询所有与某个文档相关的信息。

合理使用 populate 函数的场景

使用 populate 函数通常与以下场景有关：

1. 当包含 reference 类型的属性值的 document 被读取时，需要按照某个条件展现它的永久属性，如为 ID值、名称、区域等等。

2. 当引用类型的属性值需要进行分页或者其子对象被过滤时，populate 函数应用也是非常方便的。

3. 当 reference 属性值有着更久远或复杂的历史时，在业务开发中我们可以将其通过 populate 函数中的条件将相互引用的数据来进行关联。

Mongoose populate 函数的使用方法

在 Mongoose 中，populate 函数使用时需要设置相关的 option 参数。示例代码如下：

// javascriptcn.com 代码示例
Tour.aggregate([
  {
    $geoNear: {
      near: {
        type: 'Point',
        coordinates: [lng, lat],
      },
      distanceField: 'distance',
      spherical: true,
      maxDistance: 200000,
    },
  },
  {
    $lookup: {
      from: 'reviews',
      localField: '_id',
      foreignField: 'tour',
      as: 'reviews',
    },
  },
  {
    $project: {
      name: '$name',
      rating: '$ratingAverage',
      price: '$price',
      summary: '$summary',
      distance: '$distance',
      description: '$description',
      image: '$imageCover',
      toursNumber: '$startLocation.description',
      startDates: '$startDates',
      id: '$_id',
      reviews: '$reviews',
    },
  },
]);

在上面这个示例代码中，我们使用 populate 函数来进行数据的关联。其中，$lookup 子句用于来自数据库中的“tours”集合的聚合（$geoNear Subclause 中的“Tour”被推到前面来作为一个变量名）。然后，我们将“reviews”的引用放入我们要创造的新“Tour”对象的“reviews”字段中，从而通过该字段分组显示游戏。

Mongoose 中 populate 函数使用方法的注意事项

在使用 populate 函数时，需要注意以下重要细节：

1. 引用属性和需要展开的属性一定要出现在 schema 模式中，且定义为 reference 类型或 sub-document。如果你没有在 schema 中定义，你仍然可以在“populate”函数中使用，但这不会有任何作用。

2. 通常，在使用 populate 函数时，需要注意性能问题。因为它需要在不同的 collection 之间进行查询的转换。但是，可能会有更有效的查询模式定义。

3. 当使用某个属性值作为 reference 类型时，建议使用 ObjectId 类型（即局限于数据）。

总结

Mongoose 中 populate 函数的使用在 MongoDB 开发中非常有用，可以灵活地处理包含 reference 类型的属性值的 document，让开发者轻松地查询这些属性值相关的所有信息。在使用过程中，需要注意性能问题，并且要保证所有需要展示或者参考的属性值都已经被定义在 schema 模式中。

参考文献

https://mongoosejs.com/docs/populate.html

来源：JavaScript中文网 ，转载请注明来源 本文地址：https://www.javascriptcn.com/post/651db9fb95b1f8cacd55b287