Mongoose 是一个优秀的 MongoDB 驱动包,很多 Node.js 开发者都喜欢使用它进行 MongoDB 数据库的操作。在 Mongoose 中,虚拟属性(Virtual)是一个很实用的功能。本文将会介绍虚拟属性的使用,以及在使用虚拟属性时遇到的一些问题及其解决方式。
什么是虚拟属性?
虚拟属性是一种不会被存储在 MongoDB 文档中的属性。它通常是在现有文档中,基于其它属性计算出来的一个值。虚拟属性在模型对象中定义,在查询数据时表现得像真正存在的属性一样。
虚拟属性可以用于多种场景,例如计算相关值、格式化数据、存取器等等。
虚拟属性的定义
在 Mongoose 中,可以使用 set() 和 get() 方法来定义虚拟属性。set() 方法用于将一个属性值映射到一个文档属性,get() 方法用于从文档属性得到虚拟属性的值。它们的第一个参数都是虚拟属性的名称,第二个参数是一个函数,用于实现属性的计算或转化逻辑。
例如,下面的代码定义了一个模型对象,其中有两个属性 firstName 和 lastName,以及一个虚拟属性 fullName,其值由 firstName 和 lastName 组成。
-- -------------------- ---- ------- ----- -------- - -------------------- ----- ------ - ---------------- ----- ---------- - --- -------- ---------- ------- --------- ------ --- --------------------------------------------- - ------ ------------------ ------------------ --- ----- ---- - ---------------------- ------------
当我们使用此模型对象查询数据时,可以直接获得虚拟属性 fullName 的值,如下所示:
User.findOne({ _id: '123456' }, function(err, user) { console.log(user.fullName); // 输出格式为 "firstName lastName" });
虚拟属性在查询和序列化数据时的处理
由于虚拟属性并不是真实存在的数据库文档属性,因此需要注意在查询和序列化数据时如何处理虚拟属性。
查询数据时的处理
在查询数据时,只有查询条件中存在的文档属性才会被包含在查询结果中,而不存在于查询条件的虚拟属性是不会被包含的。如果我们需要在查询结果中包含虚拟属性,需要在查询条件中明确指定。
例如,我们需要查询用户数据中年龄大于 18 岁的用户,并且返回用户的 fullName,那么可以这样编写:
-- -------------------- ---- ------- ----------- ---- - ---- -- - -- ---------- --------------------- -- - ----- ---- - -------------- -- - ------ - ----------------- --------- ------------- -- --- ------------------ ---
在该示例中,我们在查询时只要指定了 firstName 和 lastName,所以虚拟属性 fullName 不会被查询出来。但是,由于我们级别后面对数据进行了一个 toJson() 操作,所以最后得到的数据对象包含了 fullName 属性。
序列化数据时的处理
当需要将 Mongoose 模型对象转换为 JSON 格式的数据时,虚拟属性也需要处理。在将 Mongoose 对象转换为 JSON 格式时,虚拟属性不会被包含在其中。如果需要将虚拟属性包括在 JSON 对象中,可以通过执行 toObject() 方法来实现。
toObject() 方法可以将 Mongoose 对象转化成一个普通的 JavaScript 对象(POJO)。我们可以将 POJO 对象转化为 JSON 格式即可得到包含虚拟属性的数据。
例如,下面的代码演示了如何将 Mongoose 对象转换为包含虚拟属性的 JSON 数据。
User.findOne({ _id: '123456' }, function(err, user) { const data = user.toObject({ virtuals: true }); // 包含虚拟属性 console.log(JSON.stringify(data)); });
在该示例中,我们使用 toObject({ virtuals: true }) 方法将 Mongoose 对象转化为包含虚拟属性的 POJO 对象。然后,我们使用 JSON.stringify() 方法将 POJO 对象转化为 JSON 格式。
虚拟属性的问题及解决方式
在使用虚拟属性时,有可能会遇到一些问题,这里介绍一些常见的问题及解决方式。
问题一:虚拟属性无法修改
虚拟属性是计算产生的值,通常无法直接修改。如果用户尝试修改虚拟属性的值,会导致无效操作。例如下面的代码:
const user = new User({ firstName: 'John', lastName: 'Doe' }); user.fullName = 'Bob Smith'; // 虚拟属性无法修改
解决方案
我们可以在虚拟属性定义中添加 set() 方法,以确保虚拟属性的值不能被修改。下面是一个示例:
UserSchema.virtual('fullName') .get(function() { return `${this.firstName} ${this.lastName}`; }) .set(function(value) { throw new Error('Virtual property "fullName" cannot be set.'); });
在该示例中,我们定义了虚拟属性 fullName,同时在其定义中添加了 set() 方法,当用户试图修改虚拟属性的值时,会抛出一个异常。
问题二:虚拟属性无法进行 MongoDB 聚合操作
MongoDB 的聚合(Aggregate)操作是 MongoDB 中非常强大的特性之一。在使用聚合操作时,我们可能需要使用虚拟属性进行计算。但是,Mongoose 目前不支持直接使用虚拟属性进行聚合操作。
如下所示,如果我们在聚合操作中使用了虚拟属性,会得到一个错误:
-- -------------------- ---- ------- ---------------- - ------- - ---- -------- ------ - ----- - -- --------- - ----- ------ -- --------- - ------ ----------- - -- ------------ - - ---
解决方案
目前,我们可以使用 Mongoose 第三方插件来解决这个问题。其中,最常用的插件之一是 mongoose-virtuals-aggregate,它可以让我们在聚合操作中使用虚拟属性。我们只需在代码中添加一行代码即可使用该插件:
const mongoose = require('mongoose'); const aggregateVirtuals = require('mongoose-virtuals-aggregate'); mongoose.plugin(aggregateVirtuals);
在添加这个插件后,我们就可以在聚合操作中使用虚拟属性了,例如:
-- -------------------- ---- ------- ---------------- - ------- - ---- -------- ------ - ----- - -- --------- - ----- ------ -- --------- - ------ - ---------- ---------- - - - - ---
结论
虚拟属性是 Mongoose 的一个强大的特性,能够帮助我们更方便地处理相关的数据。在应用中,我们应该善于利用虚拟属性。同时,我们需要注意虚拟属性在查询和序列化数据时的相关处理,以及在使用过程中可能遇到的问题及其解决方式。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/66f65c80c5c563ced583ce87