스프링(Spring) 서킷브레이커 패턴 적용하기 (feat. Resilience4J)

                                    implementation("org.springframework.boot:spring-boot-starter-aop:3.3.4")
implementation("io.github.resilience4j:resilience4j-spring-boot3:2.2.0")
annotationProcessor("org.springframework.boot:spring-boot-configuration-processor:3.3.4")

                                    resilience4j:
  circuitbreaker:
    configs:
      default:
        registerHealthIndicator: true # 상태 모니터링을 위한 Health Indicator 등록
        failure-rate-threshold: 10 # 실패율 임계치 10%
        permitted-number-of-calls-in-half-open-state: 5 # half-Open -> Open 시스템 회복 테스트 수
        sliding-window-size: 5  # 상태 평가시 사용되는 Sliding-window : 최근 5회
        sliding-window-type: COUNT_BASED # 호출 횟수 기준으로 동작
        wait-duration-in-open-state: 10s # 10초 만큼 Open 이후 half-Open으로 전환
        automatic-transition-from-open-to-half-open-enabled: true # 자동으로 open -> half-open

                                    @Service
class LikeApiService(
    private val webConfig: WebConfig,
    private val circuitBreakerRegistry: CircuitBreakerRegistry,
    private val kafkaProducerService: KafkaProducerService,
    private val boardRepository: BoardRepository
) {
    private val circuitBreaker = circuitBreakerRegistry.circuitBreaker("likeApiCircuitBreaker")
    private val logger = KotlinLogging.logger {}
    private val baseUrl = "http://localhost:8082"

    val likeServerWebClient = webConfig.createWebClient(
        baseUrl = baseUrl,
    )

    @CircuitBreaker(
        name = "likeApiCircuitBreaker",
        fallbackMethod = "saveFallback")
    fun saveRequest(likeRequest: LikeSaveRequest): LikeSaveResult { // userId = active user

        val response = likeServerWebClient.post()
            .uri { uriBuilder: UriBuilder ->
                uriBuilder
                    .path("/like")
                    .build()
            }
            .bodyValue(
                LikeSaveRequest(
                    boardId = likeRequest.boardId,
                    userId = likeRequest.userId,
                    likeType = likeRequest.likeType,
                )
            )
            .headers { headers ->
                headers.remove(HttpHeaders.AUTHORIZATION)
            }
            .retrieve()
            .bodyToMono(LikeServerSaveResponse::class.java)
            .block()

        logger.info {"Like save Api response: ${response}"}

        return if (response != null && response.errorCode == MSAServerErrorCode.SUCCESS.code) {
            val targetBoard = boardRepository.findById(likeRequest.boardId).orElseThrow {
                NotFoundEntityException(entityType = EntityType.BOARD.code, id = likeRequest.boardId)
            }
            kafkaProducerService.sendNoti(
                NotificationSaveRequest(
                    publisherId = likeRequest.userId,
                    receiverId = targetBoard.writerId,
                    notificationType = NotificationType.LIKE,
                    targetBoardId = null
                )
            )
            LikeSaveResult.of(response.result)
        } else {
            // is it ok ?
            logger.error {"response is null"}
            LikeSaveResult(null, null)
        }
    }

   // save 메서드의 fallbackMethod
   fun saveFallback(likeReqeust: LikeSaveRequest, throwable: Throwable): LikeSaveResult {
        logger.error { "run save fallback ${throwable.message}" }
        logCircuitBreakerInfo()
        return LikeSaveResult(null, null)
    }

    private fun logCircuitBreakerInfo() {
        val metrics = circuitBreaker.metrics

        logger.info { "CircuitBreaker state: ${circuitBreaker.state}" }
        logger.info { "Number of successful calls: ${metrics.numberOfSuccessfulCalls}" }
        logger.info { "Number of failed calls: ${metrics.numberOfFailedCalls}" }
        logger.info { "Failure rate: ${metrics.failureRate}%" }
    }
}

                                    👉 @CircuitBreaker를 사용하면 Resilience4j가 내부적으로 지정된 이름의 circuit breaker 인스턴스를
자동으로 관리해준다. - Registry 필요 x

👉 상태를 찍어보기 위해서는 Registry를 직접 주입 받아서 로깅 가능하다.

👉 fallback method는 반드시 parameter와 return type이 일치해야한다.
   - 단, Throwable을 필수적으로 받아야 한다.

                                    🤔 fallback은 언제 발동되는가 ?
- 일반적으로 200번대 return이 안나오면 대부분 fallback으로 간주됩니다.
- 단, 설정을 통해서 변경이 가능합니다 -> 찾아보세용

🤔 fallback Exception 등록
- fallback을 count할 Exception을 따로 등록할 수 있습니다.
- 근데 등록하면 기존(default) 등록된 Exception이 삭제되므로 유의하세요!