feat(Comment) : 댓글 기능 추가 #102

chjcode · 2024-06-16T15:57:44Z

주요 기능

댓글 저장
댓글 수정
댓글 삭제
댓글 불러오기

계층형 댓글 구조란?

댓글 시스템에서 댓글과 대댓글이 계층적으로 연결되어 있는 형태를 의미

일기: 오늘은 옥수수랑 팝콘을 먹었다.
└─ 댓글 1: 둘 중에 뭐가 더 맛있나요?
   └─ 답글 1-1: 콘치즈요.
       └─ 답글 1-1-1: ^^;
└─ 댓글 2: 카라멜 팝콘 짱

어떻게 구현했나?

Adjacency List(인접 리스트)를 사용해서 구현.

부모 댓글을 가리키는 필드: 각 댓글이 부모 댓글을 참조하는 parentComment 필드를 통해 계층 구조를 형성
자식 댓글을 저장하는 필드: 부모 댓글이 여러 자식 댓글을 가질 수 있도록 childComments 리스트를 정의

댓글 entity 구성
id : primary key
diary_id : 일기 id
member_id : 댓글 작성자
content : 댓글 내용
parentComment : 부모 댓글
childComments : 자식 댓글 리스트
deleted : 삭제 여부 (true/false)
created_at : 댓글 생성 시간
updated_at : 댓글 수정 시간

댓글 저장

@Transactional
    public CommentResponseDTO save(Long diaryId, CommentSaveRequestDTO requestDTO, Long logInMemberId) {
        Member member = getMemberById(logInMemberId);
        Diary diary = getDiaryById(diaryId);
        Comment parentComment = getParentCommentById(requestDTO.parentCommentId());
        Comment comment = requestDTO.toEntity(member, diary, parentComment);
        commentDAO.save(comment);

        return CommentResponseDTO.from(comment);
    }

로그인 된 사용자의 정보를 바탕으로 댓글을 생성하고, 댓글이 달린 일기와 부모 댓글 정보를 포함하여 최종적으로 데이터베이스에 저장된 댓글 정보를 클라이언트에게 반환

댓글 수정

@Transactional
    public CommentResponseDTO update(Long CommentId, CommentUpdateRequestDTO requestDTO, Long logInMemberId) {
        Member member = getMemberById(logInMemberId);
        Comment comment = getCommentById(CommentId);
        validateCommentAuthor(member, comment);
        comment.update(requestDTO.content());

        return CommentResponseDTO.from(comment);
    }

로그인된 사용자의 정보를 바탕으로 수정하려는 댓글을 조회하고, 댓글 작성자인지 확인한 후 댓글 내용을 업데이트하여 최종적으로 클라이언트에게 반환

댓글 삭제

@Transactional
    public CommentDeleteResponseDTO delete(Long CommentId, Long logInMemberId) {
        Member member = getMemberById(logInMemberId);
        Comment comment = getCommentById(CommentId);
        validateCommentAuthor(member, comment);
        validateNotDeleted(comment);

        comment.delete();

        return CommentDeleteResponseDTO.from(comment);
    }

로그인된 사용자의 정보를 바탕으로 삭제하려는 댓글을 조회하고, 댓글 작성자인지 확인한 후 댓글을 삭제 상태로 변경하여 최종적으로 클라이언트에게 반환

일기: 오늘은 옥수수랑 팝콘을 먹었다.
└─ 댓글 1: 둘 중에 뭐가 더 맛있나요?
   └─ 답글 1-1: **삭제된 댓글입니다.**
       └─ 답글 1-1-1: ^^;
└─ 댓글 2: 카라멜 팝콘 짱

댓글이 삭제 되어도 해당 댓글에 대한 대댓글을 유지하기 위해, 실질적으로 삭제하지 않고 deleted라는 삭제 여부를 저장하는 컬럼을 둠.

