[Refactor]: 커뮤니티 게시글 생성 API 코드 리팩토링 #560

dev-Crayon · 2024-11-28T12:57:40Z

🐬 요약

커뮤니티 게시글 생성 API 코드 리팩토링을 진행했습니다.
하위 도메인인 익명 게시글 프로필 코드를 따로 분리하고 Retriever, Modifier를 이용하여 중복 코드를 방지했습니다.

👻 유형

PR의 유형에 맞게 체크해주세요!

🍀 작업 내용

PR에 담긴 작업 내용을 작성해주세요!

작업 1
작업 2
작업 3

🌟 관련 이슈

PR과 관련된 이슈 번호를 작성해주세요!

close: #559

PostSaveRequest로 받는 데이터 validation 추가 Related to: #559

repository/community -> community/repository 폴더로 이동 Related to: #559

community domain 패키지로 이동 validation 필요한 필드 추가 Related to: #559

Related to: #559

import문 변경있음 Related to: #559

Service 계층에 밀집된 비즈니스 로직 분리 하위 도메인 정의 및 코드 분리 Related to: #559

Related to: #559

CommunityController.java에 있는 val 삭제 Related to: #559

Related to: #559

height · 2024-11-28T12:57:43Z

Link Height tasks by mentioning a task ID in the pull request title or commit messages, or description and comments with the keyword link (e.g. "Link T-123").

💡Tip: You can also use "Close T-X" to automatically close a task when the pull request is merged.

Related to: #559

jun02160

작업량이 꽤 많았을텐데 테스트코드까지 꼼꼼하게 작업해주셔서 감사합니다!

jun02160 · 2024-11-30T15:08:48Z

src/main/java/org/sopt/makers/internal/community/controller/CommunityController.java

