前言
在 Node.js 应用中，使用 Mongoose 是一个十分流行的选择，它提供了强大的功能和 API，能够轻松地实现与 MongoDB 数据库的交互。在使用 Mongoose 进行数据模型定义时，Schema 是一个必不可少的部分。Mongoose Schema 定义了文档中的属性以及它们的类型，还可以定义默认值、处理函数等等。本文将介绍 Mongoose 中的不可变 Schema 方法，探讨它的特性和优势，提供详细的示例代码和学习指导。
Schema 的可变性
在定义 Mongoose Schema 时，我们通常会如下所示地编写：
const exampleSchema = new mongoose.Schema({ name: String, age: Number });
这段代码定义了一个包含 name 和 age 两个属性的 Schema。但是，可以在后期随意修改这个 Schema，例如：
exampleSchema.add({ address: String }); // 增加 address 属性
或者
exampleSchema.paths.name.required = true; // 将 name 属性变为必填项
这种可变性会给我们使用 Mongoose 提供便利，但也会带来一些重要的问题。
- 当多个开发者协作开发时，Schema 可能会被不同的人修改，这导致了团队成员之间的不确定性。
- Schema 的可变性增加了测试难度，因为测试就必须关注 Schema 的不同版本。
- 程序有可能通过运行时产生错误，因为预期的 Schema 结构已经被替换了。
这些问题当然可以通过一些手段来解决，例如使用元编程生成 Schema，或是对修改进行代码审查，并尽可能规范化贡献者的行为和内容。但是，Mongoose 也提供了一种更好的解决方案——不可变 Schema。
不可变 Schema
在 Mongoose 中，定义不可变 Schema 非常简单，只需传递一个 immutable 选项，示例如下：
const immutableExampleSchema = new mongoose.Schema({ name: String, age: Number }, { immutable: true });
当 immutable 选项设置为 true 时，在应用启动之后，修改 Schema 将会触发错误：
immutableExampleSchema.add({ address: String }); // 抛出 Error
这意味着，一旦你定义了一个不可变 Schema，它就将永远保持这个结构，没有任何方法可以在应用运行时进行修改。这种策略有时被称为“结构性声明”。
将 Schema 定义为不可变的好处：
- 替换版本控制，使团队成员对于 Schema 的理解和协作更简单。
- 更容易的测试和验证 Schema 的正确性。
- 保证在应用运行时，访问的是预期的 Schema 结构，从而降低了运行时错误的风险。
注意事项
在使用不可变 Schema 时，需要注意以下几点：
- 一旦使用了不可变 Schema，就不能再切换到可变 Schema，否则会导致无法预测的错误。
- 如果你想要修改 Schema，你需要通过迁移的方式进行，这意味着你必须创建一个新的 Schema 并将数据从旧的 Schema 移动到新的 Schema。
- 不可变 Schema 并不是万能的，在某些情况下，Schema 的修改可能是必要的，我们需要根据具体的情况权衡这个决定。
示例代码
以下是一个示例程序，它将 User 模型定义为不可变 Schema，并使用 createUser 和 updateUser 函数来演示对模型进行创建和更新的方法。
-- -------------------- ---- ------- ----- -------- - -------------------- -- ----- ------ ----- ---------- - --- ----------------- --------- ------- ------ - ----- ------- ------- ---- - -- - ---------- ---- --- -- ---- ----- ---- - ---------------------- ------------ -- ---- ----- -------- -------------------- ------ - ----- ---- - --- ------ --------- ----- --- ----- ------------ - -- ---- ----- -------- ------------------ ---------- - ----- ------ - ----- ---------------- ---- ------ -- ----------- -- ------------------- - ----- --- --------- ---- ---------- - - -- -- ------ -- -- - ----- --------------------------------------------- ----- ------------------ -- ---- ----- ------------------- --------------------- ----- ----------------- ------------------- --- - -- ------- --------- ----- ------------------- --------------------- - ----- ----- - ------------------------- -- ------- --------- --- --------- - -- ---- ----- ------------- - --------- --------- ------ -------------------- --- --- - -- -------------- ----- ------------- - --------- --------- ------ ---- --- - ----- ----- - ------------------------- -- ------ ------- -- --- -- ------ --- -- --- ---------- - ----- ---------------------- -----展开代码
在上面的示例中，username 和 email 是模型的两个属性，设置了不可变 Schema。在调用 createUser 函数时，如果试图添加相同的 email，将会出现 E11000 Duplicate Key 错误。在调用 updateUser 函数时，如果尝试修改不在 Schema 中的属性，会出现 Field is not in schema and is not updatable 错误。
学习指导
本文介绍了 Mongoose 中的不可变 Schema 方法，讲解了它的特性和优势，提供了详细的示例代码和注意事项。使用不可变 Schema 可以确保数据模型在运行时不会被意外更改，在团队合作和测试方面具有一定的优势。如果您正在使用 Mongoose，相信本文会对您的项目开发有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/67ceae0ee46428fe9e937781
