4. Batch Listener

Spring Batch Listener

리스너는 배치 처리의 주요 순간들을 관찰하고 각 시점에 필요한 동작을 정의할 수 있는 강력한 도구이다. 즉, 배치 처리 중 발생하는 특정 이벤트를 감지하고 원하는 로직을 실행할 수 있게 해준다.

Job 시작 전후, Step 실행 전후는 물론, 청크 단위 또는 아이템 단위 처리 시점까지 모든 과정에 개입할 수 있다. 이를 통해 로깅, 모니터링, 에러 처리 등 우리가 원하는 로직을 자유롭게 추가할 수 있다.

JobExecutionListener

JobExecutionListener는 Job 실행의 시작과 종료 시점에 호출되는 리스너 인터페이스이다.

public interface JobExecutionListener {
    default void beforeJob(JobExecution jobExecution) { }
    default void afterJob(JobExecution jobExecution) { }
}

beforeJob()은 Job 실행 직전에 호출되며, Job 시작 전 필요한 리소스를 준비하는 등의 초기화 작업을 수행할 수 있다.

afterJob()은 Job 실행 후에 호출되어 Job 실행 결과를 이메일로 전송하거나, 리소스를 정리하는 등의 후처리 작업을 수행할 수 있다. 특히 Job의 성공/실패 여부와 관계없이 무조건 호출되기 때문에, 실패 시 알림을 보내거나 더 나아가 실패한 Job의 상태를 변경하는 작업까지 안전하게 수행할 수 있다.

StepExecutionListener

StepExecutionListener는 Step 실행의 시작과 종료 시점에 호출되는 리스너 인터페이스다. Step의 시작 시간, 종료 시간, 처리된 데이터 수를 로그로 기록하는 등의 사용자 정의 작업을 추가할 수 있다.

public interface StepExecutionListener extends StepListener {
    default void beforeStep(StepExecution stepExecution) {
    }

    @Nullable
    default ExitStatus afterStep(StepExecution stepExecution) {
    return null;
    }
}

beforeStep()은 Step의 시작 시점, 정확히는 StepScope가 활성화된 직후에 호출된다. Step 실행 전 필요한 초기화 작업을 수행할 수 있다.

afterStep()은 Step 종료 시점에 호출된다. JobExecutionListener의 afterJob()과 마찬가지로 Step의 성공/실패 여부와 관계없이 무조건 호출되기 때문에, 실패 처리나 리소스 정리 등 안전한 후처리 작업을 수행할 수 있다.

ChunkListener

지난 작전에서 설명했듯이 청크 지향 처리는 청크 단위로 아이템 읽기/쓰기를 반복한다. ChunkListener는 이러한 하나의 청크 단위 처리가 시작되기 전, 완료된 후, 그리고 실행 도중 에러가 발생했을 때 호출되는 리스너 인터페이스다. 각 청크의 처리 현황을 모니터링하거나 로깅하는데 사용할 수 있다.

public interface ChunkListener extends StepListener {
    default void beforeChunk(ChunkContext context) {
    }

    default void afterChunk(ChunkContext context) {
    }

    default void afterChunkError(ChunkContext context) {
    }
}

afterChunk()는 트랜잭션이 커밋된 후에 호출된다. 반면 청크 처리 도중 예외가 발생하면 호출되는 afterChunkError()는 청크 트랜잭션이 롤백된 이후에 호출된다.