Spring Boot CRUD API 구현 (1) - 요구사항 분석, 데이버테이스 설계, 도메인 설계

기본적인 게시판 API를 설계함에 앞서 요구사항을 분석하고 데이터베이스를 설계하고 도메인을 설계해봅시다.

---

요구사항

• 기본기능
• 회원 테이블에 등록된 사람만 게시글과 게시글의 댓글을 남길 수 있음.
• 회원 가입
  • 아이디는 특수문자를 제외한 4~20자리
  • 비밀번호는 8~16자 영문 대소문자, 숫자 특수문자를 반드시 포함
  • 닉네임은 특수문자 제외 2~10자리
  • 이메일은 이메일 형식을 갖추어야 함 (~~@naver.com) 
• 게시판
  • 기본적인 CRUD ( Create(생성), Read(조회), Update(수정), Delete(삭제) )
• 댓글
  • 게시판에 대한 기본적인 CRUD ( Create(생성), Read(조회), Update(수정), Delete(삭제) 

• 서브기능
  • Spring Security JWT 기술을 도입한 로그인 및 회원가입 ( 추후 추가예정 )
    • Oauth 2.0 소셜 로그인 기능 확장 : 별도 회원가입 없이 구글, 네이버, 카카오 아이디로 로그인
    • 댓글 및 게시글 업로드는 로그인한 사용자만 작성 가능
  • View 추가 ( 머스테치 )
  • 국제화 및 메시지 기능 
  • 게시판 조회수 기능 추가

데이터베이스 설계

Member

• member_id : Long (PK)
• username : String
• password : String
• nickname : String
• email : String 
• role : Enum Type (USER, ADMIN)

Board

• board_id : Long (PK)
• member_id : Long
• content : String
• title : String
• comments : List<String>

Comment

• comment_id : Long (PK)
• board_id : Long
• member_id : Long
• comment : String

BaseEntity

: Member, Board, Comment 테이블에서 공통으로 사용하는 엔티티로 등록일, 수정일을 포함. 실제로 데이터베이스에서 테이블로 등록하진 않음.

---

연관관계 매핑

1. 회원은 글을 여러 개 등록할 수 있습니다.

:  Member (1) ↔️  Board(多) : 일대다 관계 ( OneToMany )

:  Board(多) ↔️ Member : 다대일 관계 ( ManyToOne)

 

2. 글에는 댓글이 여러개 달릴 수 있습니다.

:  Board (1) ↔️  Comment (多) : 일대다 관계 ( OneToMany )

:  Comment(多) ↔️ Board : 다대일 관계 ( ManyToOne)

 

3. 회원은 댓글을 여러개 등록할 수 있습니다.

:  Member (1) ↔️ Comment(多) : 일대다 관계 ( OneToMany )

:  Comment(多) ↔️ Member : 다대일 관계 ( ManyToOne)

 

도메인 설계 및 테이블 매핑

Member

package dongwoongkim.crud.domain;

import dongwoongkim.crud.domain.base.BaseEntity;
import dongwoongkim.crud.dto.member.MemberEditRequestDto;
import dongwoongkim.crud.dto.member.MemberRequestDto;
import dongwoongkim.crud.repository.MemberRepository;
import lombok.AccessLevel;
import lombok.Getter;
import lombok.NoArgsConstructor;

import javax.persistence.*;
import java.util.ArrayList;
import java.util.List;

@Entity
@Getter
@NoArgsConstructor(access = AccessLevel.PROTECTED)
public class Member extends BaseEntity {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    @Column(name = "MEMBER_ID")
    private Long id;

    @Column(nullable = false)
    private String username;

    @Column(nullable = false)
    private String password;

    @Column(nullable = false)
    private String nickname;

    @Column(nullable = false)
    private String email;

    @Column(nullable = false)
    @Enumerated(EnumType.STRING)
    private MemberRole role;

    @OneToMany(mappedBy = "member", cascade = CascadeType.REMOVE)
    private List<Comment> comments = new ArrayList<>();

    @OneToMany(mappedBy = "member", cascade = CascadeType.REMOVE)
    private List<Board> boards = new ArrayList<>();

    public Member(MemberRequestDto memberRequestDto) {
        this.username = memberRequestDto.getUsername();
        this.password = memberRequestDto.getPassword();
        this.nickname = memberRequestDto.getNickname();
        this.email = memberRequestDto.getEmail();
        this.role = memberRequestDto.getRole();
    }

    public Member(String username, String password, String nickname, String email) {
        this.username = username;
        this.password = password;
        this.nickname = nickname;
        this.email = email;
    }

    public void updateMember(MemberEditRequestDto memberEditRequestDto) {
        this.password = memberEditRequestDto.getPassword();
        this.email = memberEditRequestDto.getEmail();
        this.nickname = memberEditRequestDto.getNickname();
    }

}

• @Entity : 실제 사용할 데이터베이스의 테이블과 매핑 ( @Table(name="member") 생략 시 자동으로 클래스 이름의 테이블과 매핑 )
• @OneToMany : 일대다 매핑 ( comment, board )
  • cascade = CascadeType.REMOVE 옵션 : 회원이 삭제될 때 해당 멤버의 PK를 FK로 가진 연관된 테이블의 컬럼들도 함께 삭제 하도록 설정 
• @Column(nullable = false) : 널 값 허용 X

MemberRole

package dongwoongkim.crud.domain;

import lombok.Getter;
import lombok.RequiredArgsConstructor;

@Getter
@RequiredArgsConstructor
public enum MemberRole {
    USER("USER"),
    ADMIN("ADMIN");
    private final String value;
}

• EnumType : ADMIN, USER

Board

package dongwoongkim.crud.domain;

import dongwoongkim.crud.domain.base.BaseEntity;
import dongwoongkim.crud.dto.board.BoardEditRequestDto;
import dongwoongkim.crud.dto.board.BoardRequestDto;
import lombok.AccessLevel;
import lombok.Getter;
import lombok.NoArgsConstructor;

import javax.persistence.*;
import java.util.ArrayList;
import java.util.List;

@Entity
@Getter
@NoArgsConstructor(access = AccessLevel.PROTECTED)
public class Board extends BaseEntity {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    @Column(name = "BOARD_ID")
    private Long id;

    @Column(nullable = false, length = 50)
    private String title;

    @Column(nullable = false)
    private String content;

    @ManyToOne(fetch = FetchType.LAZY)
    @JoinColumn(name = "MEMBER_ID")
    private Member member;

    @OneToMany(mappedBy = "board")
    @OrderBy("id asc")
    private List<Comment> comments = new ArrayList<>();

    public Board(String title, String content, Member member) {
        this.title = title;
        this.content = content;
        this.member = member;
    }

    public static Board toEntity(BoardRequestDto boardRequestDto) {
        return new Board(boardRequestDto.getTitle(), boardRequestDto.getContent(), boardRequestDto.getMember());
    }

    public void updateBoard(BoardEditRequestDto boardEditRequestDto) {
        this.title = boardEditRequestDto.getTitle();
        this.content = boardEditRequestDto.getContent();
    }
}

• @ManyToOne : 다대일 매핑 ( board -> member ) 
  • @JoinColumn(name="member_id") : 외래 키로 Member 테이블의 PK인 member_id 사용 
  • fetch = FetchType.LAZY : 지연로딩으로 설정하여 Member 엔티티 직접 사용 시 프록시로 실제 객체 호출
• @OneToMany : 일대 다 매핑 ( board -> comment )

Comment

package dongwoongkim.crud.domain;

import com.fasterxml.jackson.annotation.JsonIgnore;
import dongwoongkim.crud.domain.base.BaseEntity;
import dongwoongkim.crud.dto.comment.CommentRequestDto;
import lombok.AccessLevel;
import lombok.Getter;
import lombok.NoArgsConstructor;

import javax.persistence.*;

@Entity
@Getter
@NoArgsConstructor(access = AccessLevel.PROTECTED)
public class Comment extends BaseEntity {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    @Column(nullable = false)
    private String comment;

    @ManyToOne(fetch = FetchType.LAZY)
    @JoinColumn(name = "BOARD_ID")
    private Board board;

    @ManyToOne(fetch = FetchType.LAZY)
    @JoinColumn(name = "MEMBER_ID")
    private Member member;

    public Comment(String comment, Board board, Member member) {
        this.comment = comment;
        this.board = board;
        this.member = member;
    }

    public static Comment toEntity(CommentRequestDto commentRequestDto) {
        return new Comment(commentRequestDto.getComment(),commentRequestDto.getBoard(),commentRequestDto.getMember());
    }

    public void update(String comment) {
        this.comment = comment;
    }

}

• @ManyToOne : 다대일 매핑 ( Commnet -> Board )  
• @ManyToOne : 다대일 매핑 ( Comment -> Member)

~ToMany 는 지연로딩(LAZY)이 default로 설정되있지만, ~ToOne은 즉시로딩이 default로 설정되어 있기 떄문에
모두 fetch 타입을 LAZY로 설정해주었습니다.

BaseEntity

@EntityListeners(AuditingEntityListener.class)
@MappedSuperclass
@Getter
public class BaseEntity {

    @CreatedDate
    @Column(updatable = false)
    private LocalDateTime createdDate;

    @LastModifiedDate
    private LocalDateTime lastModified;

    @PreUpdate
    public void onPreUpdate() {
        this.lastModified = LocalDateTime.now();
    }

}

• 데이터베이스의 테이블로 직접 사용하지 않고 오로지 엔티티들에게 상속하기 위한 목적으로 만든 엔티티.
  • @Entity를 붙여주지 않았기 때문에 데이터베이스의 테이블과 매핑되지 않습니다.
• @CreatedDate : 데이터가 생성될 때 자동으로 현재 날짜 및 시간으로 생성되는 컬럼
• @LastModifiedDate : 데이터가 수정될때 자동으로 현재 날짜 및 시간으로 업데이트되는 컬럼