[volume - 9] What is Popularity? (#210)

* Feature/ranking (#37)

* feat: zset 모듈 추가

zset

* test: 랭킹 계산에 대한 테스트 코드 추가

* feat: 랭킹 계산 서비스 구현

* test: 랭킹 이벤트 컨슈머 테스트 로직 추가

* feat: 랭킹 컨슈머 구현

* test: 랭킹 조회 통합 테스트 코드 추가

* feat: 랭킹 조회 서비스 로직 구현

* feat: 랭킹 조회 엔드포인트 추가

* test: 랭킹 정보 포함하여 상품 조회하는 테스트 코드 작성

* feat: 랭킹 포함하여 상품 정보 조회하도록 api 수정

---------

Co-authored-by: 이건영 <>

* Feature/ranking event (#38)

* feat: zset 모듈에 zunionstore 연산 처리 메소드 추가

* test: 랭킹 집계에 필요한 데이터 수집과 랭킹 계산 로직을 application event 기준으로 분리하도록 테스트 코드 수정

* feat: 랭킹 집계에 필요한 데이터 수집과 랭킹 계산 로직을 application event 기준으로 분리하도록 함

* Feature/ranking exception (#39)

* test: 랭킹 조회 실패할 때의 테스트코드 추가

* feat: 랭킹 조회 실패시 전날 혹은 좋아요 순 데이터로 응답하도록 보완

* feat: 랭킹 fallback 전략 구현

* test: 랭킹 fallback 전략에 맞춰 테스트코드 수정

* refactor: 일자 단위 carry over 도입에 따라 unionstore 제거

* chore: 클래스명과 동일하게 파일 이름 변경

* refactor: 랭킹 이벤트 컨슈머에서 멱등성 체크 로직, 에러 처리 로직, 배치 커밋 로직 반복 제거

* refactor: 불필요한 stubbing 제거

* chore: 시간대 설정 추가

Author: minor7295

apps/commerce-api/src/main/java/com/loopers/application/catalog/CatalogFacade.java

@@ -3,6 +3,7 @@
 import com.loopers.application.brand.BrandService;
 import com.loopers.application.product.ProductCacheService;
 import com.loopers.application.product.ProductService;
+import com.loopers.application.ranking.RankingService;
 import com.loopers.domain.brand.Brand;
 import com.loopers.domain.product.Product;
 import com.loopers.domain.product.ProductDetail;
@@ -14,6 +15,7 @@
 import org.springframework.stereotype.Component;
 import org.springframework.transaction.annotation.Transactional;
 
+import java.time.LocalDate;
 import java.util.List;
 import java.util.Map;
 import java.util.stream.Collectors;
@@ -34,6 +36,7 @@ public class CatalogFacade {
     private final ProductService productService;
     private final ProductCacheService productCacheService;
     private final ProductEventPublisher productEventPublisher;
+    private final RankingService rankingService;
 
     /**
      * 상품 목록을 조회합니다.
@@ -90,7 +93,7 @@ public ProductInfoList getProducts(Long brandId, String sort, int page, int size
                 }
                 // ✅ Product.likeCount 필드 사용 (비동기 집계된 값)
                 ProductDetail productDetail = ProductDetail.from(product, brand.getName(), product.getLikeCount());
-                return new ProductInfo(productDetail);
+                return ProductInfo.withoutRank(productDetail);
             })
             .toList();
 
@@ -108,10 +111,11 @@ public ProductInfoList getProducts(Long brandId, String sort, int page, int size
      * <p>
      * Redis 캐시를 먼저 확인하고, 캐시에 없으면 DB에서 조회한 후 캐시에 저장합니다.
      * 상품 조회 시 ProductViewed 이벤트를 발행하여 메트릭 집계에 사용합니다.
+     * 랭킹 정보도 함께 조회하여 반환합니다.
      * </p>
      *
      * @param productId 상품 ID
-     * @return 상품 정보와 좋아요 수
+     * @return 상품 정보와 좋아요 수, 랭킹 순위
      * @throws CoreException 상품을 찾을 수 없는 경우
      */
     @Transactional(readOnly = true)
@@ -121,7 +125,11 @@ public ProductInfo getProduct(Long productId) {
         if (cachedResult != null) {
             // 캐시 히트 시에도 조회 수 집계를 위해 이벤트 발행
             productEventPublisher.publish(ProductEvent.ProductViewed.from(productId));
-            return cachedResult;
+            
+            // 랭킹 정보 조회 (캐시된 결과에 랭킹 정보 추가)
+            LocalDate today = LocalDate.now();
+            Long rank = rankingService.getProductRank(productId, today);
+            return ProductInfo.withRank(cachedResult.productDetail(), rank);
         }
 
         // 캐시에 없으면 DB에서 조회
@@ -136,16 +144,19 @@ public ProductInfo getProduct(Long productId) {
         // ProductDetail 생성 (Aggregate 경계 준수: Brand 엔티티 대신 brandName만 전달)
         ProductDetail productDetail = ProductDetail.from(product, brand.getName(), likesCount);
 
-        ProductInfo result = new ProductInfo(productDetail);
+        // 랭킹 정보 조회
+        LocalDate today = LocalDate.now();
+        Long rank = rankingService.getProductRank(productId, today);
 
-        // 캐시에 저장
-        productCacheService.cacheProduct(productId, result);
+        // 캐시에 저장 (랭킹 정보는 제외하고 저장 - 랭킹은 실시간으로 조회)
+        productCacheService.cacheProduct(productId, ProductInfo.withoutRank(productDetail));
 
         // ✅ 상품 조회 이벤트 발행 (메트릭 집계용)
         productEventPublisher.publish(ProductEvent.ProductViewed.from(productId));
 
         // 로컬 캐시의 좋아요 수 델타 적용 (DB 조회 결과에도 델타 반영)
-        return productCacheService.applyLikeCountDelta(result);
+        ProductInfo deltaApplied = productCacheService.applyLikeCountDelta(ProductInfo.withoutRank(productDetail));
+        return ProductInfo.withRank(deltaApplied.productDetail(), rank);
     }
 
 }

apps/commerce-api/src/main/java/com/loopers/application/catalog/ProductInfo.java

@@ -6,7 +6,28 @@
  * 상품 상세 정보를 담는 레코드.
  *
  * @param productDetail 상품 상세 정보 (Product + Brand + 좋아요 수)
+ * @param rank 랭킹 순위 (1부터 시작, 랭킹에 없으면 null)
  */
-public record ProductInfo(ProductDetail productDetail) {
+public record ProductInfo(ProductDetail productDetail, Long rank) {
+    /**
+     * 랭킹 정보 없이 ProductInfo를 생성합니다.
+     *
+     * @param productDetail 상품 상세 정보
+     * @return ProductInfo (rank는 null)
+     */
+    public static ProductInfo withoutRank(ProductDetail productDetail) {
+        return new ProductInfo(productDetail, null);
+    }
+
+    /**
+     * 랭킹 정보와 함께 ProductInfo를 생성합니다.
+     *
+     * @param productDetail 상품 상세 정보
+     * @param rank 랭킹 순위 (1부터 시작, 랭킹에 없으면 null)
+     * @return ProductInfo
+     */
+    public static ProductInfo withRank(ProductDetail productDetail, Long rank) {
+        return new ProductInfo(productDetail, rank);
+    }
 }
 

apps/commerce-api/src/main/java/com/loopers/application/product/ProductCacheService.java

@@ -269,7 +269,7 @@ public ProductInfo applyLikeCountDelta(ProductInfo productInfo) {
             updatedLikesCount
         );
 
-        return new ProductInfo(updatedDetail);
+        return ProductInfo.withoutRank(updatedDetail);
     }
 }
 

apps/commerce-api/src/main/java/com/loopers/application/ranking/RankingKeyGenerator.java

@@ -0,0 +1,52 @@
+package com.loopers.application.ranking;
+
+import org.springframework.stereotype.Component;
+
+import java.time.LocalDate;
+import java.time.LocalDateTime;
+import java.time.format.DateTimeFormatter;
+
+/**
+ * 랭킹 키 생성 유틸리티.
+ * <p>
+ * Redis ZSET 랭킹 키를 생성합니다.
+ * </p>
+ *
+ * @author Loopers
+ * @version 1.0
+ */
+@Component
+public class RankingKeyGenerator {
+    private static final String DAILY_KEY_PREFIX = "ranking:all:";
+    private static final String HOURLY_KEY_PREFIX = "ranking:hourly:";
+    private static final DateTimeFormatter DATE_FORMATTER = DateTimeFormatter.ofPattern("yyyyMMdd");
+    private static final DateTimeFormatter DATE_TIME_FORMATTER = DateTimeFormatter.ofPattern("yyyyMMddHH");
+
+    /**
+     * 일간 랭킹 키를 생성합니다.
+     * <p>
+     * 예: ranking:all:20241215
+     * </p>
+     *
+     * @param date 날짜
+     * @return 일간 랭킹 키
+     */
+    public String generateDailyKey(LocalDate date) {
+        String dateStr = date.format(DATE_FORMATTER);
+        return DAILY_KEY_PREFIX + dateStr;
+    }
+
+    /**
+     * 시간 단위 랭킹 키를 생성합니다.
+     * <p>
+     * 예: ranking:hourly:2024121514
+     * </p>
+     *
+     * @param dateTime 날짜 및 시간
+     * @return 시간 단위 랭킹 키
+     */
+    public String generateHourlyKey(LocalDateTime dateTime) {
+        String dateTimeStr = dateTime.format(DATE_TIME_FORMATTER);
+        return HOURLY_KEY_PREFIX + dateTimeStr;
+    }
+}