튜토리얼: 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 설명서에서 Connect to Your Cluster(클러스터에 연결하기) 튜토리얼을 참조하세요.

스키마 및 모델 만들기

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;

이 스키마 자동으로 업데이트되는 스키마 에 mongoose-managed createdAt 및 updatedAt 필드를 추가하는 timestamps 옵션을 활성화합니다. 자세한 내용은 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 필드 4의 minLength 이 있는 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 database 에 users 컬렉션 blogs 컬렉션 과 함께 추가합니다. 이 코드는 필수 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
}

자세한 내용은 Document.population() 을 참조하세요. 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 설명서의 미들웨어 페이지를 참조하세요.