reafactor(community): 코드 리뷰 사항 반영

ayoung-dev · ayoung-dev · commit 7a081f83cc3a · 2024-12-03T00:20:48.000+09:00
- to -&gt; toEntity 변수명 변경
- ResponseDto 스웨거 적용
diff --git a/src/main/java/com/somemore/community/dto/request/CommunityBoardCreateRequestDto.java b/src/main/java/com/somemore/community/dto/request/CommunityBoardCreateRequestDto.java
@@ -19,7 +19,7 @@ public record CommunityBoardCreateRequestDto(
         @NotBlank(message = "게시글 내용은 필수 값입니다.")
         String content
 ) {
-    public CommunityBoard to(UUID writerId, String imgUrl) {
+    public CommunityBoard toEntity(UUID writerId, String imgUrl) {
         return CommunityBoard.builder()
                 .writerId(writerId)
                 .title(title)
diff --git a/src/main/java/com/somemore/community/dto/request/CommunityCommentCreateRequestDto.java b/src/main/java/com/somemore/community/dto/request/CommunityCommentCreateRequestDto.java
@@ -24,7 +24,7 @@ public record CommunityCommentCreateRequestDto(
         @Nullable
         Long parentCommentId
 ) {
-    public CommunityComment to(UUID writerId) {
+    public CommunityComment toEntity(UUID writerId) {
         return CommunityComment.builder()
                 .communityBoardId(communityBoardId)
                 .writerId(writerId)
diff --git a/src/main/java/com/somemore/community/dto/response/CommunityBoardDetailResponseDto.java b/src/main/java/com/somemore/community/dto/response/CommunityBoardDetailResponseDto.java
@@ -3,18 +3,27 @@
 import com.fasterxml.jackson.databind.PropertyNamingStrategies;
 import com.fasterxml.jackson.databind.annotation.JsonNaming;
 import com.somemore.community.domain.CommunityBoard;
+import io.swagger.v3.oas.annotations.media.Schema;
 
 import java.time.LocalDateTime;
 import java.util.UUID;
 
 @JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)
+@Schema(description = "커뮤니티 게시글 상세 조회 응답 DTO")
 public record CommunityBoardDetailResponseDto(
+        @Schema(description = "커뮤니티 게시글 ID", example = "12")
         Long id,
+        @Schema(description = "작성자(봉사자) ID", example = "123e4567-e89b-12d3-a456-426614174000")
         UUID writerId,
+        @Schema(description = "커뮤니티 게시글 제목", example = "11/29 OO도서관 봉사 같이 갈 사람 모집합니다.")
         String title,
+        @Schema(description = "커뮤니티 게시글 내용", example = "저 포함 5명이 같이 가면 좋을 거 같아요")
         String content,
+        @Schema(description = "이미지 URL", example = "https://image.domain.com/links")
         String imageUrl,
+        @Schema(description = "커뮤니티 게시글 생성 일시", example = "2023-12-02T11:00:00")
         LocalDateTime createdAt,
+        @Schema(description = "커뮤니티 게시글 수정 일시", example = "2023-12-02T11:00:00")
         LocalDateTime updatedAt
 ) {
     public static CommunityBoardDetailResponseDto from(CommunityBoard board) {
diff --git a/src/main/java/com/somemore/community/dto/response/CommunityBoardResponseDto.java b/src/main/java/com/somemore/community/dto/response/CommunityBoardResponseDto.java
@@ -3,14 +3,20 @@
 import com.fasterxml.jackson.databind.PropertyNamingStrategies.SnakeCaseStrategy;
 import com.fasterxml.jackson.databind.annotation.JsonNaming;
 import com.somemore.community.repository.mapper.CommunityBoardView;
+import io.swagger.v3.oas.annotations.media.Schema;
 
 import java.time.LocalDateTime;
 
 @JsonNaming(SnakeCaseStrategy.class)
+@Schema(description = "커뮤니티 게시글 목록 조회 응답 DTO")
 public record CommunityBoardResponseDto(
+        @Schema(description = "커뮤니티 게시글 ID", example = "12")
         Long id,
+        @Schema(description = "커뮤니티 게시글 ID", example = "12")
         String title,
+        @Schema(description = "작성자(봉사자) ID", example = "123e4567-e89b-12d3-a456-426614174000")
         String writerNickname,
+        @Schema(description = "커뮤니티 게시글 생성 일시", example = "2023-12-02T11:00:00")
         LocalDateTime createdAt
 ) {
     public static CommunityBoardResponseDto from(CommunityBoardView board) {
diff --git a/src/main/java/com/somemore/community/dto/response/CommunityCommentResponseDto.java b/src/main/java/com/somemore/community/dto/response/CommunityCommentResponseDto.java
@@ -3,17 +3,33 @@
 import com.fasterxml.jackson.databind.PropertyNamingStrategies;
 import com.fasterxml.jackson.databind.annotation.JsonNaming;
 import com.somemore.community.repository.mapper.CommunityCommentView;
+import io.swagger.v3.oas.annotations.media.Schema;
 
 import java.time.LocalDateTime;
 import java.util.ArrayList;
 import java.util.List;
 
 @JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)
 public record CommunityCommentResponseDto(
+        @Schema(description = "커뮤니티 댓글 ID", example = "1234")
         Long id,
+        @Schema(description = "작성자(봉사자) 닉네임", example = "dkdudab")
         String writerNickname,
+        @Schema(description = "커뮤니티 댓글 내용", example = "저도 함께 하고 싶습니다.")
         String content,
+        @Schema(description = "커뮤니티 댓글 수정 일시", example = "2023-12-02T11:00:00")
         LocalDateTime updatedAt,
+        @Schema(description = "대댓글 목록", example = """
+    [
+        {
+            "id": 3,
+            "content": "첫 번째 댓글의 답글입니다.",
+            "writerNickname": "사용자2",
+            "createdAt": "2023-12-02T11:00:00",
+            "replies": []
+        }
+    ]
+""")
         List<CommunityCommentResponseDto> replies
 ) {
     public CommunityCommentResponseDto {
diff --git a/src/main/java/com/somemore/community/service/board/CreateCommunityBoardService.java b/src/main/java/com/somemore/community/service/board/CreateCommunityBoardService.java
@@ -20,7 +20,7 @@ public class CreateCommunityBoardService implements CreateCommunityBoardUseCase
     @Override
     public Long createCommunityBoard(CommunityBoardCreateRequestDto requestDto, UUID writerId, String imgUrl) {
 
-        CommunityBoard communityBoard = requestDto.to(writerId, imgUrl == null ? "" : imgUrl);
+        CommunityBoard communityBoard = requestDto.toEntity(writerId, imgUrl == null ? "" : imgUrl);
 
         communityBoardRepository.save(communityBoard);
 
diff --git a/src/main/java/com/somemore/community/service/comment/CreateCommunityCommentService.java b/src/main/java/com/somemore/community/service/comment/CreateCommunityCommentService.java
@@ -25,7 +25,7 @@ public class CreateCommunityCommentService implements CreateCommunityCommentUseC
 
     @Override
     public Long createCommunityComment(CommunityCommentCreateRequestDto requestDto, UUID writerId) {
-        CommunityComment communityComment = requestDto.to(writerId);
+        CommunityComment communityComment = requestDto.toEntity(writerId);
 
         validateCommunityBoardExists(communityComment.getCommunityBoardId());
 
diff --git a/src/test/java/com/somemore/community/service/comment/CreateCommunityCommentServiceTest.java b/src/test/java/com/somemore/community/service/comment/CreateCommunityCommentServiceTest.java
@@ -44,7 +44,7 @@ void setUp() {
 
         writerId = UUID.randomUUID();
 
-        CommunityBoard communityBoard = communityBoardRepository.save(boardDto.to(writerId, "https://test.image/123"));
+        CommunityBoard communityBoard = communityBoardRepository.save(boardDto.toEntity(writerId, "https://test.image/123"));
         boardId = communityBoard.getId();
     }
 
diff --git a/src/test/java/com/somemore/community/service/comment/DeleteCommunityCommentServiceTest.java b/src/test/java/com/somemore/community/service/comment/DeleteCommunityCommentServiceTest.java
@@ -43,15 +43,15 @@ void setUp() {
 
         writerId = UUID.randomUUID();
 
-        CommunityBoard communityBoard = communityBoardRepository.save(boardDto.to(writerId, "https://test.image/123"));
+        CommunityBoard communityBoard = communityBoardRepository.save(boardDto.toEntity(writerId, "https://test.image/123"));
 
         CommunityCommentCreateRequestDto dto = CommunityCommentCreateRequestDto.builder()
                 .communityBoardId(communityBoard.getId())
                 .content("커뮤니티 댓글 테스트 내용")
                 .parentCommentId(null)
                 .build();
 
-        CommunityComment communityComment = communityCommentRepository.save(dto.to(writerId));
+        CommunityComment communityComment = communityCommentRepository.save(dto.toEntity(writerId));
 
         commentId = communityComment.getId();}
 
diff --git a/src/test/java/com/somemore/community/service/comment/UpdateCommunityCommentServiceTest.java b/src/test/java/com/somemore/community/service/comment/UpdateCommunityCommentServiceTest.java
@@ -46,15 +46,15 @@ void setUp() {
 
         writerId = UUID.randomUUID();
 
-        CommunityBoard communityBoard = communityBoardRepository.save(boardDto.to(writerId, "https://test.image/123"));
+        CommunityBoard communityBoard = communityBoardRepository.save(boardDto.toEntity(writerId, "https://test.image/123"));
 
         CommunityCommentCreateRequestDto commentDto = CommunityCommentCreateRequestDto.builder()
                 .communityBoardId(communityBoard.getId())
                 .content("커뮤니티 댓글 테스트 내용")
                 .parentCommentId(null)
                 .build();
 
-        CommunityComment communityComment = communityCommentRepository.save(commentDto.to(writerId));
+        CommunityComment communityComment = communityCommentRepository.save(commentDto.toEntity(writerId));
 
         commentId = communityComment.getId();
 

Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ void setUp() {`
`44`	`44`
`45`	`45`	`writerId = UUID.randomUUID();`
`46`	`46`
`47`		`- CommunityBoard communityBoard = communityBoardRepository.save(boardDto.to(writerId, "https://test.image/123"));`
	`47`	`+ CommunityBoard communityBoard = communityBoardRepository.save(boardDto.toEntity(writerId, "https://test.image/123"));`
`48`	`48`	`boardId = communityBoard.getId();`
`49`	`49`	`}`
`50`	`50`