チュートリアル: Mongooseを使い始める

前提条件を確認します

このチュートリアルを開始する前に、次のコンポーネントが準備されていることを確認してください。

• 構成されたクラスターを持つMongoDB Atlasアカウント。手順を表示するには、「 Atlas を使い始める」ガイドを参照してください。

• Node.js v16.20.1以降に更新します。

環境を設定する

このチュートリアルでは、 Nodemon を使用してコードをローカルで実行します。プロジェクトを初期化し、必要な依存関係をインストールするには、ターミナルで次のコマンドを実行します。

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

希望のコード エディターでプロジェクトを開きます。このチュートリアルでは、CommonJS ではなく ES モジュールを使用します。ES モジュールを使用するには、module タイプを追加する必要があります。package.jsonファイルにGo、次のコードを追加します。

...
"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;

このスキーマでは timestamps オプションが有効になります。これにより、自動的に更新される mongoose が管理する createdAt フィールドと updatedAt フィールドがスキーマに追加されます。詳細については、 Mongooseドキュメントのタイムスタンプページを参照してください。

CRUD 操作を実行

これで最初のモデルとスキーマが設定され、データベースへのデータの挿入を開始できます。次のセクションでは、 Mongooseを使用してCRUD操作を実行する方法を説明します。

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
});

この検証を追加すると、アプリケーションがクラッシュします。新しい検証要件を満たすには、index.jsファイルの create() 呼び出しに authorフィールドを追加します。

// 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'],
});

詳細については、 Mongooseドキュメントの「検証」ページを参照してください。

複数のスキーマを導入しました

次に、別のスキーマを作成し、それを ブログスキーマにネストすることで、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;

新しいユーザー モデルを使用してブログスキーマの authorフィールドを定義するには、Blog.jsファイルを次の変更で更新します。

• Mongooseライブラリから抽出されたプロパティのリストに SchemaTypes を追加します。

• 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,
      },
...

アプリケーションで新しいユーザーモデルを使用するには、 index.jsファイルにGo。 ユーザー モデルをインポートするには、ファイルの先頭に次のコードを追加します。

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 に設定します。

記事の authorフィールドに name フィールドと email フィールドの値を追加するには、 Mongoose populate() メソッドをブログ クエリに追加します。populate() メソッドは、user._id が参照するユーザードキュメントに対して 2 番目のクエリを実行します。

このデータを入力するには、次のコードを 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
}

詳細については、 Document.popify() のMongoose APIドキュメントのページを参照してください。

ミドルウェアの追加

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

メールアドレスを修正すると、エラーがスローされないことが確認できます。

pre()ミドルウェア関数に加えて、 Mongoose はpost() ミドルウェア関数も提供しています。ミドルウェアの詳細については、 Mongooseドキュメントの「 ミドルウェア 」のページを参照してください。