[Node]Instagram Clone - 6. MongoDB Populate을 사용한 게시물 조회 API

• 이번 포스트에서는 MongoDB의 populate 메서드를 사용하여 게시물 조회 시 댓글도 함께 불러오는 방법에 대해 알아보겠음!

1. 스키마 설계

• 우선, 게시물(Post)과 댓글(Comment)의 스키마를 정의해야 함. 

1) 게시물 스키마

// post.js

const mongoose = require("mongoose");

const postSchema = new mongoose.Schema({
  user: {
    type: mongoose.Schema.Types.ObjectId,
    ref: "User",
    required: true,
  },
  text: {
    type: String,
    required: false,
    trim: true,
  },
  images: [
    {
      type: String,
      required: true,
    },
  ],
  createdAt: {
    type: Date,
    default: Date.now,
  },
  comments: [{ // 댓글을 위한 필드 추가
    type: mongoose.Schema.Types.ObjectId,
    ref: "Comment",
  }],
});

const Post = mongoose.model("Post", postSchema);
module.exports = { Post };

2) 댓글 스키마

// comment.js

const mongoose = require("mongoose");

const commentSchema = new mongoose.Schema({
  post: {
    type: mongoose.Schema.Types.ObjectId,
    ref: "Post",
    required: true,
  },
  user: {
    type: mongoose.Schema.Types.ObjectId,
    ref: "User",
    required: true,
  },
  text: {
    type: String,
    required: true,
  },
  createdAt: {
    type: Date,
    default: Date.now,
  },
});

const Comment = mongoose.model("Comment", commentSchema);
module.exports = { Comment };

 

2. 게시물 조회 기능 구현

• 게시물 조회 API를 구현하여, 특정 게시물과 그 게시물에 달린 댓글을 함께 불러오는 기능을 추가.
• 이를 위해 populate 메서드를 사용할 거임.
  
• populate 메서드는 어떤 컬렉션에서 ObjectId를 이용해서 다른 컬렉션의 정보를 담아 출력할 수 있음
• 자세한 설명

1) 게시물 조회 라우터

// getPost.js

const express = require("express");
const router = express.Router();
const { Post } = require("../../models/Post");

// 게시물 조회
router.get("/:id", async (req, res) => {
  const { id } = req.params;

  try {
    // 게시물과 댓글을 함께 불러오기 위해 populate 사용
    const post = await Post.findById(id).populate("comments");
    if (!post) {
      return res.status(404).json({ message: "게시물을 찾을 수 없습니다." });
    }
    return res.status(200).json({ post });
  } catch (error) {
    return res.status(500).json({
      message: "게시물 조회 중 오류가 발생했습니다.",
      error: error.message,
    });
  }
});

module.exports = router;

 

3. 게시물 조회 예시

• 위의 API를 호출하면, 게시물의 내용과 함께 댓글들이 포함된 결과를 얻을 수 있음. 

# 출력 예시

{
  "post": {
    "_id": "게시물 아이디",
    "user": "사용자 아이디",
    "text": "게시물 테스트",
    "images": ["<https://example.com/image1.jpg>"],
    "createdAt": "2024-11-02T06:59:29.107Z",  # 게시물 생성일 
    "comments": [
      {
        "_id": "댓글 아이디",
        "user": "사용자 아이디",
        "text": "첫 댓글입니다!",
        "createdAt": "2024-11-02T07:00:00.000Z"  # 댓글 생성일
      },
      {
        "_id": "댓글 아이디",
        "user": "사용자 아이디",
        "text": "두 번째 댓글입니다!",
        "createdAt": "2024-11-02T07:05:00.000Z"  # 댓글 생성일
      }
    ]
  }
}

 

4. 결과 🎉  

• 다음 포스트에서는 댓글 생성 기능에 대해 다뤄볼거임!!