教程：开始使用Mongoose

验证先决条件

在开始本教程之前，请确保您已准备好以下组件：

• 已配置集群的MongoDB Atlas帐户。要查看说明，请参阅 Atlas入门指南。

• Node.js v16.20.1 or later.

设置您的环境

This tutorial uses nodemon to run the code locally. Run the following commands in your terminal to initialize your project and install the necessary dependencies:

mkdir mongodb-mongoose
cd mongodb-mongoose
npm init -y
npm i mongoose
npm i -D nodemon

在首选代码编辑器中打开项目。本教程使用 ES 模块而不是 CommonJS。必须添加 module 类型才能使用 ES 模块。Gopackage.json文件并添加以下代码：

...
"scripts": {
  "dev": "nodemon index.js"
},
"type": "module",
...

通过运行以下命令，使用 nodemon 启动应用程序：

npm run dev

连接至 MongoDB

在项目的根级别中，创建一个名为 index.js 的文件，并将以下代码添加到文件顶部：

import mongoose from 'mongoose';
mongoose.connect("<connection string>")

将 <connection string> 占位符替换为MongoDB Atlas连接字符串。 有关如何查找连接字符串的更多信息，请参阅Atlas文档中的连接到集群教程。

创建模式和模型

在开始在MongoDB中添加和更新数据之前，您必须创建模式和模型。

使用Mongoose ，您可以为所需的每个模式创建一个模式模型文件。首先，创建一个名为 model 的文件夹来放置所有模式文件，然后创建您的第一个模式文件并将其命名为 Blog.js。打开此文件并添加以下代码：

import mongoose from 'mongoose';
const { Schema, model } = mongoose;
const blogSchema = new Schema({
  title: String,
  slug: String,
  published: Boolean,
  author: String,
  content: String,
  tags: [String],
  comments: [{
    user: String,
    content: String,
    votes: Number
  }]
}, {
  timestamps: true
});
const Blog = model('Blog', blogSchema);
export default Blog;

This schema enables a timestamps option, which adds mongoose-manged createdAt and updatedAt fields to the schema that are updated automatically. For more information, see the Timestamps page in the Mongoose documentation.

执行 CRUD 操作

您现在已经设立了第一个模型和模式，可以开始向数据库插入数据。以下部分向您展示如何使用Mongoose执行增删改查操作。

import Blog from './model/Blog.js';

// Creates a new blog post and inserts it into database
const article = await Blog.create({
  title: 'Awesome Post!',
  slug: 'awesome-post',
  published: true,
  content: 'This is the best post ever',
  tags: ['featured', 'announcement'],
});
console.log('Created article:', article);

// Updates the title of the article
article.title = "The Most Awesomest Post!!";
await article.save();
console.log('Updated Article:', article);

Updated Article: {
   title: 'The Most Awesomest Post!!',
   slug: 'awesome-post',
   published: true,
   content: 'This is the best post ever',
   tags: [ 'featured', 'announcement' ],
   _id: new ObjectId('...'),
   comments: [],
   __v: 0
}

// Finds the article by its ID. Replace <object id> with the objectId of the article.
const articleFound = await Blog.findById("<object id>").exec();
console.log('Found Article by ID:', articleFound);

Found Article by ID: {
   _id: new ObjectId('68261c9dae39e390341c367c'),
   title: 'The Most Awesomest Post!!',
   slug: 'awesome-post',
   published: true,
   content: 'This is the best post ever',
   tags: [ 'featured', 'announcement' ],
   comments: [],
   __v: 0
}

// Finds the article by its ID and projects only the title, slug, and content fields.
// Replace <object id> with the objectId of the article.
const articleProject = await Blog.findById("<object id>", "title slug content").exec();
console.log('Projected Article:', articleProject);

Projected Article: {
   _id: new ObjectId('...'),
   title: 'The Most Awesomest Post!!',
   slug: 'awesome-post',
   content: 'This is the best post ever'
}

// Deletes one article with the slug "awesome-post".
const blogOne = await Blog.deleteOne({ slug: "awesome-post" });
console.log('Deleted One Blog:', blogOne);

Deleted One Blog: { acknowledged: true, deletedCount: 1 }

// Deletes all articles with the slug "awesome-post".
const blogMany = await Blog.deleteMany({ slug: "awesome-post" });
console.log('Deleted Many Blogs:', blogMany);

Deleted Many Blogs: { acknowledged: true, deletedCount: 4 }

验证数据

在前面步骤中插入的项目不包含 author、dates 或 comments 字段，即使这些字段包含在模式中。这是因为，尽管您定义了文档的结构，但尚未定义哪些字段是必填字段。任何未定义为必填字段都可以省略。

在Mongoose中，当您对字段进行验证时，必须传递一个对象作为其值。

您可以在Mongoose中使用多种验证方法。示例，您可以在任何您想要要求的字段上将 required设立为 true。您还可以验证类型和格式。在以下代码中，slug字段被定义为 minLength 为 4 的 string。这意味着提供少于 4 个字符的 slug 将得到 ValidationError。

要添加数据验证并定义这些要求，更新Blog.js 中的模式，如以下示例所示：

const blogSchema = new Schema({
  title:  {
    type: String,
    required: true,
  },
  slug:  {
    type: String,
    required: true,
    minLength: 4,
  },
  published: {
    type: Boolean,
    default: false,
  },
  author: {
    type: String,
    required: true,
  },
  content: String,
  tags: [String],
  comments: [{
    user: String,
    content: String,
    votes: Number
  }]
}, {
  timestamps: true
});