public record CommentResponseDTO(
        Long memberId,
        String content,
        boolean deleted,
        String createdDate,
        String createdAt,
        List<CommentResponseDTO> childComments
) {
    public static CommentResponseDTO from(Comment comment) {
        return new CommentResponseDTO(
                comment.getMember().getId(),
                comment.getContent(),
                comment.isDeleted(),
                comment.getCreatedAt().format(DateTimeFormatter.ofPattern("yy년 MM월 dd일")),
                comment.getCreatedAt().format(DateTimeFormatter.ofPattern("HH:mm")),
                comment.getChildComments().stream().map(CommentResponseDTO::from).collect(Collectors.toList())
        );
    }

    public static CommentResponseDTO fromDeleted(Comment comment) {
        return new CommentResponseDTO(
                null,
                null,
                true,
                null,
                null,
                comment.getChildComments().stream().map(CommentResponseDTO::from).collect(Collectors.toList())
        );
    }
}

CommentResponseDTO에 fromDeleted 메서드를 추가하여 삭제된 상태일 때는 댓글에 대한 정보를 null값을 받아 반환하도록 함.

댓글 불러오기

@Transactional(readOnly = true)
    public List<CommentResponseDTO> findAll(Pageable pageable, Long diaryId) {
        Diary diary = getDiaryById(diaryId);
        List<Comment> comments = commentDAO.findAllByDiaryId(diaryId, pageable);

        List<Comment> hierarchicalComments = convertHierarchy(comments);

        return hierarchicalComments.stream()
                .map(this::mapToDTO)
                .collect(Collectors.toList());
    }

    private List<Comment> convertHierarchy(List<Comment> comments) {
        Map<Long, Comment> map = new HashMap<>();
        List<Comment> parentComments = new ArrayList<>();

        for (Comment comment : comments) {
            if (comment.getParentComment() != null) {
                // 부모 댓글이 있는 경우
                Comment parentComment = map.get(comment.getParentComment().getId());
                if (parentComment != null) {
                    parentComment.getChildComments().add(comment);
                }
            } else {
                // 부모 댓글이 없는 경우
                parentComments.add(comment);
            }
            map.put(comment.getId(), comment);
        }

        return parentComments;
    }

    private CommentResponseDTO mapToDTO(Comment comment) {
        if (comment.isDeleted()) {
            return CommentResponseDTO.fromDeleted(comment);
        }
        return CommentResponseDTO.from(comment);
    }

findAllByDiaryId로 db에서 부모 댓글이 null인 최상위 댓글을 먼저 오도록 정렬해서 데이터 가져옴
convertHierarchy를 이용하여 평면 구조로 조회된 댓글 리스트를 계층형 구조로 변환

HongYeseul

댓글 기능 PR 주신 것 확인하고 몇 가지의 사항을 리뷰 해보았습니다.
수고하셨습니다 👍

HongYeseul · 2024-06-18T04:18:26Z

src/main/java/chzzk/grassdiary/domain/comment/dto/CommentDeleteResponseDTO.java

+public record CommentDeleteResponseDTO(
+        boolean deleted
+) {
+    public static CommentDeleteResponseDTO from(Comment comment) {
+        return new CommentDeleteResponseDTO(
+                comment.isDeleted()
+        );
+    }
+}


코드 리뷰 중 deleteResponseDTO 클래스에 대해 ... ! 의견 남겨봅니다.
현재 구현된 내용을 보면서, 이 클래스가 반드시 필요한지에 대해 고민해 보았습니다.

해당 클래스에서 isDeleted만 들어가는 거라면 deleteResponseDTO 클래스 보다는 CommentResponseDTO를 사용하는 것이 코드의 단순화와 유지 보수 측면에서 조금 더 효율적일 수 있다는 생각이 듭니다.

프론트에서 응답을 받았을 때 isDeleted만 받았을 때는 어떤 댓글에 대한 삭제를 했는지를 나타낼 수 없지만, CommentResponseDTO를 사용하면 기존 코드를 재사용 하면서도 프론트에서 좀 더 자세하게 알아볼 수 있을 것 같아요.
어떻게 생각하시는지 궁금합니다!

