[BSVR-118] 블록별 리뷰 조회 API 구현 #23

pminsung12 · 2024-07-14T15:15:01Z

📌 개요 (필수)

블록별 리뷰 조회 API 구현

🔨 작업 사항 (필수)

블록별 리뷰 조회 API 구현

0.리뷰쪽 domain에 빌더 적용, entity에는 base entity 적용

블록별 리뷰 데이터 반환
열,번 필터링 가능
offset, limit 방식
404 커스텀 예외, 400 bad request 커스텀 예외 구현
테스트 코드 작성

⚡️ 관심 리뷰 (선택)

헥사고날 원칙이 잘 지켜졌는지, 유스케이스에서는 response dto를 몰라야하니까 domain에 응답형태의 domain class(ReviewResponse.java)를 만들어줬는데 더 좋은 방법이 있을까??

🌱 연관 내용 (선택)

모킹 진짜 죽을 것 같아요 테스트 코드 작성하는데 3시간 걸렸습니다..
코드가 양이 많네요ㅠㅠ 죄송합니다..

💻 실행 화면 (필수)

404

200

테스트 결과

pminsung12 · 2024-07-14T15:16:59Z

infrastructure/jpa/src/main/resources/data.sql

-VALUES (1, '잠실 야구 경기장', 'main_image_a.jpg', 'seating_chart_a.jpg', 'labeled_seating_chart_a.jpg', true),
-       (2, '김포 야구 경기장', 'main_image_b.jpg', 'seating_chart_b.jpg', 'labeled_seating_chart_b.jpg', true),
-       (3, '부산 야구 경기장', 'main_image_c.jpg', 'seating_chart_c.jpg', 'labeled_seating_chart_c.jpg', false);
+VALUES (1, '잠실 야구 경기장', 'main_image_a.jpg', 'seating_chart_a.jpg', 'labeled_seating_chart_a.jpg', 1),


true, false에 자꾸 아래 사진처럼 이상한 에러가 떠서 원인을 결국 파악을 못하고 true 대신 1, false대신 0을 넣어주니까 해결됐거든.. 이유가 뭘까 ㅠ

오잉 뭐지 나는 로컬에서 stadiums 잘 Insert 되던데..?! 다음 티켓 작업할때 다시 확인해볼게!

pminsung12 · 2024-07-14T15:18:33Z

...ion/src/main/java/org/depromeet/spot/application/review/dto/response/ReviewListResponse.java

+    record KeywordCountResponse(String content, Long count) {}
+
+    record FilterInfo(Long rowId, Integer seatNumber) {}
+}


얘들은 딱히 밖에서 사용할 것 같지 않아서 중첩 클래스?레코드?로 넣어놨어.

pminsung12 · 2024-07-14T15:24:28Z

domain/src/main/java/org/depromeet/spot/domain/review/Review.java

+    private final List<ReviewImage> images;
+    private final List<ReviewKeyword> keywords;


도메인 상에서 image와 keyword는 배열로 관리해줄 수 있도록 필드를 추가했어

pminsung12 · 2024-07-14T15:26:51Z

...ructure/jpa/src/main/java/org/depromeet/spot/jpa/review/repository/ReviewRepositoryImpl.java

+        if (reviews.isEmpty()) {
+            throw new ReviewException.ReviewNotFoundException(
+                    "No review found for blockId:" + blockId);
+        }


조회가 하나도 안되는 경우: 404 예외처리

pminsung12 · 2024-07-14T15:27:26Z

...ructure/jpa/src/main/java/org/depromeet/spot/jpa/review/repository/ReviewRepositoryImpl.java

+        if (review == null) {
+            throw new InvalidReviewDataException(
+                    "Failed to convert entity to domain for reviewId: " + reviewEntity.getId());
+        }


변환이 안될 때 -> 데이터가 잘못들어왔을 시 400 bad request

EunjiShin

LGTM! 고생했어~ 테스트...빡셌겠는걸.....? 보기만해도 어지럽구만 😂
몇 가지 코멘트 남겨두었어! 확인해주어~~

