스프링부트 게시판 API 만들기 (8) - 댓글 삭제 로직 구현

사실 순서상으로는 회원 -> 게시판 -> 댓글 순서로 구현하는게 맞으나, 제가 너무 댓글을 구현해보고 싶은 마음이 커서 댓글부터 구현하도록 하겠습니다.

다른거 구현하고 오셔서 봐도 괜찮습니다.

 

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

 

 

 

 

 

 

 

 

 

 

 

댓글의 로직

댓글은 저번에도 설명드렸듯이 다음의 구조를 가지고 있습니다.

 

구현은 어렵지 않아보이나, 삭제 시 댓글을 어떻게 처리할지가 조금 막막합니다.

 

저는 "에브리타임"의 게시판 구조를 따를 것이므로, 댓글 삭제 시 발생할 수 있는 상황과 그에 따른 로직을 적어보겠습니다.

 

 

 

 

• 댓글을 삭제하는 경우
  1. 삭제하는 댓글이 댓글인 경우(부모)
     1. 대댓글이 남아있는 경우 : 댓글은 내용이 지워지나, DB에와 화면에서는 지워지지 않고, "삭제된 댓글입니다"라고 표시
     2. 대댓글이 아예 존재하지 않는 경우 : 곧바로 DB에서 삭제
     3. 대댓글이 존재하나 모두 삭제된 대댓글인 경우 : 댓글과, 달려있는 대댓글 모두 DB에서 일괄 삭제, 화면상에도 표시되지 않음
  2. 삭제하는 댓글이 대댓글인 경우(자식)
     1. 대댓글의 부모댓글이 남아있는 경우 : 대댓글만 삭제, 그러나 DB에서 완전히 지워지지는 않고, 화면상에는 "삭제된 댓글입니다" 라고만 표시
     2. 대댓글의 부모댓글이 삭제된 댓글인 경우 
        1. 현재 지운 대댓글로 인해, 부모에 달려있는 대댓글이 모두 삭제된 경우 -> 부모를 포함한 모든 대댓글을 DB에서 일괄 삭제, 화면상에서도 지움
        2. 다른 대댓글이 아직 삭제되지 않고 남아있는 경우 -> 해당 대댓글만 삭제, 그러나 DB에서 삭제되지는 않고, 화면상에는 "삭제된 댓글입니다"라고 표시

 

 

 

 

 

 

 

 

 

 

 

 

최종 완성본

Comment의 위치입니다.

Comment

다음 코드가 추가되었습니다.

//== 비즈니스 로직 ==//
public List<Comment> findRemovableList() {

    List<Comment> result = new ArrayList<>();

    Optional.ofNullable(this.parent).ifPresentOrElse(

            parentComment ->{//대댓글인 경우 (부모가 존재하는 경우)
                if( parentComment.isRemoved()&& parentComment.isAllChildRemoved()){
                    result.addAll(parentComment.getChildList());
                    result.add(parentComment);
                }
            },

            () -> {//댓글인 경우
                if (isAllChildRemoved()) {
                    result.add(this);
                    result.addAll(this.getChildList());
                }
            }
    );

    return result;
}


//모든 자식 댓글이 삭제되었는지 판단
private boolean isAllChildRemoved() {
    return getChildList().stream()//https://kim-jong-hyun.tistory.com/110 킹종현님 사랑합니다.
            .map(Comment::isRemoved)//지워졌는지 여부로 바꾼다
            .filter(isRemove -> !isRemove)//지워졌으면 true, 안지워졌으면 false이다. 따라서 filter에 걸러지는 것은 false인 녀석들이고, 있다면 false를 없다면 orElse를 통해 true를 반환한다.
            .findAny()//지워지지 않은게 하나라도 있다면 false를 반환
            .orElse(true);//모두 지워졌다면 true를 반환

}

 

 

 

 

 

 

 

 

 

 

 

 

전체 코드는 다음과 같습니다

@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;
    }


    //== 비즈니스 로직 ==//
    public List<Comment> findRemovableList() {

        List<Comment> result = new ArrayList<>();

        Optional.ofNullable(this.parent).ifPresentOrElse(

                parentComment ->{//대댓글인 경우 (부모가 존재하는 경우)
                    if( parentComment.isRemoved()&& parentComment.isAllChildRemoved()){
                        result.addAll(parentComment.getChildList());
                        result.add(parentComment);
                    }
                },

                () -> {//댓글인 경우
                    if (isAllChildRemoved()) {
                        result.add(this);
                        result.addAll(this.getChildList());
                    }
                }
        );

        return result;
    }


    //모든 자식 댓글이 삭제되었는지 판단
    private boolean isAllChildRemoved() {
        return getChildList().stream()//https://kim-jong-hyun.tistory.com/110 킹종현님 사랑합니다.
                .map(Comment::isRemoved)//지워졌는지 여부로 바꾼다
                .filter(isRemove -> !isRemove)//지워졌으면 true, 안지워졌으면 false이다. 따라서 filter에 걸러지는 것은 false인 녀석들이고, 있다면 false를 없다면 orElse를 통해 true를 반환한다.
                .findAny()//지워지지 않은게 하나라도 있다면 false를 반환
                .orElse(true);//모두 지워졌다면 true를 반환

    }



}

 

 

 

 

 

 

 

 

 

 

 

 

 

 