@@ -97,10 +98,12 @@ public ResponseEntity<Map<String, Boolean>> upPostHit(
    @PostMapping("/posts")
    public ResponseEntity<PostSaveResponse> createPost(
            @Parameter(hidden = true) @AuthenticationPrincipal InternalMemberDetails memberDetails,
-            @RequestBody PostSaveRequest request
+            @RequestBody @Valid PostSaveRequest request


요거 @Valid가 앞쪽에 와야 제대로 동작할 것 같습니다!

제가 알기로는 @Valid 위치는 상관없이 동작하는 것으로 알고 있습니다.
해당 어노테이션 테스트도 해본 상태입니다!

jun02160 · 2024-11-30T15:11:49Z

src/main/java/org/sopt/makers/internal/community/controller/dto/request/PostSaveRequest.java

+import javax.validation.constraints.NotBlank;
+import javax.validation.constraints.NotNull;
+
+public record PostSaveRequest(


Spring Validator 쓸 때 메시지도 같이 작성해주면 좋을 것 같아요!!

fyi. 다른 도메인의 Request Dto

sopt-playground-backend/src/main/java/org/sopt/makers/internal/member/controller/coffeechat/dto/request/CoffeeChatRequest.java

Lines 16 to 17 in 2d3bd79

@NotNull(message = "수신자 정보는 필수 입력 값입니다.")

Long receiverId,

좋은 의견 감사합니다! 바로 반영하겠습니다.

jun02160 · 2024-11-30T15:17:04Z

src/main/java/org/sopt/makers/internal/community/domain/CommunityPost.java

현재 prod 테이블에도 not null 컬럼들 반영이 필요할 것 같아요! (혹시 null인 데이터가 있다면 백필이 필요할 것 같구요)

이 부분은 해당 PR에 달린 코드리뷰 반영이 다 되고 같이 진행하면 좋을 것 같습니다!

jun02160 · 2024-11-30T15:22:44Z

src/main/java/org/sopt/makers/internal/community/domain/anonymous/AnonymousNickname.java


 @Entity
 @Getter
+@Builder


Builder는 클래스 전역에 선언했을 때, id값의 변경도 허용되기 때문에 클래스 내부에서 최소한의 변경되는 범위에만 사용하는 게 좋을 것 같습니다!

AnonymousNickname.builder().id(id).build(); >> 가 가능해짐

그래서 되도록이면 @AllArgsConstructor 도 private으로 제한하거나 아예 사용하지 않고, 필요한 필드들만 생성자 정의를 해주는 게 좋아보입니다! (e.g. MemberBlock 처럼 통일하면 좋을 것 같습니닷 ㅎㅎ)

jun02160 · 2024-11-30T15:27:01Z

src/main/java/org/sopt/makers/internal/community/domain/anonymous/AnonymousProfileImage.java

+@Builder
+@NoArgsConstructor(access = AccessLevel.PROTECTED)
+@AllArgsConstructor(access = AccessLevel.PROTECTED)


여기도 위와 동일합니다!! (현재 이런 구조가 많은데 유지보수를 위해 하나로 통일하는 게 좋을 것 같아서요!)

jun02160 · 2024-11-30T15:52:08Z

src/main/java/org/sopt/makers/internal/community/service/CommunityPostService.java

    private final AnonymousPostProfileRepository anonymousPostProfileRepository;
    private final AnonymousNicknameRepository anonymousNicknameRepository;



여기도 마찬가지로 retriever나 modifier로 사용하면 좋을 것 같습니다~!

현재는 커뮤니티 생성 API만 코드 리팩토링을 했기 때문에, 그외의 부분은 추후 리팩토링시에 변경하는게 안전하다고 판단했습니다!

jun02160 · 2024-11-30T15:55:31Z

src/main/java/org/sopt/makers/internal/community/service/CommunityPostService.java

-        }
+        Member member = memberRetriever.findMemberById(writerId);
+        CommunityPost post = communityPostModifier.createCommunityPost(member, request);
+        anonymousPostProfileService.createAnonymousPostProfile(request.isBlindWriter(), member, post);


여기서 기존의 if문은 서비스 로직에 살려두는 게 좋다고 생각하는데 어떻게 생각하실까요?? 새로운 게시글 등록 시, 항상 익명 프로필 생성이 필요하기 보다 유저의 익명 여부 선택에 따라 달라진다는 의미가 코드에서 읽히면 더 좋을 것 같아요!

동의합니다!

jun02160 · 2024-11-30T15:56:37Z

...n/java/org/sopt/makers/internal/community/service/anonymous/AnonymousPostProfileService.java

+            List<AnonymousPostProfile> lastFourAnonymousPostProfiles = anonymousPostProfileRetriever.getTopByOrderByCreatedAt(4);
+            List<AnonymousPostProfile> lastFiftyAnonymousPostProfiles = anonymousPostProfileRetriever.getTopByOrderByCreatedAt(50);


매직넘버 상수로 선언하는 게 좋을 것 같아요 ~!

동의합니다!

jun02160 · 2024-11-30T16:10:45Z

...n/java/org/sopt/makers/internal/community/service/anonymous/AnonymousPostProfileService.java

+    private final AnonymousProfileImageRetriever anonymousProfileImageRetriever;
+    private final AnonymousNicknameRetriever anonymousNicknameRetriever;
+
+    public void createAnonymousPostProfile(Boolean isBlindWriter, Member member, CommunityPost post) {


어차피 얘를 다른 서비스에서 호출하고 있어 트랜잭션이 적용된 상태일테지만.. 내부에도 @transactional을 선언하는 게 좋을 것 같습니다.
나중에 이 메서드를 직접 호출했을 때나 단위테스트를 짜는 상황에서 트랜잭션이 적용되지 않아 발생하는 문제들을 예방하는 차원에서요!

fyi. https://hungseong.tistory.com/81

헉 제가 @transactional을 빼먹었군요 꼼꼼하게 봐주셔서 감사합니다.

jun02160 · 2024-11-30T16:15:36Z

...va/org/sopt/makers/internal/service/community/anonymous/AnonymousPostProfileServiceTest.java

+        // AnonymousPostProfile의 최근 4개 및 50개의 프로필 Mock 데이터 생성
+        List<AnonymousPostProfile> lastFourProfiles = List.of(
+                AnonymousPostProfile.builder()
+                        .profileImg(AnonymousProfileImage.builder().id(1L).imageUrl("Image1").build())
+                        .nickname(AnonymousNickname.builder().id(1L).nickname("Nickname1").build())
+                        .build(),
+                AnonymousPostProfile.builder()
+                        .profileImg(AnonymousProfileImage.builder().id(2L).imageUrl("Image2").build())
+                        .nickname(AnonymousNickname.builder().id(2L).nickname("Nickname2").build())
+                        .build()
+        );
+
+        List<AnonymousPostProfile> lastFiftyProfiles = List.of(
+                AnonymousPostProfile.builder()
+                        .profileImg(AnonymousProfileImage.builder().id(1L).imageUrl("Image1").build())
+                        .nickname(AnonymousNickname.builder().id(1L).nickname("Nickname1").build())
+                        .build(),
+                AnonymousPostProfile.builder()
+                        .profileImg(AnonymousProfileImage.builder().id(2L).imageUrl("Image2").build())
+                        .nickname(AnonymousNickname.builder().id(2L).nickname("Nickname2").build())
+                        .build(),
+                AnonymousPostProfile.builder()
+                        .profileImg(AnonymousProfileImage.builder().id(3L).imageUrl("Image3").build())
+                        .nickname(AnonymousNickname.builder().id(3L).nickname("Nickname3").build())
+                        .build()
+        );


(사소) 테스트 더미데이터 생성도 private 함수(e.g. createAnonymousProfileImageDummy())로 따로 빼거나 클래스 레벨에서 미리 생성해두면 테스트 메서드 내에서 전달하고자 하는 바가 더 명확하고 깔끔하게 드러날 것 같습니당!

테스트코드 또한 앞으로 유지보수를 해야하는 부분이라고 생각해서 의견주신 방법대로 가독성을 높이는게 정말 필요하다고 생각합니다!
감사합니당!!

Related to: #559

dev-Crayon added 14 commits November 27, 2024 13:48

[Refactor]: 커뮤니티 게시글 생성 API 리팩토링

9940a6f

PostSaveRequest로 받는 데이터 validation 추가 Related to: #559

[Refactor]: CommunityPostRepository 파일 이동

8c01153

repository/community -> community/repository 폴더로 이동 Related to: #559

[Refactor]: CommunityPost.java 수정 및 패키지 이동

19045a1

community domain 패키지로 이동 validation 필요한 필드 추가 Related to: #559

[Refactor]: AnonymousPostProfileRepository 파일 이동

29e84f4

Related to: #559

[Refactor]: AnonymousProfileImageRepository 패키지 변경

023e5a7

Related to: #559

[Refactor]: AnonymousProfileImageRepository 패키지 변경

e56b2aa

Related to: #559

[Refactor]: repository 파일 이동 및 querydsl 메서드 구현

97b719a

Related to: #559

[Refactor]: request body validation 추가

ce89e5a

Related to: #559

[Refactor]: 리팩토링 관련 파일 이동

573a9ce

import문 변경있음 Related to: #559

[Refactor]: 커뮤니티 게시글 생성 로직 코드 분리

ca94af5

Service 계층에 밀집된 비즈니스 로직 분리 하위 도메인 정의 및 코드 분리 Related to: #559

[Refactor]: 커뮤니티 게시글 생성 단위 테스트 코드 생성

4a1aac2

Related to: #559

[Refactor]: 도메인 정의에 맞게 패키지 변경

4559e1c

Related to: #559

[Refactor]: val 사용 지양

7904d59

CommunityController.java에 있는 val 삭제 Related to: #559

[Refactor]: 사용되지 않는 파일 삭제

4d67c92

Related to: #559

dev-Crayon added low priority 낮은 우선순위 요청 작업 승헌✏️ 승헌이 연 PR, Issue에 사용 ♻️ Refactor 코드 리펙토링 시 사용합니다. size/M labels Nov 28, 2024

dev-Crayon requested a review from jun02160 November 28, 2024 12:57

dev-Crayon self-assigned this Nov 28, 2024

pull-request-size bot added size/XL and removed size/M labels Nov 28, 2024

dev-Crayon added 7 commits November 29, 2024 07:24

[Refactor]: Qclass 경로 변경

450ea1e

Related to: #559

[Refactor]: 익명 프로필 이미지 Map 초기화 확인 테스트 코드 작성

3d2c71e

Related to: #559

[Refactor]: 익명 프로필 이미지 1~5 사이의 id값 확인 테스트 코드

7aafe6d

Related to: #559

[Refactor]: 익명 프로필 이미지 1~5 사이의 id값 확인 테스트 코드

0b3449f

Related to: #559

[Refactor]: 익명 프로필 이미지 랜덤 생성 테스트 코드

491c716

Related to: #559

[Refactor]: 익명 프로필 닉네임 랜덤 생성 테스트 코드 작성

cab2bd9

Related to: #559

[Refactor]: 게시물 익명으로 생성 시 익명 프로필 생성 테스트 코드

3dae0af

Related to: #559

jun02160 reviewed Nov 30, 2024

View reviewed changes

dev-Crayon added 7 commits December 16, 2024 12:11

[Refactor]: PostSaveRequest.java @Valid message 필드 추가

6e527e1

Related to: #559

[Refactor]: Domain 객체 생성방식 통일

e22f3d8

Related to: #559

[Refactor]: 익명글에 따른 분기 처리 로직 service 계층에서 담당

4f9c01b

Related to: #559

[Refactor]: 익명 프로필 최신 데이터 조회 limit 상수 선언

a6d9eeb

Related to: #559

[Refactor]: 익명 프로필 최신 데이터 조회 limit 상수 선언

bfc1908

Related to: #559

[Refactor]: 서비스 레이어에 @transactional 어노테이션 추가

84f4195

Related to: #559

[Refactor]: 테스트 코드 더미데이터 생성 함수 분리

e2e317f

Related to: #559

pull-request-size bot added size/XXL and removed size/XL labels Dec 16, 2024

dev-Crayon merged commit c5da3f0 into develop Dec 16, 2024
1 check passed

dev-Crayon deleted the refactor/#559-communityPost branch December 16, 2024 03:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Refactor]: 커뮤니티 게시글 생성 API 코드 리팩토링 #560

[Refactor]: 커뮤니티 게시글 생성 API 코드 리팩토링 #560

dev-Crayon commented Nov 28, 2024

height bot commented Nov 28, 2024

jun02160 left a comment

jun02160 Nov 30, 2024

dev-Crayon Dec 16, 2024

jun02160 Nov 30, 2024

dev-Crayon Dec 16, 2024

jun02160 Nov 30, 2024

dev-Crayon Dec 16, 2024

jun02160 Nov 30, 2024

jun02160 Nov 30, 2024

jun02160 Nov 30, 2024

dev-Crayon Dec 16, 2024

jun02160 Nov 30, 2024

dev-Crayon Dec 16, 2024

jun02160 Nov 30, 2024

dev-Crayon Dec 16, 2024

jun02160 Nov 30, 2024

dev-Crayon Dec 16, 2024

jun02160 Nov 30, 2024

dev-Crayon Dec 16, 2024

	@NotNull(message = "수신자 정보는 필수 입력 값입니다.")
	Long receiverId,

		private final AnonymousPostProfileRepository anonymousPostProfileRepository;
		private final AnonymousNicknameRepository anonymousNicknameRepository;

		List<AnonymousPostProfile> lastFourAnonymousPostProfiles = anonymousPostProfileRetriever.getTopByOrderByCreatedAt(4);
		List<AnonymousPostProfile> lastFiftyAnonymousPostProfiles = anonymousPostProfileRetriever.getTopByOrderByCreatedAt(50);

[Refactor]: 커뮤니티 게시글 생성 API 코드 리팩토링 #560

[Refactor]: 커뮤니티 게시글 생성 API 코드 리팩토링 #560

Conversation

dev-Crayon commented Nov 28, 2024

🐬 요약

👻 유형

🍀 작업 내용

🌟 관련 이슈

height bot commented Nov 28, 2024

jun02160 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

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