(++ 지금 브랜치 main이랑 conflict나는데 이것도 확인해줘!)

EunjiShin · 2024-07-14T15:29:11Z

application/src/main/java/org/depromeet/spot/application/review/ReviewReadController.java

+            @RequestParam(defaultValue = "0")
+                    @PositiveOrZero
+                    @Parameter(description = "시작 위치 (기본값: 0)")
+                    int offset,


요건 단순 질문인데, offset = null로 들어오면

defaultValue가 0으로 세팅되는거야

@PositiveOrZero에 걸려서 exception이 발생하는거야 ?.?

null로 들어오면 0으로 세팅돼!

positiveOrZero로 0이상의 값만 받도록 -> 음수면 exception발생!

요청에 null로 들어오면 디폴트 0으로 세팅

EunjiShin · 2024-07-14T15:31:31Z

...tion/src/main/java/org/depromeet/spot/application/review/dto/request/ReviewBlockRequest.java

+        @PositiveOrZero @Parameter(description = "시작 위치 (기본값: 0)") int offset,
+        @Max(50) @Parameter(description = "조회할 리뷰 수 (기본값: 10, 최대: 50)") int limit) {


단순 질문! Pageable을 안쓰고 offset, limit parameter를 이용한건 validation 때문이야?

진짜.. 바보인가봐 제대로 알아보지도 않고 하드코딩 했네 ㅠㅠㅠㅠ 수정해야겠다

EunjiShin · 2024-07-14T15:33:05Z

...tion/src/main/java/org/depromeet/spot/application/review/dto/request/ReviewBlockRequest.java

+        @PositiveOrZero @Parameter(description = "시작 위치 (기본값: 0)") int offset,
+        @Max(50) @Parameter(description = "조회할 리뷰 수 (기본값: 10, 최대: 50)") int limit) {
+    public ReviewBlockRequest {
+        if (offset == 0) offset = 0;


요 라인은 불필요한 것 같다!

EunjiShin · 2024-07-14T15:35:55Z

...ion/src/main/java/org/depromeet/spot/application/review/dto/response/ReviewListResponse.java

+                        .collect(Collectors.toList());
+
+        boolean hasMore = (result.offset() + result.reviews().size()) < result.totalCount();
+        FilterInfo filter = new FilterInfo(null, null); // Assuming no filter info for now


필터에는 항상 null 값이 들어가는 것 같은데, 이번 티켓에 포함된 이유가 있을까?!
어떤 역할을 하는 친구인지 궁금해요

EunjiShin · 2024-07-14T15:37:21Z

...ion/src/main/java/org/depromeet/spot/application/review/dto/response/ReviewListResponse.java

+                        .map(kc -> new KeywordCountResponse(kc.content(), kc.count()))
+                        .collect(Collectors.toList());
+
+        boolean hasMore = (result.offset() + result.reviews().size()) < result.totalCount();


JPA에서 제공하는 Page에 hasNext()가 있는데, 혹시 hasMore을 직접 계산한 이유가 있을까?

EunjiShin · 2024-07-14T15:50:55Z

...ructure/jpa/src/main/java/org/depromeet/spot/jpa/review/repository/ReviewRepositoryImpl.java

+        List<ReviewImage> images =
+                reviewCustomRepository.findImagesByReviewId(reviewEntity.getId()).stream()
+                        .map(ReviewImageEntity::toDomain)
+                        .collect(Collectors.toList());
+
+        List<ReviewKeyword> keywords =
+                reviewCustomRepository.findKeywordsByReviewId(reviewEntity.getId()).stream()
+                        .map(ReviewKeywordEntity::toDomain)
+                        .collect(Collectors.toList());


사~~~소한 의견인데 메서드를 분리하면 어떨까 싶당! 이번 리뷰에선 반영 안해도 괜찮아!

EunjiShin · 2024-07-14T15:53:06Z

...ructure/jpa/src/main/java/org/depromeet/spot/jpa/review/repository/ReviewRepositoryImpl.java

+        Review review = reviewEntity.toDomain();
+        if (review == null) {
+            throw new InvalidReviewDataException(
+                    "Failed to convert entity to domain for reviewId: " + reviewEntity.getId());
+        }


ReviewEntity.toDomain()에서 null이 반환될 가능성이 있을까?!
만약 ReviewEntity가 null인 상황에 대한 방어코드라면, null.toDomain()이라 NPE가 발생할 수 있을 것 같아!
toDomain()이 호출되기 전에, 또는 toDomain() 내부에서 ReviewEntity가 null인지 체크하는게 더 좋지 않을까?

EunjiShin · 2024-07-14T15:56:28Z

...ructure/jpa/src/main/java/org/depromeet/spot/jpa/review/repository/ReviewRepositoryImpl.java

+            throw new InvalidReviewDataException(
+                    "Failed to convert entity to domain for reviewId: " + reviewEntity.getId());
+        }
+        return Review.builder()


ReviewEntity 내부에 새로운 정적 팩토리 메서드를 추가하는건 어때?
ReviewEntity.toDomain(List<ReviewImage> images, List<ReviewKeyword> keywords)

위에서(61번째 라인) Review를 만들었는데 아래에서(66번째 라인) 또 새롭게 만들어줄 필요는 없을 것 같아!

EunjiShin · 2024-07-14T16:01:29Z

usecase/src/main/java/org/depromeet/spot/usecase/service/review/ReviewReadService.java

+        List<KeywordCount> topKeywords =
+                reviewRepository.findTopKeywordsByBlockId(stadiumId, blockId, 5);


5 << 는 상위 5개 키워드를 의도한거지?
상수로 뽑아주면 가독성 & 유지관리가 더 쉬울 것 같아!

EunjiShin · 2024-07-14T16:11:22Z

domain/src/main/java/org/depromeet/spot/domain/review/ReviewListResult.java

요거 유스케이스 반환형으로 사용되는 친구인거지?
도메인은 정말 우리 서비스의 비즈니스 영역을 추상적으로 나타낸 것이고, ReviewListResult는 단순히 API response로 매핑될 값이라 조금 역할이 다른 것 같아!

새로운 도메인을 만들지 않고 구현하는 방법으로는 당장은 요렇게 두 가지 정도가 생각나네 👀

controller - usecase 사이에 facade 와 같은 계층을 추가하기

ReviewFacade 등을 만들어서, ReviewUsecase, ReviewKeywordUsecase 등등을 호출하고 조합해서 controller로 반환

usecase 반환용의 dto를 만들기

나는 일단 작업량이 너무 늘어나는 것 같고 + 비즈니스 로직이 분산되는 것 같아서 후자로 작업했어!

github-actions · 2024-07-15T09:16:48Z

Test Results

20 tests +3 20 ✅ +3 0s ⏱️ ±0s
7 suites +1 0 💤 ±0
7 files +1 0 ❌ ±0

Results for commit ae42f0e. ± Comparison against base commit 68ce52b.

♻️ This comment has been updated with latest results.

pminsung12 added 17 commits July 14, 2024 04:19

refactor: 도메인에 builder 패턴 적용, status->deletedAt으로 타입과 이름 변경

0adfcf7

refactor: review entity에 base entity 적용

c128167

fix: review entity 필드 수정, blockTopKeyword base entity 상속받도록 개선

1ac2fbb

feat: stadiumId 추가

709d2e6

fix: deletedAt 필드에 nullable false 삭제

e39e01b

feat: 블록별 리뷰조회 요청 dto 구현

b180a77

feat: 블록별 리뷰조회 응답 dto 구현

66b002e

feat: dto 역할에 해당하는 도메인 구현

ff72e1b

feat: 리뷰 이미지 배열과 리뷰 키워드 배열 도메인에 추가

57a9601

feat: queryfactory를 통한 리뷰 커스텀 리포지토리 구현

2f69b01

feat: 리뷰 리포지토리 인터페이스와 구현체 구현

4789fbe

feat: 리뷰 조회 유스케이스 인터페이스 구현

81d40bd

feat: 리뷰 조회 유스케이스 인터페이스를 구현한 리뷰 조회 서비스 구현

81ac814

feat: 리뷰 조회 컨트롤러 구현

e3b0dbc

feat: 테스트위한 리뷰쪽 더미데이터 삽입

ba5e533

feat: custom exceptiond을 통한 레포지토리에서 예외처리

e90bd50

test: 모킹을 통한 조회서비스 테스트

d651526

pminsung12 added the ✨ Feature 기능 개발 label Jul 14, 2024

pminsung12 self-assigned this Jul 14, 2024

pminsung12 requested review from EunjiShin and wjdwnsdnjs13 as code owners July 14, 2024 15:15

pminsung12 commented Jul 14, 2024

View reviewed changes

EunjiShin reviewed Jul 14, 2024

View reviewed changes

pminsung12 added 7 commits July 15, 2024 16:04

refactor: 상위 5개 블록의 매개변수 5 상수화

f9d25e4

refactor: 의미없는 코드 삭제

effc1a9

refactor: 메서드 반환형 int->Long으로 수정

faca081

test: 메서드 반환형 int->Long으로 수정

9a1586b

refactor: 리뷰 엔티티 필드명 오타 수정

bd4024e

fix: totalCount 데이터 타입 Long으로 변경

f337af0

refactor: exception 처리 삭제 및 팩터리 메서드로 코드 개선

dfea456

Merge branch 'main' into feat/BSVR-118

4ba4f51

github-actions bot added the size/L label Jul 15, 2024

pminsung12 added 2 commits July 15, 2024 19:08

fix: base entity 충돌 해결

070e154

fix: splotless 적용

ae42f0e

pminsung12 merged commit 0e873da into main Jul 15, 2024
4 checks passed

pminsung12 deleted the feat/BSVR-118 branch July 15, 2024 10:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[BSVR-118] 블록별 리뷰 조회 API 구현 #23

[BSVR-118] 블록별 리뷰 조회 API 구현 #23

pminsung12 commented Jul 14, 2024 •

edited

Loading

pminsung12 Jul 14, 2024

EunjiShin Jul 14, 2024

pminsung12 Jul 14, 2024

pminsung12 Jul 14, 2024

pminsung12 Jul 14, 2024

pminsung12 Jul 14, 2024

EunjiShin left a comment

EunjiShin Jul 14, 2024

pminsung12 Jul 15, 2024

EunjiShin Jul 14, 2024

pminsung12 Jul 15, 2024

EunjiShin Jul 14, 2024

EunjiShin Jul 14, 2024

EunjiShin Jul 14, 2024

EunjiShin Jul 14, 2024

EunjiShin Jul 14, 2024

EunjiShin Jul 14, 2024

EunjiShin Jul 14, 2024

EunjiShin Jul 14, 2024

github-actions bot commented Jul 15, 2024 •

edited

Loading

		private final List<ReviewImage> images;
		private final List<ReviewKeyword> keywords;

		@PositiveOrZero @Parameter(description = "시작 위치 (기본값: 0)") int offset,
		@Max(50) @Parameter(description = "조회할 리뷰 수 (기본값: 10, 최대: 50)") int limit) {

		List<KeywordCount> topKeywords =
		reviewRepository.findTopKeywordsByBlockId(stadiumId, blockId, 5);

[BSVR-118] 블록별 리뷰 조회 API 구현 #23

[BSVR-118] 블록별 리뷰 조회 API 구현 #23

Conversation

pminsung12 commented Jul 14, 2024 • edited Loading

📌 개요 (필수)

🔨 작업 사항 (필수)

⚡️ 관심 리뷰 (선택)

🌱 연관 내용 (선택)

💻 실행 화면 (필수)

404

200

테스트 결과

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

EunjiShin 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

github-actions bot commented Jul 15, 2024 • edited Loading

Test Results

pminsung12 commented Jul 14, 2024 •

edited

Loading

github-actions bot commented Jul 15, 2024 •

edited

Loading