[SpringBoot] 댓글 API 구현하기

댓글 api 구현하기

 

결과

 

---

엔티티(Entity)

> 파일명 : Coment.java

import jakarta.persistence.*;
import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;


@Getter
@Setter
@AllArgsConstructor
@NoArgsConstructor
@Entity
@Table(name = "noticeComment")
public class Comment {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    @ManyToOne(fetch = FetchType.LAZY)
    @JoinColumn(name = "notice_id")
    private NoticeEntity notice;

    private String userName;
    private String content;
}

 

import 문:

• 필요한 라이브러리 및 패키지를 가져옵니다.

@Getter, @Setter, @AllArgsConstructor, @NoArgsConstructor:

• Lombok 라이브러리의 어노테이션으로, 각각 필드에 대한 getter, setter 메서드를 자동 생성하고, 모든 필드를 인자로 받는 생성자와 인자 없는 생성자를 생성합니다.

@Entity:

• JPA(Entity Manager를 사용하는 Java ORM 기술)에서 엔티티임을 나타냅니다.

@Table(name = "noticeComment"):

• 데이터베이스에서 해당 엔티티를 매핑할 테이블의 이름을 지정합니다. 여기서는 "noticeComment" 테이블에 매핑됩니다.

@Id, @GeneratedValue(strategy = GenerationType.IDENTITY):

• 해당 필드가 엔티티의 주키(identity key)임을 나타냅니다. GenerationType.IDENTITY 전략은 데이터베이스에 의존하여 주키를 생성하는 방식입니다.

private Long id;:

• 댓글의 식별자를 나타내는 필드입니다.

@ManyToOne(fetch = FetchType.LAZY), @JoinColumn(name = "notice_id"):

• NoticeEntity와의 다대일(N:1) 관계를 나타냅니다. fetch = FetchType.LAZY는 연관된 엔티티를 지연로딩한다는 것을 의미합니다. @JoinColumn(name = "notice_id")는 외래 키를 지정합니다.

1. private NoticeEntity notice;:
   • 해당 댓글이 어떤 공지사항에 속하는지를 나타내는 필드입니다.
2. private String userName;:
   • 댓글을 작성한 사용자의 이름을 나타내는 필드입니다.
3. private String content;:
   • 댓글의 내용을 나타내는 필드입니다.

---

DTO

CommentDTO는 주로 컨트롤러나 서비스 계층에서 엔티티가 아닌 데이터를 전송하고 받을 때 사용됩니다. 이를 통해 엔티티의 정보를 클라이언트에 노출시키지 않고 필요한 정보만을 전달할 수 있습니다.

import lombok.Getter;
import lombok.Setter;

@Getter
@Setter
public class CommentDTO {
    private Long id; // 댓글의 식별자
    private String userName; // 댓글을 작성한 사용자 이름
    private String content; // 댓글 내용 
}

 

CommentDTO는 주로 컨트롤러나 서비스 계층에서 엔티티가 아닌 데이터를 전송하고 받을 때 사용됩니다. 이를 통해 엔티티의 정보를 클라이언트에 노출시키지 않고 필요한 정보만을 전달할 수 있습니다.

 

위의 CommentDTO를 사용하여 댓글 조회 시 DTO로 데이터를 반환할 수 있습니다. 아래는 서비스나 컨트롤러에서 CommentDTO를 사용하여 댓글을 조회하고 반환하는 코드 입니다.