불필요한 데이터 전송을 최소화하고자 따로 만들었는데, 유지 보수 측면을 생각해보면 CommentResponseDTO로 통일 시키는 것도 괜찮아 보이네요.
프론트에서 댓글을 삭제했을 때 CommentResponseDTO로 응답을 받아도 null값과 isDeleted의 true값만을 받아서 어떤 댓글에 대한 삭제를 했는지 알기는 어려울 것 같습니다. 그렇다면 CommentDeletedDTO를 활용하여 삭제된 댓글의 id값과 댓글 내용을 같이 보내주어 프론트측에서 어떤 댓글이 삭제되었는지 명확히 알 수 있도록 하는 방법도 괜찮아 보이는데 어떻게 생각하시는지 궁금합니다!

추가적으로, 예슬님 피드백을 보다보니 CommentResponseDTO에 CommentID값을 같이 보내주도록 추가하는 것이 필수적인 것 같습니다. 감사합니다!

CommentId가 없었군요? 추가 하는 것 좋습니다 👍👍

HongYeseul · 2024-06-18T04:23:59Z

src/main/java/chzzk/grassdiary/domain/comment/dto/CommentUpdateRequestDTO.java

+public record CommentUpdateRequestDTO(
+        String content
+) {
+}


해당 클래스도 deleteResponseDTO에 대한 동일한 의견 드립니다.

HongYeseul · 2024-06-18T04:28:20Z

src/main/java/chzzk/grassdiary/domain/comment/service/CommentService.java