CommentRepository

public interface CommentRepository extends JpaRepository<Comment, Long> {
}

 

 

 

 

 

 

 

 

 

 

 

CommentService

public interface CommentService {

    void save(Comment comment);

    Comment findById(Long id) throws Exception;


    List<Comment> findAll();

    void remove(Long id) throws Exception;
}

 

 

 

 

 

 

 

 

 

 

 

 

 

CommentServiceImpl

@Service
@RequiredArgsConstructor
@Transactional
public class CommentServiceImpl implements CommentService{

    private final CommentRepository commentRepository;


    @Override
    public void save(Comment comment) {

        commentRepository.save(comment);
    }

    @Override
    @Transactional(readOnly = true)
    public Comment findById(Long id) throws Exception {
        return commentRepository.findById(id).orElseThrow(() -> new Exception("댓글이 없습니다."));
    }

    @Override
    @Transactional(readOnly = true)
    public List<Comment> findAll() {
        return commentRepository.findAll();
    }



    @Override
    public void remove(Long id) throws Exception {
        Comment comment = commentRepository.findById(id).orElseThrow(() -> new Exception("댓글이 없습니다."));
        comment.remove();
        List<Comment> removableCommentList = comment.findRemovableList();
        removableCommentList.forEach(removableComment -> commentRepository.delete(removableComment));
    }
}

 

 

 

 

 

 

 

 

 

 

 

 

 

전체 테스트코드

@SpringBootTest
@Transactional
class CommentServiceTest {


    @Autowired
    CommentService commentService;

    @Autowired CommentRepository commentRepository;

    @Autowired EntityManager em;

    private void clear(){
        em.flush();
        em.clear();
    }


    private Long saveComment(){
        Comment comment = Comment.builder().content("댓글").build();
        Long id = commentRepository.save(comment).getId();
        clear();
        return id;
    }

    private Long saveReComment(Long parentId){
        Comment parent = commentRepository.findById(parentId).orElse(null);
        Comment comment = Comment.builder().content("댓글").parent(parent).build();

        Long id = commentRepository.save(comment).getId();
        clear();

        return id;
    }


    // 댓글을 삭제하는 경우
    // 대댓글이 남아있는 경우
    // DB와 화면에서는 지워지지 않고, "삭제된 댓글입니다"라고 표시
    @Test
    public void 댓글삭제_대댓글이_남아있는_경우() throws Exception {
        //given
        Long commentId = saveComment();
        saveReComment(commentId);
        saveReComment(commentId);
        saveReComment(commentId);
        saveReComment(commentId);

        Assertions.assertThat(commentService.findById(commentId).getChildList().size()).isEqualTo(4);

        //when
        commentService.remove(commentId);
        clear();


        //then
        Comment findComment = commentService.findById(commentId);
        assertThat(findComment).isNotNull();
        assertThat(findComment.isRemoved()).isTrue();
        assertThat(findComment.getChildList().size()).isEqualTo(4);
    }




    // 댓글을 삭제하는 경우
    //대댓글이 아예 존재하지 않는 경우 : 곧바로 DB에서 삭제
    @Test
    public void 댓글삭제_대댓글이_없는_경우() throws Exception {
        //given
        Long commentId = saveComment();

        //when
        commentService.remove(commentId);
        clear();

        //then
        Assertions.assertThat(commentService.findAll().size()).isSameAs(0);
        assertThat( assertThrows(Exception.class, () -> commentService.findById(commentId)).getMessage()).isEqualTo("댓글이 없습니다.");
    }




