Mongoose virtual 虚拟属性的实现原理分析-JavaScript中文网-JavaScript教程资源分享门户

Mongoose 是一个用于 Node.js 的 MongoDB 驱动程序，它提供了许多便捷的方法和功能，使得开发者能够轻松地对 MongoDB 进行操纵和管理。其中，Mongoose 的虚拟属性 (virtual) 是一项非常重要的功能，可以帮助开发者轻松地定义和操作虚拟属性，从而更加高效地实现业务逻辑。本文将对 Mongoose 的虚拟属性实现原理进行详细的分析，并给出相关示例代码，以期帮助初学者更好地理解和应用该功能。

什么是 Mongoose 虚拟属性？

在 MongoDB 中，一个文档 (document) 对应着一个 JSON 格式的对象。开发者可以定义一个 Mongoose 模型 (model) 来描述这个对象的结构，并通过该模型进行 CRUD 操作。虚拟属性是 Mongoose 中的一项功能，它通过计算属性 (computed property) 的方式，从文档中的其他属性中派生出一个新的属性，而不需要在数据库中存储这个属性。在 Mongoose 中，虚拟属性的定义如下：

let schema = new mongoose.Schema({
  // ...
});

schema.virtual('fullName').get(function() {
  return this.firstName + ' ' + this.lastName;
});

在上面的示例中，我们定义了一个 firstName 和一个 lastName 属性，然后通过定义一个 fullName 虚拟属性，将其作为一个计算属性返回。当我们在读取文档的 fullName 属性时，Mongoose 就会调用 get 方法来计算这个属性的值，并将其返回。因此，我们可以通过文档的 fullName 属性来获取其完整的姓名。

Mongoose 虚拟属性的实现原理

Mongoose 虚拟属性的实现原理其实是非常简单的。在 Mongoose 内部，每个文档都是一个 JavaScript 对象，每个属性都是这个对象的一个属性。因此，我们可以通过 JavaScript 对象的 get 和 set 方法来实现 Mongoose 的虚拟属性。

当我们通过 get 方法读取文档的虚拟属性时，Mongoose 会查找这个属性是否已经存在，如果不存在，则调用虚拟属性的 get 方法来计算属性值。计算完成后，Mongoose 将返回值存储在文档对象中，并返回该值。

当我们通过 set 方法设置文档的虚拟属性时，Mongoose 会将该属性存储在文档对象中，并调用虚拟属性的 set 方法来更新其值。如果虚拟属性不支持写操作，则 Mongoose 会抛出一个错误。

Mongoose 虚拟属性的使用技巧

Mongoose 虚拟属性是一个非常灵活的工具，可以帮助开发者更加方便地实现复杂的业务逻辑。下面我们将介绍一些 Mongoose 虚拟属性的使用技巧。

1. 虚拟属性计算的时机

虚拟属性的计算时机是由 Mongoose 决定的。具体来说，它是在读取文档属性时，动态地计算属性值。因此，如果虚拟属性的计算比较耗时，就会导致读取文档的性能下降。为了避免这种情况，开发者可以通过将虚拟属性缓存到文档中，来优化读取性能。

例如，假设我们定义了一个需要进行大量计算的虚拟属性 fullName：

schema.virtual('fullName').get(function() {
  let fullName = '';
  // 大量计算 ...
  return fullName;
});

这样，每次读取文档的 fullName 属性时，都会进行大量的计算，导致性能下降。为了避免这种情况，我们可以将 fullName 缓存到文档中：

schema.virtual('fullName').get(function() {
  if (!this._fullName) {
    let fullName = '';
    // 大量计算 ...
    this._fullName = fullName;
  }
  return this._fullName;
});

这样，第一次读取 fullName 属性时，Mongoose 将计算属性值，并将其缓存到文档对象的 _fullName 属性中。然后，在下一次读取 fullName 属性时，Mongoose 直接返回 _fullName 属性的值，避免了重复计算。

2. 虚拟属性的 set 方法

虚拟属性的 set 方法可以在虚拟属性被设置时进行一些额外的操作。例如，我们可以定义一个虚拟属性 password，并在其被设置时，使用 bcrypt 加密算法对其进行加密。

const bcrypt = require('bcrypt');

schema.virtual('password').set(function(value) {
  this._password = value;
  this.salt = bcrypt.genSaltSync(10);
  this.passwordHash = bcrypt.hashSync(value, this.salt);
});

在上面的示例中，我们存储了用户的原始密码 _password，并使用 bcrypt 算法对其进行加密。这样，在下一次读取 password 属性时，我们将返回加密后的密码。

3. 虚拟属性和载入文档

虚拟属性和载入文档的时机也是一个需要注意的点。具体来说，虚拟属性不能在请求从数据库中载入文档时使用。

例如，如果我们在加载一个文档时，尝试使用虚拟属性 fullName：

User.findById(1, function(err, user) {
  if (err) return console.error(err);
  console.log(user.fullName);
});

这时，Mongoose 将直接从数据库中取出文档，而不会使用虚拟属性，从而导致 fullName 为空。为了避免这种情况，我们可以使用 Mongoose 的 lean 方法，以便在查询中使用虚拟属性：

User.findById(1).lean().exec(function(err, user) {
  if (err) return console.error(err);
  console.log(user.fullName);
});

在上面的示例中，我们使用了 lean 方法，将文档从 Mongoose 对象转换为普通 JavaScript 对象。这样，当载入文档时，Mongoose 将使用虚拟属性来设置 _fullName 属性，并将其返回给我们。

示例代码

下面是一个完整的 Mongoose 虚拟属性示例，其中，我们定义了一个 fullName 虚拟属性，用于计算用户的完整姓名。同时，我们添加了一个 password 虚拟属性，用于对用户的密码进行加密。

-- -------------------- ---- -------
----- -------- - --------------------
----- ------ - ------------------

---------------------------------------------

--- ---------- - --- -----------------
  ---------- ------ ------- --------- ------
  --------- ------ ------- --------- ------
  ----- -------
  ------------- ------
---

--------------------------------------------- -
  -- ----------------- -
    -------------- - -------------- - - - - --------------
  -
  ------ ---------------
---

-------------------------------------------------- -
  -------------- - ------
  --------- - -----------------------
  ----------------- - ---------------------- -----------
---

--------------------------------------------- -
  ------ ------------------
---

--- ---- - ---------------------- ------------

--- ---- - --- ------
  ---------- -------
  --------- ------
  --------- -------------
---

---------------------------
-------------------------------

在上面的示例中，我们首先定义了一个 userSchema，其中包含了用户的 firstName、lastName、salt 和 passwordHash 属性。然后，我们定义了两个虚拟属性 fullName 和 password，分别用于计算用户的完整姓名和对用户的密码进行加密。注意，在 password 虚拟属性的 set 方法中，我们对用户的密码进行了加密，并将其存储在 salt 和 passwordHash 属性中。这样，在读取密码时，我们将返回加密后的密码。

最后，我们创建了一个新的 User 对象，并使用 fullName 和 passwordHash 属性来测试我们的虚拟属性。运行该示例代码，我们将得到以下输出：

John Doe // 输出用户的完整姓名
$2b$10$F/nmrEHt271rMhVH1vATPej7VfzgDYJm7XstLMTuxA8e7wAdhENrO // 输出经过 bcrypt 加密的密码

总结

本文对 Mongoose 的虚拟属性进行了详细的分析，介绍了虚拟属性的定义方式、实现原理、使用技巧及相关示例代码。通过本文的学习，我们可以更加深入地理解 Mongoose 的虚拟属性功能，并能够灵活使用该功能来实现业务逻辑。

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