스프링부트 게시판 API 만들기 (7) - 도메인, 테이블 설계, 엔티티 생성

 

 

회원가입은, 도메인 설계가 끝나고 이후 회원 서비스를 구현할 때 구현하도록 하겠습니다!

 

 

• 시큐리티를 이용한 JSON 데이터로 로그인 (완료)
• JWT를 이용한 인증 (완료)
• 도메인, 테이블 설계, 엔티티 생성 (진행 중)
• 댓글 삭제 로직 구현
• 회원가입 + 정보수정 등 회원 서비스 구현
• 게시판 서비스 구현
• 댓글 서비스 구현 (1댓글 -> *(무한) 대댓글 구조)
• 예외 처리
• 예외 메세지 국제화
• 카테고리별 게시판 분류
• 게시글 페이징
• 동적인 검색 조건을 사용한 검색
• 사용자 간 쪽지 기능
• 무한 쪽지 스크롤
• 게시물 & 댓글에 대한 알람
• 쪽지에 대한 알람
• 접속한 사용자 간 실시간 채팅
• 회원가입 시 검증(예: XX대학교 XX과가 아니면 가입할 수 없게)
• Swagger를 사용한 API 문서 만들기
• 신고 & 블랙리스트 기능
• AOP를 통한 로그
• 어드민 페이지
• 캐시
• 배포 (+ 무중단 배포)
• 배포 자동화
• 포트와 어댑터 설계를 따르는 패키지 구조 설계하기
• ...

 

 

 

 

 

 

 

 

 

 

요구사항 분석하기

제가 만드려는 것은 "에브리타임" 같은 커뮤니티입니다.

이후 사용자 인증이라던가, 추가적인 기능 등이 추가될 수 있겠지만, 우선 가장 기본이 되는 기능부터 설계하고, 이후 기능을 추가하는 방식으로 개발을 진행하려 합니다.

 

정말 간단한 게시판을 만들 것입니다.

 

회원

• 회원가입
• 로그인
• 회원정보 수정
• 회원 탈퇴

 

게시글

• 비회원은 작성 불가능, 회원만 작성 가능
• 제목, 내용, 첨부파일을 올릴 수 있음
• 작성자는 게시물에 대한 수정과 삭제가 가능함
• 게시물을 삭제하면, 달려있는 댓글들이 일괄적으로 삭제됨
• 작성자가 회원탈퇴를 하면, 게시물도 삭제됨
• 게시물에는 댓글을 달 수 있음
• (익명 기능도 추가하고 싶지만.. 조금 미루도록 하겠습니다.)

 

 

댓글

• 게시글에 작성할 수 있음
• 첨부파일은 불가능하게 만들 것임
• 댓글은 대댓글을 가질 수 있으나. 대대댓글은 가질 수 없음
  • 즉, 최대 댓글의 깊이가 2임. 아래에서 좀 더 설명하겠습니다.
• 댓글은 수정과 삭제가 가능하지만, 삭제 시 대댓글이 존재하는 경우 대댓글은 삭제되지 않음.
  • 대댓글이 없는 경우에만 댓글이 완전히 삭제가 됨
  • 대댓글이 남아있는 경우에는 댓글은 "삭제된 댓글입니다" 표시, 대댓글은 그대로 달려있음
  • 그상태에서 대댓글이 모두 사라진다면 댓글 자체를 삭제함
  • 대댓글이 여러개 달려있는 상황에서  중간 대댓글을 지우면, 순서는 유지되고, "삭제된 댓글입니다" 라고 뜸

 

위와 같은 형식입니다.

 

 

 

 

 

 

 

 

 

 

도메인 설계

 

설계한 도메인을 기반으로 DB 테이블을 설계해 보겠습니다.

 

 

 

 

 

 

 

 

 

 

 

 

테이블 설계

 

 

 

 

 

사용한 사이트는 이곳입니다!

AQueryTool

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

엔티티 설계

이제 테이블의 정보를 가지고 엔티티를 구현해서 매핑해보겠습니다!

 

 

Member

@Table(name = "MEMBER")
@Getter
@NoArgsConstructor(access = AccessLevel.PROTECTED)
@Entity
@AllArgsConstructor
@Builder
public class Member extends BaseTimeEntity {

    @Id @GeneratedValue(strategy = IDENTITY)
    @Column(name = "member_id")
    private Long id; //primary Key

    @Column(nullable = false, length = 30, unique = true)
    private String username;//아이디

    private String password;//비밀번호

    @Column(nullable = false, length = 30)
    private String name;//이름(실명)

    @Column(nullable = false, length = 30)
    private String nickName;//별명

    @Column(nullable = false, length = 30)
    private Integer age;//나이

    @Enumerated(STRING)
    @Column(nullable = false, length = 30)
    private Role role;//권한 -> USER, ADMIN


    @Column(length = 1000)
    private String refreshToken;//RefreshToken


    //== 회원탈퇴 -> 작성한 게시물, 댓글 모두 삭제 ==//
    @OneToMany(mappedBy = "writer", cascade = ALL, orphanRemoval = true)
    private List<Post> postList = new ArrayList<>();