+    }
+
+    @Transactional
+    public CommentResponseDTO update(Long CommentId, CommentUpdateRequestDTO requestDTO, Long logInMemberId) {


update와 delete 메서드에서 첫 번째 매개변수 CommentId에서 대문자로 시작하고 있어요! 다른 변수들과 동일하도록 commentId로 수정하면 좋을 것 같습니다.

헉 못보고 지나친 부분인데 짚어주셔서 감사합니다!

HongYeseul · 2024-06-18T04:41:32Z

src/main/java/chzzk/grassdiary/domain/comment/service/CommentService.java

+    @Transactional(readOnly = true)
+    public List<CommentResponseDTO> findAll(Pageable pageable, Long diaryId) {
+        Diary diary = getDiaryById(diaryId);
+        List<Comment> comments = commentDAO.findAllByDiaryId(diaryId, pageable);
+
+        List<Comment> hierarchicalComments = convertHierarchy(comments);
+
+        return hierarchicalComments.stream()
+                .map(this::mapToDTO)
+                .collect(Collectors.toList());
+    }


이 부분에서 mapToDTO를 CommentResponseDTO::from 으로 코드를 재사용 가능할 것 같아 보여요!

HongYeseul · 2024-06-18T04:51:20Z

src/main/java/chzzk/grassdiary/domain/comment/dto/CommentResponseDTO.java

+public record CommentResponseDTO(
+        // 멤버 정보(사진, 아이디), 댓글내용, 작성 시간
+        // todo: 사진정보 추가
+        Long memberId,
+        String content,
+        boolean deleted,
+        String createdDate,
+        String createdAt,
+        List<CommentResponseDTO> childComments
+) {
+    public static CommentResponseDTO from(Comment comment) {
+        return new CommentResponseDTO(
+                comment.getMember().getId(),
+                comment.getContent(),
+                comment.isDeleted(),
+                comment.getCreatedAt().format(DateTimeFormatter.ofPattern("yy년 MM월 dd일")),
+                comment.getCreatedAt().format(DateTimeFormatter.ofPattern("HH:mm")),
+                comment.getChildComments().stream().map(CommentResponseDTO::from).collect(Collectors.toList())
+        );
+    }
+
+    public static CommentResponseDTO fromDeleted(Comment comment) {
+        return new CommentResponseDTO(
+                null,
+                null,
+                true,
+                null,
+                null,
+                comment.getChildComments().stream().map(CommentResponseDTO::from).collect(Collectors.toList())
+        );
+    }


from 메서드와 fromDeleted 메서드를 합칠 수도 있을 것 같아요. isDeleted 값으로 반환 값이 달라지는 경우이니 if문을 사용해서 return 을 해주면 어떨까요? 그리고 모든 값을 null로 보내기 보다는 content 부분에 "삭제 된 댓글입니다."와 같은 멘트가 들어있으면 프론트에서 처리하기 더 좋을 것 같아요.
아래는 예시 로직입니다!

public static CommentResponseDTO from(Comment comment) { if (comment.isDeleted()) { return new CommentResponseDTO( null, "삭제된 댓글입니다.", true, null, null, comment.getChildComments().stream().map(CommentResponseDTO::from).collect(Collectors.toList()) ); } return new CommentResponseDTO(동일 코드); }

저도 이 부분에 대해서 많이 고민을 해봤는데, DTO가 데이터를 전송하기 위해 사용되는 객체인 만큼, 지워진 댓글인지를 판별하는 것은 서비스 영역에서 해야된다고 생각이 들어서 두 부분을 분리하기로 결정했던 기억이 납니다!
삭제된 댓글 여부는 말씀해주신대로 content에 적어서 보내주면 확실히 좀 더 명확할 것 같습니다! 감사합니다!

음 ... 그러네요 아니면... 생성하는 메서드 하나만 만든 다음에 서비스 클래스에서 null이 들어간 Comment와 값이 들어간 Comment를 전달하는 메서드를 만드는 건 어떨까요?

대략 이런 느낌일 것 같아요

CommentServiceClass () { ... is_deleted_판단하는_메서드(Comment comment) { if (comment.isDeleted()) { return CommentResponseDTO.fromDeleted(); } return CommentResponseDTO.from(); } }

요 메서드의 이름을 변경하자는 말씀인가요?

private CommentResponseDTO mapToDTO(Comment comment) { if (comment.isDeleted()) { return CommentResponseDTO.fromDeleted(comment); } return CommentResponseDTO.from(comment); }

HongYeseul · 2024-06-18T05:02:47Z

src/main/java/chzzk/grassdiary/domain/comment/service/CommentService.java

+    @Transactional(readOnly = true)
+    public List<CommentResponseDTO> findAll(Pageable pageable, Long diaryId) {
+        Diary diary = getDiaryById(diaryId);
+        List<Comment> comments = commentDAO.findAllByDiaryId(diaryId, pageable);


pageable을 사용하시는데, findAllByDiaryId보다는 findAllByDiaryIdWithPagination은 어떨까요?

댓글의 pageable과 같은 경우는 그냥 모두 불러오도록 List로 받도록 했는데, 파라미터를 미처 삭제하지 못했습니다 ㅋㅋㅋ ㅠㅠ
pageable을 사용해서 일정 개수만 불러오도록 하는게 좋을지 고민이 됩니다!

HongYeseul · 2024-06-18T05:10:37Z

src/main/java/chzzk/grassdiary/domain/comment/controller/CommentController.java

+    @GetMapping("/{diaryId}")
+    public List<CommentResponseDTO> findAll(
+            Pageable pageable,
+            @PathVariable(name = "diaryId") Long diaryId
+    ) {
+        return commentService.findAll(pageable, diaryId);
+    }


Pageable을 사용할 때 default 개수를 설정 해 주는 것은 어떨까요? 몇 개 정도가 적당하다고 생각히시는지 궁금해요. 5개 정도면 괜찮으려나요?

HongYeseul · 2024-06-18T05:12:13Z

src/main/java/chzzk/grassdiary/domain/diary/entity/Diary.java

+    @OneToMany(mappedBy = "diary")
+    private List<Comment> comments = new ArrayList<>();
+


다이어리 DB에 댓글을 넣는 이유가 있을까요?
해당 DB에 넣지 않아도 댓글 DB에 다이어리 id가 들어있으니 식별이 가능할 것 같아요.

HongYeseul · 2024-06-18T05:13:33Z

src/test/java/chzzk/grassdiary/domain/auth/jwt/JwtTokenProviderTest.java

음 ... 주석 처리된 이 클래스는 삭제해주시면 어떨까 합니다!
PR 내용은 댓글 기능 추가인데 해당 클래스가 들어있는 것도 PR 목적과 다른 클래스가 들어있는 것 같습니다.

chjcode added 13 commits May 25, 2024 15:33

feat(comment) : comment entity 생성

69e054c

feat(comment) : CommentRepository 생성

29654fa

feat(comment) : CommentRequestDTO 생성

7ebc771

feat(comment) : CommentSaveResponseDTO 구현

4a61d65

fix(comment) : commentRepository 오타 수정

45e74b9

feat(comment) : CommentRequestDTO -> CommentSaveRequestDTO로 이름변경

a6776ee

feat(comment) : comment save기능 service단 구현

8ec380e

feat(comment) : comment update기능 추가

30a420e

fix(comment) : CommentSaveResponseDTO -> CommentResponseDTO로 이름변경

1f0a6f9

feat(comment) : comment delete기능 추가

20d1d80

feat(Comment) : 댓글 조회 기능 추가

0afd4ed

fix (DeleteComment) : 불필요한 request요청 삭제, 삭제해도 false로 나오던 오류 수정

e6d5c33

fix(Comment) : 댓글 불러올 때 계층형 구조로 불러오도록 수정

20a85d5

HongYeseul changed the base branch from dev to style/package June 18, 2024 04:06

HongYeseul reviewed Jun 18, 2024

View reviewed changes

HongYeseul linked an issue Jun 21, 2024 that may be closed by this pull request

공유페이지 댓글 / 대댓글 기능 추가하기 #90

Open

chjcode added 2 commits June 21, 2024 22:13

fix (commentService) : CommentId -> commentId로 오타 수정

188404f

fix(comment) : CommentResponseDTO에 CommentID값을 같이 보내주도록 추가

a99498c

chjcode merged commit d92b29e into JECT-Study:style/package Jul 6, 2024

chjcode mentioned this pull request Sep 8, 2024

deleted = true 인 대댓글의 response오류 해결 #167

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(Comment) : 댓글 기능 추가 #102

feat(Comment) : 댓글 기능 추가 #102

chjcode commented Jun 16, 2024

HongYeseul left a comment

HongYeseul Jun 18, 2024

chjcode Jun 21, 2024

chjcode Jun 21, 2024

HongYeseul Jun 21, 2024

HongYeseul Jun 18, 2024

HongYeseul Jun 18, 2024

chjcode Jun 21, 2024

HongYeseul Jun 18, 2024

HongYeseul Jun 18, 2024

chjcode Jun 21, 2024

HongYeseul Jun 21, 2024

HongYeseul Jun 21, 2024

chjcode Jun 21, 2024 •

edited

Loading

HongYeseul Jun 18, 2024

chjcode Jul 6, 2024

HongYeseul Jun 18, 2024

HongYeseul Jun 18, 2024

HongYeseul Jun 18, 2024

		@OneToMany(mappedBy = "diary")
		private List<Comment> comments = new ArrayList<>();

feat(Comment) : 댓글 기능 추가 #102

feat(Comment) : 댓글 기능 추가 #102

Conversation

chjcode commented Jun 16, 2024

주요 기능

계층형 댓글 구조란?

어떻게 구현했나?

댓글 저장

댓글 수정

댓글 삭제

댓글 불러오기

HongYeseul left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chjcode Jun 21, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chjcode Jun 21, 2024 •

edited

Loading