Mongoose 是一个基于 Node.js 的 MongoDB ODM（Object Document Mapping）库，提供了一种基于模型（Model）的方法来操作数据库。在 Mongoose 中，Schema 是 Model 的基础，它定义了文档的结构和字段类型，而插件则可以在 Schema 的基础上提供额外的功能，使得 Model 更易于使用和维护。
为什么需要插件？
在实际的开发中，我们常常会遇到需要对数据进行校验、添加默认值、索引优化等需求。如果每个 Model 都需要手动处理这些问题，不仅重复性工作较多，而且容易出现遗漏。为了提高代码的可维护性，我们可以将这些通用的操作封装成一个个插件，并将其应用到相应的 Schema 中，从而统一处理这些问题。因此，插件是 Mongoose 中一个非常实用的功能。
插件的定义和使用
在 Mongoose 中，插件也是一个函数，它接受一个名为 schema 的参数，该参数代表当前的 Schema 对象。插件需要通过调用 schema 上的方法来修改和扩展当前 Schema，最后返回它本身。下面是一个示例插件，它在 Schema 中添加了一个名为 createdAt 的字段，并为其赋默认值：
const addCreatedAt = function (schema, options) {
schema.add({ createdAt: { type: Date, default: Date.now } });
};
module.exports = addCreatedAt;为了应用这个插件，我们可以通过以下代码来调用：
-- -------------------- ---- ------- ----- -------- - -------------------- ----- ------------ - -------------------------- ----- ---------- - --- ----------------- --------- - ----- ------- --------- ---- -- --------- - ----- ------- --------- ---- -- --- --------------------------------
这样一来，userSchema 中便会自动添加一个名为 createdAt 的字段，并默认赋值为创建该文档的时间。我们可以通过下面这段代码来验证一下这个插件是否生效：
const User = mongoose.model('User', userSchema);
const user = new User({
username: 'test',
password: '123456',
});
console.log(user.createdAt); // 输出当前时间从上面的使用方法可以看出，插件的调用非常简单，只需要通过 schema.plugin() 方法来完成即可。
插件的常见应用场景
1. 数据校验
Mongoose 中提供了丰富的数据校验规则，例如必填字段、最大值、最小值、正则表达式等。我们可以通过插件的方式来封装这些校验规则，使得它们可以在多个 Model 中复用。
以下是一个示例插件，它对某个字段进行了必填校验：
const requiredValidator = function (schema, options) {
schema.path(options.field, { required: true });
};
module.exports = requiredValidator;在使用时，我们可以通过传递一个名为 field 的选项来告诉插件需要处理哪个字段：
const userSchema = new mongoose.Schema({
username: { type: String, required: true },
password: { type: String },
});
userSchema.plugin(requiredValidator, { field: 'password' });这样一来，password 字段就必须填写了。
2. 自动增加序号
在实际应用中，我们常常会遇到需要将数据库中的某一字段作为自增序号的场景。Mongoose 本身并不提供支持，但是我们可以通过插件来实现。
以下是一个示例插件，它将对某个字段进行自增处理：
-- -------------------- ---- -------
----- ------------- - -------- -------- -------- -
----- ----- - ------------- -- -----
------------ -------- - ----- ------- ------- ---- - ---
------------------ -------- ------ -
----- ---- - -----
-- -------------- -
---------------------------------------------- -- -
----------- - ----- - --
-------
-------------- -- -
----------
---
- ---- -
-------
-
---
--
-------------- - --------------在使用时，我们可以通过传递一个名为 field 的选项来告诉插件需要处理哪个字段。在插件的实现中，我们使用了 Mongoose 的 pre 钩子来在文档保存前进行自增操作。
const userSchema = new mongoose.Schema({
username: { type: String, required: true },
});
userSchema.plugin(autoIncrement, { field: 'userId' });这样一来，userSchema 中就会自动添加一个名为 userId 的字段，并在保存该文档时自动为其赋值。
插件的开发思路
在实际的开发中，我们可以根据项目需求自行开发插件。但是，不同的插件可能涉及到不同的业务逻辑，因此需要有一个比较清晰的开发思路。以下是一个简单的开发思路，供参考：
确定具体需求：在开发插件前，需要确定具体的需求，例如是否需要处理数据校验、是否需要增加索引等。
确定处理方式：根据具体需求，再确定处理方式。例如，如果需要对某个字段进行必填校验，可以使用 Mongoose 提供的 path 方法来添加该字段。如果需要对某个字段自动增加序号，则需要使用 pre 钩子来处理。
进行插件开发：在确定处理方式后，便可以开始插件的开发。插件的开发可以使用函数封装，将多个操作封装进一个函数里面，以便统一调用。
进行插件测试：在插件开发完成后，需要进行测试，确保插件可以正常使用，并达到预期效果。
总结
插件是 Mongoose 中非常实用的功能，它通过封装通用的操作，提高了代码的可维护性和复用性。在实际开发中，插件的应用场景非常广泛，例如数据校验、自动增加序号等。在开发插件时，需要先确定具体需求、处理方式，再进行插件封装和测试。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/64569cf5968c7c53b09a8e25