WebClient에서 에러 처리와 재시도하는 방법

서론

HTTP 요청은 네트워크 지연, 일시적인 서버 오류, 잘못된 요청 등 다양한 이유로 실패할 수 있습니다. 이런 경우 애플리케이션의 실행 흐름에 문제를 일으킬 수 있기에 에러를 올바르게 처리해야 합니다.

이번 글에서는 WebClient를 사용시 HTTP요청 과정에서 발생한 에러를 처리하는 방법과 복구하기 위해 재시도 처리하는 전략에 대해 정리해 보겠습니다.
 

 

에러 처리

onErrorReturn()

onErrorReturn()은 에러가 발생했을 때 주어진 default 값을 반환하는 메서드입니다. 이는 비동기 통신에서 중요한 역할을 하는데, 특히 네트워크 오류 또는 서버의 문제로 인한 에러가 발생했을 때 통신 자체를 중단시키지 않고, 디폴트 값을 반환하여 정상적으로 계속 작동할 수 있도록 할 수 있기 때문입니다.

webClient.get()
    .uri("/some-endpoint")
    .retrieve()
    .onStatus(HttpStatus::is4xxClientError, clientResponse -> Mono.just(new CustomClientException()))
    .onStatus(HttpStatus::is5xxServerError, clientResponse -> Mono.just(new CustomServerException()))
    .bodyToMono(String.class)
    .onErrorReturn("Default Value")
    .subscribe(System.out::println);

위 코드에서는 4xx 클라이언트 에러나 5xx 서버 에러가 발생했을 경우에는 사용자가 정의한 예외를 반환합니다. 그리고 onErrorReturn()을 사용하여 예외를 반환하는 대신 최종적으로 default 값을 반환하도록 설정됩니다. 이를 통해 에러가 발생해도 데이터 흐름이 중단되지 않고 지정된  "Default Value"라는 값이 반환되어 후속 처리가 가능합니다.

 

onErrorResume()

onErrorResume()는 에러 발생 시 대체할 수 있는 새로운 데이터 스트림을 제공하는 메서드입니다. onErrorReturn()와 비슷하지만, 더 일반적인 방법으로 에러를 처리합니다.

webClient.get()
    .uri("/some-endpoint")
    .retrieve()
    .bodyToMono(String.class)
    .onErrorResume(e -> {
        log.error("Error: ", e);
        return Mono.just("Fallback");
    })
    .subscribe(System.out::println);

위의 코드에서 onErrorResume()은 onErrorReturn()과 달리 새로운 Mono를 생성하고 "Fallback"이라는 값을 반환합니다. 이 경우, 원래의 Mono에서 에러가 발생하면 onErrorResume()에 의해 새로운 Mono로 교체되고, "Fallback" 값을 반환하게 됩니다.

 

doOnError()

doOnError()는 에러가 발생했을 때 추가적인 로직을 수행하도록 합니다. 이 방법을 사용하면 에러가 발생하면서도 명시적으로 에러를 처리하지 않고 더욱 구체적인 로직을 수행할 수 있습니다. 예를 들어, 에러가 발생할 때마다 카운터를 증가시키거나 로그를 출력하는 등의 작업을 수행할 수 있습니다.

webClient.get()
    .uri("/some-endpoint")
    .retrieve()
    .bodyToMono(String.class)
    .doOnError(e -> {
        log.error("Error occurred: ", e);
        errorCounter.incrementAndGet();
    })
    .subscribe(System.out::println);

위 코드에서, doOnError()는 에러가 발생했을 때 로그를 출력하고 에러 카운터를 증가시킵니다. 그러나 이 경우에도 onErrorReturn()이나 onErrorResume()처럼 에러를 처리하거나 새로운 스트림으로 교체는 하지 않습니다.

 

onErrorMap()

onErrorMap()은 원래의 예외를 다른 예외로 변환하는 데 사용됩니다. 이는 다양한 타입의 예외를 특정 예외로 매핑하여, 상위 레벨에서 일관된 예외 처리를 할 수 있도록 합니다.

