Mongoose：使用 Schema.methods 添加实例方法-JavaScript中文网-JavaScript教程资源分享门户

Mongoose是一个优秀的Node.js ORM框架，它可以极大地简化 MongoDB 操作。除了支持基本的 CRUD 操作，Mongoose 还提供了很多常用功能，如 Schema 与 Model 的定义、文档验证、中间件等等。本文将介绍如何使用 Mongoose 的 Schema.methods 来添加实例方法。

如何添加实例方法

在 Mongoose 中，Model 对应于 MongoDB 中的集合（Collection），文档（Document）则对应于集合中的单个记录（Record）。通过 Schema 配置，我们可以控制 MongoDB 中集合和文档的结构。Schema 中可以定义实例方法，用于在Document实例上执行操作。

Schema.methods 是一个对象类型，其中定义了实例方法。下面的示例演示如何通过 useId()方法，在将文档保存到数据库之前为文档生成一个唯一的ID:

// javascriptcn.com 代码示例
const mongoose = require('mongoose');
const Schema = mongoose.Schema;

const UserSchema = new Schema({
  name: { type: String, required: true },
  age: { type: Number, required: true }
});

UserSchema.methods.useId = function () {
  return this._id.toHexString();
}

const User = mongoose.model('User', UserSchema);

在上面的代码中，我们定义了 Schema.methods.useId 方法，将生成一个唯一的ID并返回，它绑定到了UserSchema上。在定义Schema后，我们再通过 mongoose.model() 方法将它编译成一个Model，这里为 User。

现在，你可以像下面一样实例化一个 User，使用 useId() 方法为它生成一个 ID：

const user = new User({ name: 'John Doe', age: 30 });

// 使用 useId() 方法为 user 生成一个 ID
const userId = user.useId();

console.log(userId); // 输出用户ID

Schema.methods 的使用场景

Schema.methods 可以非常方便地添加文档实例方法，它们可以处理文档之间的关系，如发送电子邮件或电话短信等。下面是一些更常见的使用场景：

处理密码

在将密码存储到数据库中之前，通常我们会通过加密算法对密码进行散列，以增加安全性。为了封装此过程，我们可以创建一个实例方法：

UserSchema.methods.authenticate = function (callback) {
  bcrypt.compare(password, this.password, callback);
}

在上面的代码中，我们使用 bcrypt.compare() 方法对密码进行比较，以便验证它是否正确。如果有一个回调函数被传递，则将它调用，并将结果传递给它。开发人员可以使用这个方法来验证用户输入的密码是否正确，从而进行身份验证。

更新文档

在更改文档之前，您可能需要先对它进行某些检查或操作，比如记录修改时间、更新关联文档等。通过实例方法，我们可以在文档保存到数据库之前做这些操作：

UserSchema.methods.updateAndSave = function (callback) {
  this.updatedAt = new Date();
  this.save(callback);
}

在上面的代码中，我们创建了一个名称为updateAndSave的新实例方法，它会将文档的 updatedAt 时间戳设置为当前日期，并自动保存文档到数据库中。我们将这个方法定义为实例方法，因为它需要直接操作文档实例本身。

总结

在 Mongoose 中使用 Schema.methods 可以非常方便地添加文档实例方法。这些实例方法可以用于许多场景，如处理密码、更新文档等。通过这些实例方法，我们可以轻松编写出漂亮的、易于维护和可重复使用的代码。

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