添加此验证后，您的应用程序将崩溃。将 author字段添加到 index.js文件中的 create() 调用，以满足新的验证要求：

// Creates a new blog post and inserts it into database
const article = await Blog.create({
  title: 'Awesome Post!',
  slug: 'awesome-post',
  published: true,
  author: 'A.B. Cee',
  content: 'This is the best post ever',
  tags: ['featured', 'announcement'],
});

For more information, see the Validation page in the Mongoose documentation.

引入多种模式

接下来，您可以通过创建另一个模式并将其嵌套在博客模式中来增加 author字段的复杂性。

在 model 文件夹中，创建一个名为 User.js 的新文件。将以下代码添加到此文件：

import mongoose from 'mongoose';
const {Schema, model} = mongoose;
const userSchema = new Schema({
  name: {
    type: String,
    required: true,
  },
  email: {
    type: String,
    minLength: 10,
    required: true,
    lowercase: true
  },
});
const User = model('User', userSchema);
export default User;

要使用新的 User 模型定义博客模式中的 author字段，请使用以下更改更新Blog.js文件：

• 将 SchemaTypes 添加到从Mongoose库提取的属性列表中。

• 将 author字段type 更改为 SchemaTypes.ObjectId，并添加对 'User' 模型的引用 (ref)。

以下代码显示了这些更新：

const { Schema, SchemaTypes, model } = mongoose;
... // Inside Schema block:
   author: {
      type: SchemaTypes.ObjectId,
      ref: 'User',
      required: true,
   },
...

您可以通过更改 blogSchema 定义，为 comment.user字段重复使用相同的 User 模型：

... // Inside Schema block:
   comments: [{
      user: {
         type: SchemaTypes.ObjectId,
         ref: 'User',
         required: true,
      },
...

要在应用程序中使用新用户模型，Goindex.js文件。 将以下代码添加到文件顶部以导入用户模型：

import User from './model/User.js';

由于您在博客模式中添加了字段验证，因此之前用于插入、更新和删除博客以及指定要项目的字段的代码将无法通过验证，应用程序将出错。

通过添加以下 create() 调用来创建新用户：

// Create a new user
const user = await User.create({
  name: 'Jess Garica',
  email: 'jgarcia@email.com',
});

使用以下代码更新现有的 create() 调用，以创建一篇将新用户作为作者的新文章，如以下代码所示：

// Creates a new blog post that references the user as the author
const articleAuthor = await Blog.create({
  title: 'Awesome Post!',
  slug: 'Awesome-Post',
  author: user._id,
  content: 'This is the best post ever',
  tags: ['featured', 'announcement'],
});
console.log('Article with Author:', articleAuthor);

Article with Author: {
   title: 'Awesome Post!',
   slug: 'awesome-post',
   published: false,
   author: new ObjectId('...'),
   content: 'This is the best post ever',
   tags: [ 'featured', 'announcement' ],
   _id: new ObjectId('...'),
   createdAt: 2025-05-15T18:05:23.780Z,
   comments: [],
   __v: 0
}

前面的代码在MongoDB 数据库中添加一个带有 blogs集合的 users集合。此代码添加必填的 author字段并将其值设置为 user._id。

要将文章的 name 和 email 字段的值添加到 author字段，您可以将Mongoose populate() 方法附加到博客查询中。populate() 方法将对 user._id 引用的用户文档执行第二次查询。

将以下代码添加到 index.js 以填充此数据：

// Populates the author field with user data
const articlePopulate = await Blog.findOne({ title: "Awesome Post!" }).populate("author");
console.log('Article Populated:', articlePopulate);

Article Populated: {
   _id: new ObjectId('...'),
   title: 'Awesome Post!',
   slug: 'awesome-post',
   published: false,
   author: {
      _id: new ObjectId('...'),
      name: 'Jess Garica',
      email: 'jgarcia@email.com',
      __v: 0
   },
   content: 'This is the best post ever',
   tags: [ 'featured', 'announcement' ],
   createdAt: 2025-05-15T18:04:28.590Z,
   comments: [],
   __v: 0
}

For more information, see the Document.populate() page of the Mongoose API documentation.

添加中间件

在Mongoose中，中间件是在模式级别的异步函数执行之前或期间运行的函数。

中间件的一个示例是在保存或更新之前验证 User实例的 email字段的函数。

此示例使用 validator包。您可以通过运行以下命令来安装 validator包：

npm install validator

要添加此中间件函数，请将以下代码添加到 User.js文件的 userSchema 声明中：

import validator from 'validator';

userSchema.pre('save', function (next) {
  const user = this;
  // Normalize email
  if (user.email) {
    user.email = user.email.trim().toLowerCase();
  }
  // Validate email format
  if (!validator.isEmail(user.email)) {
    return next(new Error('Invalid email format'));
  }
  next();
});

要查看此函数的效果，请修改 index.js文件中的 user.email字段，使其成为无效的电子邮件解决：

const user = await User.create({
  name: 'Jess Garica',
  email: 'jgarciaemail.com',
});

Error: Invalid email format

如果更正电子邮件解决，则可以看到未引发错误。

Besides the pre() middleware function, Mongoose also offers a post() middleware function. For more information about middleware, see the Middleware page in the Mongoose documentation.