webClient.get()
    .uri("/some-endpoint")
    .retrieve()
    .bodyToMono(String.class)
    .onErrorMap(original -> new CustomException("Something went wrong", original))
    .subscribe(System.out::println);

위 코드에서 onErrorMap()은 원래의 예외를 CustomException으로 변환합니다.
 

 

재시도 전략

retry()

retry()는 에러 발생 시 주어진 횟수만큼 재시도를 수행하는 기능을 제공합니다. 이 메서드를 사용하면 일시적인 오류로 인한 요청 실패를 자동으로 복구하는 데 유용합니다.

webClient.get()
    .uri("/some-endpoint")
    .retrieve()
    .bodyToMono(String.class)
    .retry(3)
    .subscribe(System.out::println);

위의 코드에서 retry(3)는 웹 요청이 실패하면 최대 3번까지 요청을 재시도하도록 설정합니다. 따라서 일시적인 네트워크 오류나 서버 오류 등으로 인해 요청이 실패하더라도 설정한 만큼 재시도하여 성공적으로 응답을 받을 수 있습니다.

 

retryWhen()

retryWhen()는 retry()보다 좀 더 전략을 세밀하게 설정할 수 있습니다. 예를 들어, 특정 시간 간격으로 재시도하거나, 특정 조건을 만족할 때만 재시도를 수행하는 등의 복잡한 재시도 전략을 설정할 수 있습니다.

webClient.get()
    .uri("/some-endpoint")
    .retrieve()
    .bodyToMono(String.class)
    .retryWhen(Retry.backoff(3, Duration.ofSeconds(1)))
    .subscribe(System.out::println);

위 코드에서 retryWhen(Retry.backoff(3, Duration.ofSeconds(1)))는 요청이 실패하면 최대 3번까지 재시도하되, 각 재시도 사이에는 1초의 딜레이를 가지도록 설정합니다. 

 

retryBackOff()

retryBackOff()는 실패한 작업을 재시도하는 동안 지수 백오프 전략을 수행합니다. 즉, 재시도 간의 지연 시간이 점차적으로 증가하도록 하여, 서버에 불필요한 부하를 주지 않도록 합니다. 지연 시간의 최대치를 설정하거나 재시도 횟수의 최대치를 설정할 수도 있습니다.

webClient.get()
    .uri("/some-endpoint")
    .retrieve()
    .bodyToMono(String.class)
    .retryBackoff(3, Duration.ofMillis(100), Duration.ofSeconds(1))
    .subscribe(System.out::println);

위 코드에서는 요청이 실패하면 최대 3번까지 재시도하며, 각 재시도 사이의 지연 시간은 초기 지연시간인 100밀리 초부터 시작하여, 각 재시도마다 지수적으로 증가하며, 1초를 초과하지 않습니다.
 

기타

timeout()

timeout()은 지정된 시간 내에 원하는 결과가 도달하지 않을 경우 TimeoutException을 발생시킵니다.

webClient.get()
    .uri("/some-endpoint")
    .retrieve()
    .bodyToMono(String.class)
    .timeout(Duration.ofSeconds(1))
    .subscribe(System.out::println);

위 코드에서는 요청에 대한 응답이 1초 이내에 도달하지 않으면 TimeoutException이 발생합니다.

 

repeat()

repeat()는 성공적으로 완료된 작업을 반복하는 메서드입니다. 이는 오류가 아니라 성공적으로 완료된 작업에 대한 반복이 필요할 때 사용되는데, 예를 들어, 데이터를 주기적으로 가져와야 하는 경우 repeat() 함수를 사용하여 요청을 정기적으로 반복할 수 있습니다.

webClient.get()
    .uri("/some-endpoint")
    .retrieve()
    .bodyToMono(String.class)
    .repeat(3)
    .subscribe(System.out::println);

위 코드는 웹 요청을 성공적으로 완료한 후에 3번 더 요청을 반복합니다.
 

 

마무리

WebClient를 사용하여 HTTP 요청을 보낼 때, 이러한 다양한 에러 처리와 재시도 전략을 사용하면 발생할 수 있는 다양한 문제들을 보다 효과적으로 처리하고 복구할 수 있습니다.