Merge pull request #213 from mju-likelion/feature/caching-circuit-breaker-#211

cookie-meringue · web-flow · commit ff5f4275032f · 2024-10-05T00:11:03.000+09:00
Feature/#211 캐싱 서킷 브레이커 적용
diff --git a/build.gradle b/build.gradle
@@ -41,6 +41,8 @@ dependencies {
 
     implementation 'com.fasterxml.jackson.datatype:jackson-datatype-jsr310:2.13.3'// Jackson
 
+    implementation 'io.github.resilience4j:resilience4j-spring-boot3:2.0.2'// Resilience4j
+
     testImplementation 'org.springframework.boot:spring-boot-starter-test'
     testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
 }
diff --git a/src/main/java/org/mju_likelion/festival/booth/service/BoothQueryService.java b/src/main/java/org/mju_likelion/festival/booth/service/BoothQueryService.java
@@ -1,13 +1,16 @@
 package org.mju_likelion.festival.booth.service;
 
+import static org.mju_likelion.festival.common.config.Resilience4jConfig.REDIS_CIRCUIT_BREAKER;
 import static org.mju_likelion.festival.common.exception.type.ErrorType.BOOTH_DEPARTMENT_NOT_FOUND_ERROR;
 import static org.mju_likelion.festival.common.exception.type.ErrorType.BOOTH_NOT_FOUND_ERROR;
 import static org.mju_likelion.festival.common.exception.type.ErrorType.NOT_BOOTH_OWNER_ERROR;
 import static org.mju_likelion.festival.common.exception.type.ErrorType.NOT_EVENT_BOOTH_ERROR;
 
+import io.github.resilience4j.circuitbreaker.annotation.CircuitBreaker;
 import java.util.List;
 import java.util.UUID;
 import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
 import org.mju_likelion.festival.admin.domain.Admin;
 import org.mju_likelion.festival.admin.service.AdminQueryService;
 import org.mju_likelion.festival.booth.domain.Booth;
@@ -24,13 +27,15 @@
 import org.mju_likelion.festival.booth.dto.response.SimpleBoothResponse;
 import org.mju_likelion.festival.booth.dto.response.SimpleBoothResponses;
 import org.mju_likelion.festival.booth.util.qr.manager.BoothQrManager;
+import org.mju_likelion.festival.common.circuit_breaker.FallBackUtil;
 import org.mju_likelion.festival.common.exception.BadRequestException;
 import org.mju_likelion.festival.common.exception.ForbiddenException;
 import org.mju_likelion.festival.common.exception.NotFoundException;
 import org.springframework.cache.annotation.Cacheable;
 import org.springframework.stereotype.Service;
 import org.springframework.transaction.annotation.Transactional;
 
+@Slf4j
 @Service
 @RequiredArgsConstructor
 @Transactional(readOnly = true)
@@ -49,7 +54,17 @@ public List<BoothAffiliationResponse> getBoothAffiliations() {
   }
 
   @Cacheable(value = "simpleBooths", key = "#affiliationId")
