Spring Batch (12) Retry

🔗  Spring Batch Retry (Tasklet 기반)

예제 코드는 깃허브에서 확인할 수 있습니다 :)

서비스에서 재시도가 필요한 경우는 언제일까요? 비즈니스 로직 오류와 같은 내가 작성한 애플리케이션에 의해 발생한 에러는 재시도를 하더라도 동일하게 실패할 경우가 큽니다.

 

하지만 네트워크와 같은 일시적으로 발생할 수 있는 장애 상황에서는 유용하게 사용할 수 있습니다. 

대표적으로는 데이터베이스 I/O와의 타임아웃, API 호출 시 발생하는 타임아웃 등이 있겠네요.

 

최근 사내에서 외부 API를 호출하는 과정에서 간헐적으로 아래와 같은 예외가 발생했습니다.

reactor.core.Exceptions$ReactiveException: io.netty.channel.unix.Errors$NativeIoException: readAddress(..) failed: 연결이 상대편에 의해 끊어짐

최근에 갑자기 발생한 케이스로 아직 정확한 원인은 파악하지 못했지만, 해당 API를 재처리하면 2~3회 시도 후 정상 처리가 됩니다.

해당 API를 호출하는 프로젝트는 Spring Batch 프로젝트로 Chunk Oriented가 아닌 Tasklet 기반으로 Job이 이루어져있습니다.

 

따라서 Tasklet 기반 Batch에서는 Retry 기능을 구현하는 방법에 대해 간략히 살펴봅니다.

 

 

 

RetryOperations, RetryTemplate

Retry 기능은 Spring Batch 2.2 버전부터 제외되어서 현재는 Spring retry 라이브러리에 존재하는데요, 이는 retry 기능이 스프링의 다른 프레임워크에도 유용한 기능이기 때문에 Batch가 아닌 spring 라이브러리에 포함되었다고 합니다.

The ability to retry an operation via the RetryTemplate has always been a feature of Spring Batch. That ability has been identified as a useful feature for other frameworks (Spring Integration for example). With the 2.2.0 release, the retry logic has been extracted from Spring Batch into it's own library called Spring Retry. With this change, there are two main impacts. The first is that the majority of the 
org.springframework.batch.retry package has been moved into this new library. With that move, the package name has also dropped the batch to become org.springframework.retry

https://docs.spring.io/spring-batch/docs/2.2.x/reference/html/whatsNew.html

Spring Retry는 최상위 RetryOperations 인터페이스가 존재하고, 구현체인 RetryTemplate 클래스가 존재합니다.

 

RetryTemplate 클래스에서 재시도 최대 횟수, 재시도 간격, Listeners, 재시도 처리할 예외 설정 등을 지정할 수 있습니다.

 

 

 

RetryConfig

RetryTemplate을 Bean으로 등록하여 재시도 할 횟수, 간격, 예외 클래스 등을 설정합니다.

custom 메서드를 사용하든, 직접 값을 설정하는 maxAttempts와 같은 메서드를 사용하든 크게 상관은 없습니다.

(재시도 기본 횟수: 3, 재시도 기본 간격: 1초)

 

retryOn() 및 notRetryOn() 메서드는 하나만 사용을 하라고 합니다.

(retryOn() 메서드와 notRetryOn() 메서드에 동일한 예외를 설정하는 경우 등을 고려하여 하나의 메서드만 사용해야 하는 것이 아닐지 조심스레 생각해 봅니다.. 🧐)

 

 

 

Spring Batch Job

Job에서 RetryTemplate을 주입받고, 실제 로직을 처리하는 Tasklet에서 execute() 메서드를 통해 재시도 기능을 구현합니다.

 

RetryTemplate에는 여러 개의 execute() 메서드가 존재합니다.

저는 두 번째 RetryCallback, RecoveryCallback를 인자로 받는 메서드를 사용했고, 위 메서드들은 모두 doExecute() 메서드를 호출을 하는데요, 이 메서드가 실제로 재처리가 이루어지는 곳입니다.

 

RetryTemplate - execute()

실제 retry 로직이 실행되는 RetryTemplate의 doExecute() 메서드인데요, 동작 과정은 다음과 같습니다.

(메서드가 길어서 핵심 로직을 제외한 코드는 일부 제거하였습니다.)

1. 재시도가 가능한 동안 반복적 실행
2. 재시도 처리
3. 2)에서 재시도 처리 후 예외가 발생한 경우, lastException 설정 및 재시도 횟수(count) + 1 증가 
4. backOff를 위해 재시도가 가능한지 다시 확인
5. 재시도 간격 backOff
6. 재시도 최대 횟수 시도 후 실패인 경우 Recover 로직 수행

 

 

Spring Batch Job Test

Job을 실행해 보면 1초 간격으로 재시도가 되고, maxAttempt인 3회 시도 후 실패할 경우 Recover 로직이 수행이 됩니다.

 

 

 

@Retryable 및 Chunk Oriented Retry

Retry를 구현하는 다른 방법으로 어노테이션과 Chunk 기반 적용하는 방법이 존재합니다.

 

1. @Retryable

@Retryable은 외부 라이브러리 추가 및 @Retryable 어노테이션과 설정 파일에 @EnableRetry만 선언하면 끝입니다.

(참고: https://www.baeldung.com/spring-retry)

 

2. Chunk Oriented Retry

Chunk 기반 Batch에서도 Retry는 매우 간단하게 적용이 가능합니다.

(참고: https://www.baeldung.com/spring-batch-retry-logic)