[FEAT/#287] 단일 Banner 상세 조회 기능 #288

yummygyudon · 2024-12-12T15:31:18Z

Related Issue 🚀

closed [FEAT] 배너 - 상세 조회 #287

Work Description ✏️

어드민 "배너 관리" 기능 중, " 상세 배너 조회 " 기능을 구현합니다.
URI = /api/v1/banners/{bannerId}
Method = GET

PR Point 📸

※ `@Embeddable` 서브 도메인 객체 구현 - `@Embedded` 적용

※ `@WebMvcTest` 사용

아래와 같은 상황과 고민이 있었습니다.

Application 자체 구동 환경에서의 Test가 필요한 것이 아닌 Controller 메서드의 정상 처리 및 의도한 결과 반환 여부에 확인이 필요했습니다.

@SpringBootTest 를 사용하지 않은 이유
(Ref. blog article & docs)

- 조회 성공 상태에 대한 Success Status Code Enum 추가 구현했습니다. (`BannerSuccessCode`)

소문자인 외부 반환 데이터를 관리하는 필드 `value`을 선언했습니다. 또한 외부 조회 등에 사용될 경우, `value`를 통해 조회할 수 있도록 하기 위해 `getByValue` 메서드를 정의했고 조회하려는 값에 해당하는 Enum이 없을 경우 Banner Exception이 발생하도록 했습니다. - ContentType : 게시물 유형 - PublishLocation : 게시 위치 - PublishStatus : 게시 상태

단일 Entity 내에 모든 필드를 관리할 경우, 관리 및 유지보수에 어려움이 있을 것이며 관심사가 혼재될 것을 우려하여 Embeddable 객체로 분리하여 정의했습니다. - `BannerImage` : PC/Mobile 용 이미지 객체 - `PublishPeriod` : 게시 기간 객체 - 게시 시작 날짜 & 게시 종료 날짜 기반으로 `PublishStatus`를 연산하여 반환하는 메서드 `getPublishStatus`를 정의했습니다.

- 신규 도메인 데이터 테이블로 생성할 Banner (`banners`) 테이블에 대해 복수형 전환 분기 처리를 추가했습니다. * `spring.jpa.properties.hibernate.globally_quoted_identifiers` 속성이 true로 지정될 경우, 자동으로 double quote 가 생성되며 H2 DB에서 테이블 인식에 문제가 생기는 이유로 해당 속성을 제거했습니다.

Embedded 객체 변경이 정상적으로 처리되는지 중점적으로 확인했습니다. * 구현 과정에서 발생했던 오탈자 수정을 진행했습니다.(`BannerImage#updateMobileImage`)

…존성 추가

height · 2024-12-12T15:31:24Z

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.

sung-silver

리뷰가 너무 늦어져서 죄송합니다 ㅜ.ㅜ..
잘 구현해주셔서 제 리뷰가 가독성 측면에서 개선되면 좋을 점들을 적은 리뷰라 일단 어프루브 했습니다!

sung-silver · 2024-12-15T04:21:10Z

...ation-common/src/main/java/org/sopt/makers/operation/code/success/web/BannerSuccessCode.java

+@RequiredArgsConstructor(access = PRIVATE)
+public enum BannerSuccessCode implements SuccessCode {
+    SUCCESS_GET_BANNER_DETAIL(HttpStatus.OK, "배너 상세 정보 조회 성공"),
+


p4

여기 공백 불필요할 것 같습니다!

sung-silver · 2024-12-15T04:21:23Z

...ation-common/src/main/java/org/sopt/makers/operation/code/success/web/BannerSuccessCode.java

+    SUCCESS_GET_BANNER_DETAIL(HttpStatus.OK, "배너 상세 정보 조회 성공"),
+
+    ;
+    private final HttpStatus status;


p4

여기에 공백이 들어가면 좋을 것 같아요!

sung-silver · 2024-12-15T04:21:48Z

operation-domain/src/main/java/org/sopt/makers/operation/banner/domain/Banner.java

+
+import org.sopt.makers.operation.common.domain.BaseEntity;
+
+


p3

여기 공백 한줄만 있으면 좋을 것 같습니다!

sung-silver · 2024-12-15T04:22:15Z

operation-domain/src/main/java/org/sopt/makers/operation/banner/domain/Banner.java

+    @Embedded
+    @AttributeOverrides({
+            @AttributeOverride(name = "pcImageUrl", column = @Column(name = "img_url_pc", nullable = false)),
+            @AttributeOverride(name = "mobileImageUrl", column = @Column(name = "img_url_mobile", nullable = false))
+    })
+    private BannerImage image;


p5

Embedded 타입쓴거 좋네요 ㅎ

sung-silver · 2024-12-15T04:22:41Z

operation-domain/src/main/java/org/sopt/makers/operation/banner/domain/PublishLocation.java

+    CREW_MAIN("cr_main"),
+    CREW_FEED("cr_feed"),
+    OFFICIAL_PAGE("org"),
+    ;


p3

여기 공백한 줄 있으면 좋을 것 같습니다!

sung-silver · 2024-12-15T04:25:42Z

operation-domain/src/main/java/org/sopt/makers/operation/banner/domain/PublishPeriod.java

+    }
+
+    public PublishStatus getPublishStatus(LocalDate date) {
+        if (date.isAfter(endDate)) {


p3

boolean 타입으로 설명적 변수로 위에 정의해주면 조건문 확인 때 더 유용할 것 같아요!

boolean isDone = date.isAfter(endDate); boolean isInProgress = date.isAfter(startDate); if(isDone) { return PublishStatus.DONE; } else if(isInProgress) { return PublishStatus.IN_PROGRESS; } return PublishStatus.RESERVED;

sung-silver · 2024-12-15T04:26:11Z

operation-domain/src/main/java/org/sopt/makers/operation/banner/domain/PublishStatus.java

+    RESERVED("reserved"),
+    IN_PROGRESS("in_progress"),
+    DONE("done"),
+    ;


p3

공백 한 줄 넣어서 변수 선언부랑 분리되면 좋을 것 같습니다!

sung-silver · 2024-12-15T04:27:14Z

operation-domain/src/test/java/org/sopt/makers/operation/DatabaseCleaner.java

@@ -58,6 +61,7 @@ private String convertToSnake(String camel) {
            }
            index++;
        }
+        System.out.println(builder);


p3

print로 확인하는 이유가 혹시 있을까요??

sung-silver · 2024-12-15T04:29:26Z

operation-domain/src/test/java/org/sopt/makers/operation/banner/BannerTest.java

+
+            // then
+            Banner resultBanner = bannerRepository.findById(TEST_BANNER_ID).get();
+            assertThat(resultBanner.getPeriod().getStartDate()).isEqualTo(givenUpdateStartDate);


p3

LocalDate resultBannerStartDate = resultBanner.getPeriod().getStartDate(); assertThat(resultBannerStartDate).isEqualTo(givenUpdateStartDate);

로 작성하는 건 어떨까요??

해당 클래스에 있는 assert문들 내의 긴 변수들을 설명적 변수로 분리하면 테스트에서 비교하는 내용을 더 명확하게 이해할 수 있을 것 같다는 생각입니다!

sung-silver · 2024-12-15T04:30:28Z

operation-domain/src/test/java/org/sopt/makers/operation/banner/BannerTest.java

+            assertThat(resultPeriod.getStartDate()).isEqualTo(TEST_BANNER_START_DATE);
+            assertThat(resultPeriod.getEndDate()).isEqualTo(TEST_BANNER_END_DATE);
+        }
+        @Test


p3

여기 띄어쓰기가 누락된 것 같습니다!

yummygyudon added 15 commits December 11, 2024 11:07

[FEAT] 배너 상세 조회 API Response DTO 정의

d3b556f

[FEAT] Banner 상세 조회 연산 Service 인터페이스 정의

6260e89

[FEAT] Banner 상세 조회 API 정의

a2459f0

- 조회 성공 상태에 대한 Success Status Code Enum 추가 구현했습니다. (`BannerSuccessCode`)

[FEAT] Banner 예외 객체 구현 (Exception & Failure Code Enum)

d47498c

[TEST] PublishPeriod 객체 PublishStatus 연산 기능 테스트

8bd342c

[STYLE] 값 변경 메서드명 수정 (change -> update)

a45154f

[FEAT] Banner 도메인 Entity/Repository 정의 및 변경 메서드 정의

a2821a9

[TEST] Banner 도메인 Entity 단위 테스트

147bb27

Embedded 객체 변경이 정상적으로 처리되는지 중점적으로 확인했습니다. * 구현 과정에서 발생했던 오탈자 수정을 진행했습니다.(`BannerImage#updateMobileImage`)

[CHORE] Unused import 및 와일드 카드 import 개선

e1ae1fa

[FEAT] Entity -> DTO 변환 메서드 정의 및 배너 상세 조회 Service 메서드 구현

e76c71d

[CHORE] test profile Spring Boot Test를 위한 Test H2 DB Driver Class 의…

3b7680a

…존성 추가

[FEAT] Banner API Controller Test - GET /api/v1/banners/{bannerId}

1b86ee3

yummygyudon requested review from hyunw9 and sung-silver December 12, 2024 15:31

yummygyudon self-assigned this Dec 12, 2024

yummygyudon linked an issue Dec 12, 2024 that may be closed by this pull request

[FEAT] 배너 - 상세 조회 #287

Open

3 tasks

pull-request-size bot added the size/XL label Dec 12, 2024

yummygyudon added feat 기능 구현 donggyu labels Dec 12, 2024

sung-silver approved these changes Dec 15, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[FEAT/#287] 단일 Banner 상세 조회 기능 #288

[FEAT/#287] 단일 Banner 상세 조회 기능 #288

yummygyudon commented Dec 12, 2024

height bot commented Dec 12, 2024

sung-silver left a comment

sung-silver Dec 15, 2024

sung-silver Dec 15, 2024

sung-silver Dec 15, 2024

sung-silver Dec 15, 2024

sung-silver Dec 15, 2024

sung-silver Dec 15, 2024

sung-silver Dec 15, 2024

sung-silver Dec 15, 2024

sung-silver Dec 15, 2024

sung-silver Dec 15, 2024

sung-silver Dec 15, 2024

[FEAT/#287] 단일 Banner 상세 조회 기능 #288

Are you sure you want to change the base?

[FEAT/#287] 단일 Banner 상세 조회 기능 #288

Conversation

yummygyudon commented Dec 12, 2024

Related Issue 🚀

Work Description ✏️

PR Point 📸

※ @Embeddable 서브 도메인 객체 구현 - @Embedded 적용

※ @WebMvcTest 사용

height bot commented Dec 12, 2024

sung-silver 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

※ `@Embeddable` 서브 도메인 객체 구현 - `@Embedded` 적용

※ `@WebMvcTest` 사용