[BE] feat: 상품 검색 기능 구현 #445

Go-Jaecheol · 2023-08-14T10:31:50Z

Issue

close [BE] 상품 검색 기능 구현 #402

✨ 구현한 기능

상품 검색 기능 구현

공통 상품, PB 상품 같이 통합해서 검색하도록 구현
자동 완성 API, 검색 결과 API 분리
- 자동 완성의 경우에는 API 호출을 자주하고, 모든 상품 정보를 반환할 필요가 없음
- 자동 완성 API : 상품 정보에서 id, name, categoryType만 반환
- 검색 결과 API : 필요한 상품 정보 전부 반환
페이징 처리 (size : 10, sort : X)

검색 관련 쿼리

SELECT *
FROM product
WHERE name LIKE '%망고%';

SELECT *
FROM product
WHERE name LIKE '%망고%'
ORDER BY CASE WHEN name LIKE '망고%' THEN 1 ELSE 2 END;

위 방식은 순서에 상관없이 '망고'라는 문자열이 포함된 상품명을 다 조회하기 때문에, 사용자의 의도에 맞는 정확한 검색과는 거리가 멀다.
=> '망고'라는 검색어로 시작하는 문자열이 먼저 출력될 수 있도록 ORDER BY + CASE WHEN ~ 사용
ex)
망고주스
망고푸딩
애플망고

📢 논의하고 싶은 내용

controller에서 PageRequest 재정의하고 service로 넘겨주는 이유
- CustomPageableHandlerMethodArgumentResolver로 인해서 Pageable에 id로 정렬하는 sort 옵션이 기본으로 들어가있음
- 따라서 ORDER BY 절을 포함시켜서 쿼리를 날리게 되는데, 위 ORDER BY 절과 중복돼서 에러 발생
  => controller에서 service로 Pageable 넘기기 전에 PageRequest.of()로 재정의

🎸 기타

위 SQL문과 실제 구현한 JPQL 쿼리문이 다른 이유
- @Query에서 WHERE p.name LIKE %:name%처럼 % + 파라미터 형태로 사용하려면, CONCAT('%', :name, '%') 형태로 바꿔서 사용하는 것이 좋다.
- 하나의 쿼리에서 한 번만 사용하는 경우는 괜찮지만, 여러 번 사용하는 경우 race condition이 발생할 수 있기 때문
- reference: Rewrite queries using LIKE with wildcards using CONCAT. spring-projects/spring-data-jpa#2939

⏰ 일정

추정 시간 : 3h
걸린 시간 : 6h

github-actions · 2023-08-14T10:33:27Z

Unit Test Results

159 tests 159 ✔️ 15s ⏱️
  90 suites     0 💤
  90 files     0 ❌

Results for commit f98f02c.

♻️ This comment has been updated with latest results.

wugawuga

controller에서 PageRequest 재정의하고 service로 넘겨주는 이유
CustomPageableHandlerMethodArgumentResolver로 인해서 Pageable에 id로 정렬하는 sort 옵션이 기본으로 들어가있음
따라서 ORDER BY 절을 포함시켜서 쿼리를 날리게 되는데, 위 ORDER BY 절과 중복돼서 에러 발생
=> controller에서 service로 Pageable 넘기기 전에 PageRequest.of()로 재정의

저는 괜찮다고 생각해요!

wugawuga · 2023-08-14T11:28:00Z

backend/src/main/java/com/funeat/product/presentation/ProductApiController.java

@@ -40,4 +44,18 @@ public ResponseEntity<RankingProductsResponse> getRankingProducts() {
        final RankingProductsResponse response = productService.getTop3Products();
        return ResponseEntity.ok(response);
    }
