Spring Batch (11) Repeat

🔗  Spring Batch Repeat

• Batch Processing는 단순 최적화 또는 반복적인 작업에 관한 것입니다.
• 반복을 전략화하고 일반화하기위해 Spring Batch에서는 반복 작업을 제어하는 RepeatOperation 인터페이스를 가지고 있습니다.
• 인터페이스의 구현체는 RepeatTemplate 클래스 입니다

https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-%EB%B0%B0%EC%B9%98/

 

 

🔗  반복 종료를 결정하는 세 가지 항목

Spring Batch에서의 반복 작업에 대한 종료 처리는 RepeatTemplate 클래스에서 설정할 수 있습니다.

 

1. RepeatStatus

• 스프링 배치의 작업이 종료되었는지 판별하기 위한 Enum

 

2. CompletionPolicy

• RepeatTemplate 내부에서 반복 메서드의 종료는 CompletionPolicy에 의해 결정됩니다.
• 실행 횟수 또는 완료시기, 오류 발생 시 수행할 작업에 대한 반복여부 결정
• SimpleCompletionPolicy에서는 RepeatStatus를 사용하여 최대 고정 횟수(ChunkSize)만큼 실행할 수 있습니다.

• TimeoutTerminationPolicy: 반복 시점부터 현재 시점까지 소요된 시간이 설정된 시간보다 크면 반복종료(기본 타임아웃: 30초)
• SimpleCompletionPolicy: 현재 반복 횟수가 ChunkSize 갯수보다 크면 반복종료(Default Chunk Size: 5)
• CountingCompletionPolicy: 일정 카운트를 계산 및 집계해서 카운트 제한 조건이 만족하면 반복 종료

 

3. ExceptionHandler

• RepeatCallback 내부에서 예외가 발생하면 RepeatTemplate가 ExceptionHandler를 참조하여 예외를 다시 던질지 여부를 결정합니다.
• 비정상 종료를 알리는데 사용합니다.

ExceptionHandler의 경우 배치 처리 중 예외가 발생하면 설정해놓은 구현체에 진입합니다.

그 후 예외 정보를 토대로 각 핸들러가 가지고 있는 조건이 있는데 예외를 다시 던질지 혹은 무시할지 결정할 수 있습니다.

• LogOrRethrowExceptionHandler: 예외를 로그로 기록할지 아니면 다시 던질지 결정
• RethrowOnThresholdExceptionHandler: 지정된 유형의 예외가 임계값(Threshold)에 도달하면 다시 발생
• SimpleLimitExceptionHandler: ExceptionHandler 인터페이스의 기본 구현체로, 사용 사례는 지정된 유형의 예외 타입 중 하나가 발견되면 카운터가 증가하고, 제한에 도달하면 실패합니다. 이러한 목적으로 Spring Batch에서는 SimpleLimitExceptionHandler와 더 유연한 RethrowOnThresholdExceptionHandler를 제공합니다.
  handleException() 메서드는 RethrowOnThresholdExceptionHandler 클래스에 위임하여 처리합니다.

 

 

RepeatStatus, CompletionPolicy, ExceptionHandler의 반복 처리

• RepeatOperation 인터페이스의 구현체인 RepeatTemplate에서 반복을 종료할 때까지 실제 비즈니스 로직을 구현한 RepeatCallback을 호출합니다.
• RepeatCallback에는 doInIteration() 메서드가 수행되며, 상태정보를 저장하는 RepeatContext를 매개변수로 받고, 리턴 값으로는 반복 상태를 나타내는 RepeatStatus 입니다.

 

https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-%EB%B0%B0%EC%B9%98/

Spring Batch의 Step 내에 존재하는 RepeatOperations(RepeatTemplate)을 통해 RepeatCallback을 반복적으로 호출합니다.

그 후 RepeatCallback의 메서드인 doInIteration() 메서드에서 Tasklet을 처리하고 난 후 앞서 살펴봤었던 반복 종료를 결정하는 항목들(ExceptionHandler, CompletionPolicy, RepeatStatus)의 조건에 따라 반복문을 종료할지를 결정합니다.

 

 

🔗  코드 살펴보기

예제 코드는 CompletionPolicy 인터페이스의 구현체 중 하나인 SimpleCompletionPolicy 클래스에서 ChunkSize를 3으로 설정하여 3번의 작업 후 반복문을 종료하는 코드를 살펴보겠습니다.

(코드에서 주석으로 처리해놓은 곳은 여러 개의 CompletionPolicy 구현체를 설정하거나, ExcceptionHandler를 설정하는 코드입니다.)

 

Job

58라인에서 RepeatTemplate의 setCompletionPolicy() 메서드를 통해 CompletionPolicy를 설정합니다.

RepeatTemplate

 

 

Job의 작업을 처리한 후 RepeatTemplate 클래스에서 작업이 완료되었는지 확인합니다.

count의 값이 ChunkSize의 값인 3보다 작으므로 종료되지 않고 배치 작업이 반복 처리가 됩니다.

 

 

RepeatTemplate

위 코드는 RepeatTemplate 클래스의 executeInternal() 메서드 일부입니다.

215라인의 getNextResult() 메서드를 통해 작업이 처리가 되고, count가 1씩 증가합니다.

 

Job

ChunkSize가 3이므로 세 번 반복 실행 후 종료하고 Job의 process() 메서드를 종료합니다.

 

 

📄  참고 문서

• https://docs.spring.io/spring-batch/docs/current/reference/html/index-single.html#late-binding
• https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-%EB%B0%B0%EC%B9%98/dashboard