    @OneToMany(mappedBy = "writer", cascade = ALL, orphanRemoval = true)
    private List<Comment> commentList = new ArrayList<>();





    //== 연관관계 메서드 ==//
    public void addPost(Post post){
        //post의 writer 설정은 post에서 함
        postList.add(post);
    }

    public void addComment(Comment comment){
        //comment의 writer 설정은 comment에서 함
        commentList.add(comment);
    }





    



    //== 정보 수정 ==//
    public void updatePassword(PasswordEncoder passwordEncoder, String password){
        this.password = passwordEncoder.encode(password);
    }

    public void updateName(String name){
        this.name = name;
    }

    public void updateNickName(String nickName){
        this.nickName = nickName;
    }

    public void updateAge(int age){
        this.age = age;
    }

    public void updateRefreshToken(String refreshToken){
        this.refreshToken = refreshToken;
    }
    public void destroyRefreshToken(){
        this.refreshToken = null;
    }



    //== 패스워드 암호화 ==//
    public void encodePassword(PasswordEncoder passwordEncoder){
        this.password = passwordEncoder.encode(password);
    }

}

 

 

 

 

 

 

 

 

 

 

 

 

Post

import static javax.persistence.CascadeType.ALL;
import static javax.persistence.FetchType.*;
import static javax.persistence.GenerationType.IDENTITY;

@Table(name = "POST")
@Getter
@NoArgsConstructor(access = AccessLevel.PROTECTED)
@Entity
public class Post extends BaseTimeEntity {

    @Id @GeneratedValue(strategy = IDENTITY)
    @Column(name = "post_id")
    private Long id;


    @ManyToOne(fetch = LAZY)
    @JoinColumn(name = "writer_id")
    private Member writer;


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

    @Lob
    @Column(nullable = false)
    private String content;

    @Column(nullable = true)
    private String filePath;



    //== 게시글을 삭제하면 달려있는 댓글 모두 삭제 ==//
    @OneToMany(mappedBy = "post", cascade = ALL, orphanRemoval = true)
    private List<Comment> commentList = new ArrayList<>();




    //== 연관관계 편의 메서드 ==//
    public void confirmWriter(Member writer) {
        //writer는 변경이 불가능하므로 이렇게만 해주어도 될듯
        this.writer = writer;
        writer.addPost(this);
    }
    public void addComment(Comment comment){
        //comment의 Post 설정은 comment에서 함
        commentList.add(comment);
    }



    //== 내용 수정 ==//
    public void updateTitle(String title) {
        this.title = title;
    }

    public void updateContent(String content) {
        this.content = content;
    }

    public void updateFilePath(String filePath) {
        this.filePath = filePath;
    }
}

 

 

 

 

 

 

 

 

 

 

Comment

import static javax.persistence.FetchType.LAZY;

@Table(name="COMMENT")
@Getter
@NoArgsConstructor(access = AccessLevel.PROTECTED)
@Entity
public class Comment extends BaseTimeEntity {

    @Id @GeneratedValue
    @Column(name = "comment_id")
    private Long id;


    @ManyToOne(fetch = LAZY)
    @JoinColumn(name = "writer_id")
    private Member writer;


    @ManyToOne(fetch = LAZY)
    @JoinColumn(name = "post_id")
    private Post post;

    @ManyToOne(fetch = LAZY)
    @JoinColumn(name = "parent_id")
    private Comment parent;

    @Lob
    @Column(nullable = false)
    private String content;

    private boolean isRemoved= false;


    //== 부모 댓글을 삭제해도 자식 댓글은 남아있음 ==//
    @OneToMany(mappedBy = "parent")
    private List<Comment> childList = new ArrayList<>();




    //== 연관관계 편의 메서드 ==//
    public void confirmWriter(Member writer) {
        this.writer = writer;
        writer.addComment(this);
    }

    public void confirmPost(Post post) {
        this.post = post;
        post.addComment(this);
    }

    public void confirmParent(Comment parent){
        this.parent = parent;
        parent.addChild(this);
    }

    public void addChild(Comment child){
        childList.add(child);
    }




    //== 수정 ==//
    public void updateContent(String content) {
        this.content = content;
    }
    //== 삭제 ==//
    public void remove() {
        this.isRemoved = true;
    }



    @Builder
    public Comment( Member writer, Post post, Comment parent, String content) {
        this.writer = writer;
        this.post = post;
        this.parent = parent;
        this.content = content;
        this.isRemoved = false;
    }

}

 

 

 

 

 

 

 

 

 

 

 

 

 

확인

 

이렇게 기본적인 테이블 설계를 마쳤습니다. 

다음 포스팅에서는 엔티티에 구체적인 비즈니스 로직을 넣어볼까 합니다.

사실 제일 중요하게 생각하는건 댓글과 대댓글을 어떻게 구현할까 인데, 다음 포스팅에서 이어 진행하도록 하겠습니다.

 

 

 

 

 

 

전체 코드는 깃허브에서 확인하실 수 있습니다.

 

https://github.com/ShinDongHun1/SpringBoot-Board-API

GitHub - ShinDongHun1/SpringBoot-Board-API