+
+    @GetMapping("/search/products")
+    public ResponseEntity<SearchProductsResponse> searchProducts(@RequestParam final String query, @PageableDefault final Pageable pageable) {


제 인텔리제이에서 보니까 query 이후에 pageable 줄바꿈을 해주네요!!

wugawuga · 2023-08-14T11:28:10Z

backend/src/main/java/com/funeat/product/presentation/ProductApiController.java

+    }
+
+    @GetMapping("/search/products/results")
+    public ResponseEntity<SearchProductResultsResponse> getSearchResults(@RequestParam final String query, @PageableDefault final Pageable pageable) {


이부분도 줄바꿈을 해줘요!!

wugawuga · 2023-08-14T11:33:45Z

backend/src/main/java/com/funeat/product/presentation/ProductController.java

+    @GetMapping
+    ResponseEntity<SearchProductsResponse> searchProducts(
+            @RequestParam final String query, @PageableDefault final Pageable pageable
+    );


Suggested change

@GetMapping

ResponseEntity<SearchProductsResponse> searchProducts(

@RequestParam final String query, @PageableDefault final Pageable pageable

);

@GetMapping

ResponseEntity<SearchProductsResponse> searchProducts(@RequestParam final String query, @PageableDefault final Pageable pageable

);

이렇게 정렬하는 건 어떨까요?

70825

코드 완전 깔끔하네요 🥳

70825 · 2023-08-16T01:21:43Z

backend/src/main/java/com/funeat/product/persistence/ProductRepository.java

+
+    @Query("SELECT p FROM Product p "
+            + "WHERE p.name LIKE CONCAT('%', :name, '%') "
+            + "ORDER BY CASE "
+            + "WHEN p.name LIKE CONCAT(:name, '%') THEN 1 "
+            + "ELSE 2 END")
+    Page<Product> findAllByNameContaining(@Param("name") final String name, final Pageable pageable);
+
+    @Query("SELECT new com.funeat.product.dto.ProductReviewCountDto(p, COUNT(r.id)) FROM Product p "
+            + "LEFT JOIN Review r ON r.product.id = p.id "
+            + "WHERE p.name LIKE CONCAT('%', :name, '%') "
+            + "GROUP BY p.id "
+            + "ORDER BY CASE "
+            + "WHEN p.name LIKE CONCAT(:name, '%') THEN 1 "
+            + "ELSE 2 END")
+    Page<ProductReviewCountDto> findAllWithReviewCountByNameContaining(@Param("name") final String name, final Pageable pageable);


👍👍👍👍👍👍👍

70825 · 2023-08-16T01:30:22Z

backend/src/test/java/com/funeat/acceptance/product/ProductAcceptanceTest.java

@@ -604,4 +726,23 @@ class getRankingProducts_성공_테스트 {
        assertThat(actual).usingRecursiveComparison()
                .isEqualTo(expected);
    }
+
+    private <T> void 상품_자동_완성_검색_결과를_검증한다(final ExtractableResponse<Response> response, final List<T> products) {


이거 생각해보니까 나중에 다시 테스트 코드 리팩터링 할 때 상품_EMPTY_배열_생성() 같은걸로 관리하면 좋을 것 같아요

hanueleee

상품 검색 수고하셨습니다~~
LGTM~

Go-Jaecheol added 5 commits August 14, 2023 18:52

feat: 상품 검색 기능 controller 및 dto 추가

53d6cf8

feat: 검색어가 포함된 상품들을 조회하는 ProductRepository 메서드 추가

358fd33

feat: 상품 검색 기능 구현

c051a4b

test: 상품 검색 관련 ProductRepository 테스트 추가

99a3095

test: 상품 검색 관련 인수 테스트 추가

a93b966

Go-Jaecheol added 🔒 BE ✨ Feature labels Aug 14, 2023

Go-Jaecheol requested review from 70825, wugawuga and hanueleee August 14, 2023 10:31

Go-Jaecheol self-assigned this Aug 14, 2023

wugawuga reviewed Aug 14, 2023

View reviewed changes

70825 approved these changes Aug 16, 2023

View reviewed changes

style: 개행 적용

f98f02c

hanueleee approved these changes Aug 16, 2023

View reviewed changes

Go-Jaecheol merged commit 072bce4 into develop Aug 16, 2023

Go-Jaecheol deleted the feat/issue-402 branch August 16, 2023 04:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[BE] feat: 상품 검색 기능 구현 #445

[BE] feat: 상품 검색 기능 구현 #445

Go-Jaecheol commented Aug 14, 2023

github-actions bot commented Aug 14, 2023 •

edited

Loading

wugawuga left a comment

wugawuga Aug 14, 2023

wugawuga Aug 14, 2023

wugawuga Aug 14, 2023

70825 left a comment

70825 Aug 16, 2023

70825 Aug 16, 2023

hanueleee left a comment

[BE] feat: 상품 검색 기능 구현 #445

[BE] feat: 상품 검색 기능 구현 #445

Conversation

Go-Jaecheol commented Aug 14, 2023

Issue

✨ 구현한 기능

상품 검색 기능 구현

검색 관련 쿼리

📢 논의하고 싶은 내용

🎸 기타

⏰ 일정

github-actions bot commented Aug 14, 2023 • edited Loading

Unit Test Results

wugawuga left a comment

Choose a reason for hiding this comment

wugawuga Aug 14, 2023

Choose a reason for hiding this comment

wugawuga Aug 14, 2023

Choose a reason for hiding this comment

wugawuga Aug 14, 2023

Choose a reason for hiding this comment

70825 left a comment

Choose a reason for hiding this comment

70825 Aug 16, 2023

Choose a reason for hiding this comment

70825 Aug 16, 2023

Choose a reason for hiding this comment

hanueleee left a comment

Choose a reason for hiding this comment

github-actions bot commented Aug 14, 2023 •

edited

Loading