+  @CircuitBreaker(name = REDIS_CIRCUIT_BREAKER, fallbackMethod = "getBoothsFallback")
   public SimpleBoothResponses getBooths(final UUID affiliationId) {
+    return getBoothsLogic(affiliationId);
+  }
+
+  public SimpleBoothResponses getBoothsFallback(final UUID affiliationId, final Exception e) {
+    FallBackUtil.handleFallBack(e);
+    return getBoothsLogic(affiliationId);
+  }
+
+  private SimpleBoothResponses getBoothsLogic(final UUID affiliationId) {
     validateBoothDepartment(affiliationId);
 
     List<SimpleBooth> simpleBooths = boothQueryRepository.findAllSimpleBoothByAffiliationId(
@@ -63,12 +78,39 @@ public SimpleBoothResponses getBooths(final UUID affiliationId) {
   }
 
   @Cacheable(value = "boothDetail", key = "#id")
+  @CircuitBreaker(name = REDIS_CIRCUIT_BREAKER, fallbackMethod = "getBoothFallback")
   public BoothDetailResponse getBooth(final UUID id) {
+    return getBoothLogic(id);
+  }
+
+  public BoothDetailResponse getBoothFallback(final UUID id, final Exception e) {
+    FallBackUtil.handleFallBack(e);
+    return getBoothLogic(id);
+  }
+
+  private BoothDetailResponse getBoothLogic(final UUID id) {
     return BoothDetailResponse.from(getExistingBoothDetail(id));
   }
 
   @Cacheable(value = "boothManagingDetail", key = "#boothId + ' : ' + #boothAdminId")
-  public BoothManagingDetailResponse getBoothManagingDetail(final UUID boothId,
+  @CircuitBreaker(name = REDIS_CIRCUIT_BREAKER, fallbackMethod = "getBoothManagingDetailFallback")
+  public BoothManagingDetailResponse getBoothManagingDetail(
+      final UUID boothId,
+      final UUID boothAdminId) {
+
+    return getBoothManagingDetailLogic(boothId, boothAdminId);
+  }
+
+  public BoothManagingDetailResponse getBoothManagingDetailFallback(
+      final UUID boothId,
+      final UUID boothAdminId,
+      final Exception e) {
+
+    FallBackUtil.handleFallBack(e);
+    return getBoothManagingDetailLogic(boothId, boothAdminId);
+  }
+
+  private BoothManagingDetailResponse getBoothManagingDetailLogic(final UUID boothId,
       final UUID boothAdminId) {
     validateBoothExistence(boothId);
     adminQueryService.validateAdminExistence(boothAdminId);
diff --git a/src/main/java/org/mju_likelion/festival/booth/service/BoothService.java b/src/main/java/org/mju_likelion/festival/booth/service/BoothService.java
@@ -1,5 +1,8 @@
 package org.mju_likelion.festival.booth.service;
 
+import static org.mju_likelion.festival.common.config.Resilience4jConfig.REDIS_CIRCUIT_BREAKER;
+
+import io.github.resilience4j.circuitbreaker.annotation.CircuitBreaker;
 import java.util.UUID;
 import lombok.RequiredArgsConstructor;
 import org.mju_likelion.festival.admin.domain.Admin;
@@ -9,6 +12,7 @@
 import org.mju_likelion.festival.booth.dto.request.UpdateBoothRequest;
 import org.mju_likelion.festival.booth.util.qr.BoothQrStrategy;
 import org.mju_likelion.festival.booth.util.qr.manager.BoothQrManager;
+import org.mju_likelion.festival.common.circuit_breaker.FallBackUtil;
 import org.mju_likelion.festival.user.domain.User;
 import org.mju_likelion.festival.user.service.UserQueryService;
 import org.springframework.cache.annotation.CacheEvict;
@@ -44,11 +48,30 @@ public void visitBooth(
   }
 
   @CacheEvict(value = "boothDetail", key = "#boothId")
+  @CircuitBreaker(name = REDIS_CIRCUIT_BREAKER, fallbackMethod = "updateBoothFallback")
   public void updateBooth(
       final UUID boothId,
       final UpdateBoothRequest updateBoothRequest,
       final UUID boothAdminId) {
 
+    updateBoothLogic(boothId, updateBoothRequest, boothAdminId);
+  }
+
+  public void updateBoothFallback(
+      final UUID boothId,
+      final UpdateBoothRequest updateBoothRequest,
+      final UUID boothAdminId,
+      final Exception e) {
+
+    FallBackUtil.handleFallBack(e);
+    updateBoothLogic(boothId, updateBoothRequest, boothAdminId);
+  }
+
+  public void updateBoothLogic(
+      final UUID boothId,
+      final UpdateBoothRequest updateBoothRequest,
+      final UUID boothAdminId) {
+
     Admin admin = adminQueryService.getExistingAdmin(boothAdminId);
     Booth booth = boothQueryService.getExistingBooth(boothId);
 
diff --git a/src/main/java/org/mju_likelion/festival/common/circuit_breaker/FallBackUtil.java b/src/main/java/org/mju_likelion/festival/common/circuit_breaker/FallBackUtil.java
@@ -0,0 +1,26 @@
+package org.mju_likelion.festival.common.circuit_breaker;
+
+import lombok.extern.slf4j.Slf4j;
+import org.mju_likelion.festival.common.exception.CustomException;
+
+@Slf4j
+public class FallBackUtil {
+
+  public static void handleFallBack(final Exception e) {
+    if (e instanceof CustomException) {
+      throw (CustomException) e;
+    }
+
+    StackTraceElement[] stackTrace = new Throwable().getStackTrace();
+    StackTraceElement caller = stackTrace[1];
+    writeLog(e, caller);
+  }
+
+  private static void writeLog(final Exception e, final StackTraceElement caller) {
+    log.info("Fallback to method {}(): {}, {}",
+        caller.getMethodName(),
+        e.getClass().getSimpleName(),
+        e.getMessage()
+    );
+  }
+}
diff --git a/src/main/java/org/mju_likelion/festival/common/config/Resilience4jConfig.java b/src/main/java/org/mju_likelion/festival/common/config/Resilience4jConfig.java
@@ -0,0 +1,34 @@
+package org.mju_likelion.festival.common.config;
+
+import io.github.resilience4j.circuitbreaker.CircuitBreakerConfig;
+import io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry;
+import io.lettuce.core.RedisException;
+import java.time.Duration;
+import org.mju_likelion.festival.common.exception.CustomException;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.data.redis.RedisConnectionFailureException;
+import org.springframework.data.redis.RedisSystemException;
+
+@Configuration
+public class Resilience4jConfig {
+
+  public static final String REDIS_CIRCUIT_BREAKER = "redis";
+
+  @Bean
+  public CircuitBreakerRegistry redisCircuitBreakerRegistry() {
+    CircuitBreakerConfig circuitBreakerConfig = CircuitBreakerConfig.custom()
+        .failureRateThreshold(80)
+        .slidingWindowSize(10)
+        .permittedNumberOfCallsInHalfOpenState(5)
+        .waitDurationInOpenState(Duration.ofHours(1))
+        .recordExceptions(RedisException.class, RedisSystemException.class,
+            RedisConnectionFailureException.class)
+        .ignoreExceptions(CustomException.class)
+        .build();
+
+    CircuitBreakerRegistry circuitBreakerRegistry = CircuitBreakerRegistry.of(circuitBreakerConfig);
+    circuitBreakerRegistry.circuitBreaker(REDIS_CIRCUIT_BREAKER, circuitBreakerConfig);
+    return circuitBreakerRegistry;
+  }
+}
diff --git a/src/main/java/org/mju_likelion/festival/lost_item/service/LostItemQueryService.java b/src/main/java/org/mju_likelion/festival/lost_item/service/LostItemQueryService.java
@@ -1,11 +1,14 @@
 package org.mju_likelion.festival.lost_item.service;
 
+import static org.mju_likelion.festival.common.config.Resilience4jConfig.REDIS_CIRCUIT_BREAKER;
 import static org.mju_likelion.festival.common.exception.type.ErrorType.LOST_ITEM_NOT_FOUND_ERROR;
 import static org.mju_likelion.festival.common.exception.type.ErrorType.PAGE_OUT_OF_BOUND_ERROR;
 
+import io.github.resilience4j.circuitbreaker.annotation.CircuitBreaker;
 import java.util.List;
 import java.util.UUID;
 import lombok.RequiredArgsConstructor;
+import org.mju_likelion.festival.common.circuit_breaker.FallBackUtil;
 import org.mju_likelion.festival.common.enums.SortOrder;
 import org.mju_likelion.festival.common.exception.NotFoundException;
 import org.mju_likelion.festival.lost_item.domain.LostItem;
@@ -59,7 +62,17 @@ public SimpleLostItemsResponse searchLostItems(
   }
 
   @Cacheable(value = "lostItem", key = "#lostItemId")
+  @CircuitBreaker(name = REDIS_CIRCUIT_BREAKER, fallbackMethod = "getLostItemFallback")
   public LostItemDetailResponse getLostItem(final UUID lostItemId) {
+    return getLostItemLogic(lostItemId);
+  }
+
+  public LostItemDetailResponse getLostItemFallback(final UUID lostItemId, final Exception e) {
+    FallBackUtil.handleFallBack(e);
+    return getLostItemLogic(lostItemId);
+  }
+
+  private LostItemDetailResponse getLostItemLogic(final UUID lostItemId) {
     validateLostItemExistence(lostItemId);
     LostItemDetail lostItemDetail = lostItemQueryRepository.findLostItemDetailById(lostItemId);
 
diff --git a/src/main/java/org/mju_likelion/festival/lost_item/service/LostItemService.java b/src/main/java/org/mju_likelion/festival/lost_item/service/LostItemService.java
@@ -1,11 +1,14 @@
 package org.mju_likelion.festival.lost_item.service;
 
+import static org.mju_likelion.festival.common.config.Resilience4jConfig.REDIS_CIRCUIT_BREAKER;
 import static org.mju_likelion.festival.common.util.null_handler.NullHandler.doIfNotNull;
 
+import io.github.resilience4j.circuitbreaker.annotation.CircuitBreaker;
 import java.util.UUID;
 import lombok.RequiredArgsConstructor;
 import org.mju_likelion.festival.admin.domain.Admin;
 import org.mju_likelion.festival.admin.service.AdminQueryService;
+import org.mju_likelion.festival.common.circuit_breaker.FallBackUtil;
 import org.mju_likelion.festival.image.domain.Image;
 import org.mju_likelion.festival.lost_item.domain.LostItem;
 import org.mju_likelion.festival.lost_item.domain.repository.LostItemJpaRepository;
@@ -42,11 +45,30 @@ public void createLostItem(
   }
 
   @CacheEvict(value = "lostItem", key = "#lostItemId")
+  @CircuitBreaker(name = REDIS_CIRCUIT_BREAKER, fallbackMethod = "updateLostItemFallback")
   public void updateLostItem(
       final UUID lostItemId,
       final UpdateLostItemRequest updateLostItemRequest,
       final UUID studentCouncilId) {
 
+    updateLostItemLogic(lostItemId, updateLostItemRequest, studentCouncilId);
+  }
+
+  public void updateLostItemFallback(
+      final UUID lostItemId,
+      final UpdateLostItemRequest updateLostItemRequest,
+      final UUID studentCouncilId,
+      final Exception e) {
+
+    FallBackUtil.handleFallBack(e);
+    updateLostItemLogic(lostItemId, updateLostItemRequest, studentCouncilId);
+  }
+
+  private void updateLostItemLogic(
+      final UUID lostItemId,
+      final UpdateLostItemRequest updateLostItemRequest,
+      final UUID studentCouncilId) {
+
     LostItem lostItem = lostItemQueryService.getExistLostItem(lostItemId);
     adminQueryService.validateAdminExistence(studentCouncilId);
 
@@ -55,12 +77,31 @@ public void updateLostItem(
     lostItemJpaRepository.save(lostItem);
   }
 
-  @CacheEvict(value = "lostItem", key = "#lostItemId")
+  @CacheEvict(value = "lostItem", key = "#lostItemId", beforeInvocation = true)
+  @CircuitBreaker(name = REDIS_CIRCUIT_BREAKER, fallbackMethod = "foundLostItemFallback")
   public void foundLostItem(
       final UUID lostItemId,
       final LostItemFoundRequest lostItemFoundRequest,
       final UUID studentCouncilId) {
 
+    foundLostItemLogic(lostItemId, lostItemFoundRequest, studentCouncilId);
+  }
+
+  public void foundLostItemFallback(
+      final UUID lostItemId,
+      final LostItemFoundRequest lostItemFoundRequest,
+      final UUID studentCouncilId,
+      final Exception e) {
+
+    FallBackUtil.handleFallBack(e);
+    foundLostItemLogic(lostItemId, lostItemFoundRequest, studentCouncilId);
+  }
+
+  public void foundLostItemLogic(
+      final UUID lostItemId,
+      final LostItemFoundRequest lostItemFoundRequest,
+      final UUID studentCouncilId) {
+
     LostItem lostItem = lostItemQueryService.getExistLostItem(lostItemId);
     adminQueryService.validateAdminExistence(studentCouncilId);
 
@@ -70,7 +111,21 @@ public void foundLostItem(
   }
 
   @CacheEvict(value = "lostItem", key = "#lostItemId")
+  @CircuitBreaker(name = REDIS_CIRCUIT_BREAKER, fallbackMethod = "deleteLostItemFallback")
   public void deleteLostItem(final UUID lostItemId, final UUID studentCouncilId) {
+    deleteLostItemLogic(lostItemId, studentCouncilId);
+  }
+
+  public void deleteLostItemFallback(
+      final UUID lostItemId,
+      final UUID studentCouncilId,
+      final Exception e) {
+
+    FallBackUtil.handleFallBack(e);
+    deleteLostItemLogic(lostItemId, studentCouncilId);
+  }
+
+  private void deleteLostItemLogic(final UUID lostItemId, final UUID studentCouncilId) {
     LostItem lostItem = lostItemQueryService.getExistLostItem(lostItemId);
     adminQueryService.validateAdminExistence(studentCouncilId);
 
diff --git a/src/main/java/org/mju_likelion/festival/term/service/TermQueryService.java b/src/main/java/org/mju_likelion/festival/term/service/TermQueryService.java
@@ -1,11 +1,15 @@
 package org.mju_likelion.festival.term.service;
 
+import static org.mju_likelion.festival.common.config.Resilience4jConfig.REDIS_CIRCUIT_BREAKER;
+
+import io.github.resilience4j.circuitbreaker.annotation.CircuitBreaker;
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
 import java.util.UUID;
 import java.util.stream.Collectors;
 import lombok.RequiredArgsConstructor;
+import org.mju_likelion.festival.common.circuit_breaker.FallBackUtil;
 import org.mju_likelion.festival.common.exception.BadRequestException;
 import org.mju_likelion.festival.common.exception.type.ErrorType;
 import org.mju_likelion.festival.term.domain.Term;
@@ -25,7 +29,17 @@ public class TermQueryService {
   private final TermJpaRepository termJpaRepository;
 
   @Cacheable(value = "terms")
+  @CircuitBreaker(name = REDIS_CIRCUIT_BREAKER, fallbackMethod = "getTermsFallback")
   public List<TermResponse> getTerms() {
+    return getTermsLogic();
+  }
+
+  public List<TermResponse> getTermsFallback(final Exception e) {
+    FallBackUtil.handleFallBack(e);
+    return getTermsLogic();
+  }
+
+  private List<TermResponse> getTermsLogic() {
     return termQueryRepository.findTermsByOrderBySequenceAsc().stream()
         .map(TermResponse::of)
         .collect(Collectors.toList());
diff --git a/src/main/resources/logback-spring.xml b/src/main/resources/logback-spring.xml

Original file line number	Diff line number	Diff line change
`@@ -41,6 +41,8 @@ dependencies {`
`41`	`41`
`42`	`42`	`implementation 'com.fasterxml.jackson.datatype:jackson-datatype-jsr310:2.13.3'// Jackson`
`43`	`43`
	`44`	`+ implementation 'io.github.resilience4j:resilience4j-spring-boot3:2.0.2'// Resilience4j`
	`45`	`+`
`44`	`46`	`testImplementation 'org.springframework.boot:spring-boot-starter-test'`
`45`	`47`	`testRuntimeOnly 'org.junit.platform:junit-platform-launcher'`
`46`	`48`	`}`