    // 댓글을 삭제하는 경우
    // 대댓글이 존재하나 모두 삭제된 경우
    //댓글과, 달려있는 대댓글 모두 DB에서 일괄 삭제, 화면상에도 표시되지 않음
    @Test
    public void 댓글삭제_대댓글이_존재하나_모두_삭제된_대댓글인_경우() throws Exception {
        //given
        Long commentId = saveComment();
        Long reCommend1Id = saveReComment(commentId);
        Long reCommend2Id = saveReComment(commentId);
        Long reCommend3Id = saveReComment(commentId);
        Long reCommend4Id = saveReComment(commentId);


        Assertions.assertThat(commentService.findById(commentId).getChildList().size()).isEqualTo(4);
        clear();

        commentService.remove(reCommend1Id);
        clear();

        commentService.remove(reCommend2Id);
        clear();

        commentService.remove(reCommend3Id);
        clear();

        commentService.remove(reCommend4Id);
        clear();

        Assertions.assertThat(commentService.findById(reCommend1Id).isRemoved()).isTrue();
        Assertions.assertThat(commentService.findById(reCommend2Id).isRemoved()).isTrue();
        Assertions.assertThat(commentService.findById(reCommend3Id).isRemoved()).isTrue();
        Assertions.assertThat(commentService.findById(reCommend4Id).isRemoved()).isTrue();
        clear();


        //when
        commentService.remove(commentId);
        clear();


        //then
        LongStream.rangeClosed(commentId, reCommend4Id).forEach(id ->
                    assertThat(assertThrows(Exception.class, () -> commentService.findById(id)).getMessage()).isEqualTo("댓글이 없습니다.")
        );

    }





    // 대댓글을 삭제하는 경우
    // 부모 댓글이 삭제되지 않은 경우
    // 내용만 삭제, DB에서는 삭제 X
    @Test
    public void 대댓글삭제_부모댓글이_남아있는_경우() throws Exception {
        //given
        Long commentId = saveComment();
        Long reCommend1Id = saveReComment(commentId);


        //when
        commentService.remove(reCommend1Id);
        clear();


        //then
        Assertions.assertThat(commentService.findById(commentId)).isNotNull();
        Assertions.assertThat(commentService.findById(reCommend1Id)).isNotNull();
        Assertions.assertThat(commentService.findById(commentId).isRemoved()).isFalse();
        Assertions.assertThat(commentService.findById(reCommend1Id).isRemoved()).isTrue();
    }



    // 대댓글을 삭제하는 경우
    // 부모 댓글이 삭제되어있고, 대댓글들도 모두 삭제된 경우
    // 부모를 포함한 모든 대댓글을 DB에서 일괄 삭제, 화면상에서도 지움
    @Test
    public void 대댓글삭제_부모댓글이_삭제된_경우_모든_대댓글이_삭제된_경우() throws Exception {
        //given
        Long commentId = saveComment();
        Long reCommend1Id = saveReComment(commentId);
        Long reCommend2Id = saveReComment(commentId);
        Long reCommend3Id = saveReComment(commentId);


        commentService.remove(reCommend2Id);
        clear();
        commentService.remove(commentId);
        clear();
        commentService.remove(reCommend3Id);
        clear();


        Assertions.assertThat(commentService.findById(commentId)).isNotNull();
        Assertions.assertThat(commentService.findById(commentId).getChildList().size()).isEqualTo(3);

        //when
        commentService.remove(reCommend1Id);



        //then
        LongStream.rangeClosed(commentId, reCommend3Id).forEach(id ->
                assertThat(assertThrows(Exception.class, () -> commentService.findById(id)).getMessage()).isEqualTo("댓글이 없습니다.")
        );



    }


    // 대댓글을 삭제하는 경우
    // 부모 댓글이 삭제되어있고, 다른 대댓글이 아직 삭제되지 않고 남아있는 경우
    //해당 대댓글만 삭제, 그러나 DB에서 삭제되지는 않고, 화면상에는 "삭제된 댓글입니다"라고 표시
    @Test
    public void 대댓글삭제_부모댓글이_삭제된_경우_다른_대댓글이_남아있는_경우() throws Exception {
        //given
        Long commentId = saveComment();
        Long reCommend1Id = saveReComment(commentId);
        Long reCommend2Id = saveReComment(commentId);
        Long reCommend3Id = saveReComment(commentId);


        commentService.remove(reCommend3Id);
        commentService.remove(commentId);
        clear();

        Assertions.assertThat(commentService.findById(commentId)).isNotNull();
        Assertions.assertThat(commentService.findById(commentId).getChildList().size()).isEqualTo(3);


        //when
        commentService.remove(reCommend2Id);
        Assertions.assertThat(commentService.findById(commentId)).isNotNull();


        //then
        Assertions.assertThat(commentService.findById(reCommend2Id)).isNotNull();
        Assertions.assertThat(commentService.findById(reCommend2Id).isRemoved()).isTrue();
        Assertions.assertThat(commentService.findById(reCommend1Id).getId()).isNotNull();
        Assertions.assertThat(commentService.findById(reCommend3Id).getId()).isNotNull();
        Assertions.assertThat(commentService.findById(commentId).getId()).isNotNull();

    }

}

 

 

 

 

 

 

이렇게 지금까지 생각만 하고, 한번도 구현해 본 적 없는 댓글 삭제 로직을 구현해 보았습니다.

다음 시간에는 회원 서비스, 게시글, 댓글 서비스 모두 구현해보도록 하겠습니다.

 

 

 

 

 

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

 

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

GitHub - ShinDongHun1/SpringBoot-Board-API