StepExecutionListener

1 StepExecutionListener

• 모든 스텝은 생명주기를 갖습니다.
• 스프링 배치는 생명주기의 여러 시점에 로직을 추가할 수 있는 기능을 제공합니다.
• StepExecutionListener는 배치 작업(Step)의 실행 전후에 커스텀 로직을 수행할 수 있도록 하는 인터페이스입니다.
• 이를 통해 작업 시작 전 초기화 작업을 하거나, 작업 완료 후 정리 작업을 수행할 수 있습니다.

2 활용 사례

• 알림: Step이 시작되거나 완료될 때 알림을 보내는 로직을 추가할 수 있습니다.
• 초기화: Step 실행 전에 필요한 리소스를 초기화하는 작업을 수행할 수 있습니다.
• 정리: Step 실행 후에 사용한 리소스를 정리하거나 후처리를 수행할 수 있습니다.

3 StepExecutionListener 인터페이스

package org.springframework.batch.core;

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

    default ExitStatus afterStep(StepExecution stepExecution) {
        return stepExecution.getExitStatus();
    }
}

• beforeStep
  • 스텝을 실행하기 전에 beforeStep 메서드가 자동으로 호출됩니다.
• afterStep
  • 스텝의 처리가 완료되면 afterStep 메서드가 자동으로 호출됩니다.
  • 스텝의 완료 상태에 관계없이 호출됩니다.
  • 따라서 스텝의 종료 상태에 따라 어떤 일을 수행할지 결정할 수 있습니다.

4 구현

import org.springframework.batch.core.ExitStatus;
import org.springframework.batch.core.StepExecution;
import org.springframework.batch.core.StepExecutionListener;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;

@Slf4j
@Component
public class CustomStepExecutionListener implements StepExecutionListener {

    @Override
    public void beforeStep(StepExecution stepExecution) {
        log.info("Step 시작 전 실행: " + stepExecution.getStepName());
        // 초기화 작업 수행
    }

    @Override
    public ExitStatus afterStep(StepExecution stepExecution) {
        log.info("Step 완료 후 실행: " + stepExecution.getStepName());
        log.info("Step 상태: " + stepExecution.getExitStatus());
        // 정리 작업 수행
        return stepExecution.getExitStatus();
    }
}

• 위는 StepExecutionListener를 구현하여 Step 실행 전후에 커스텀 로직을 추가하는 예제입니다
• 위의 예제에서는 CustomStepExecutionListener가 StepExecutionListener 인터페이스를 구현하고, beforeStep과 afterStep 메서드를 오버라이드하여 Step의 실행 전후에 로그를 출력하고 있습니다.

5 StepExecutionListener 등록

@Configuration
public class BatchConfiguration {

    private final JobBuilderFactory jobBuilderFactory;
    private final StepBuilderFactory stepBuilderFactory;
    private final StepExecutionListener stepExecutionListener;

    public BatchConfiguration(JobBuilderFactory jobBuilderFactory, 
                              StepBuilderFactory stepBuilderFactory, 
                              StepExecutionListener stepExecutionListener) {
        this.jobBuilderFactory = jobBuilderFactory;
        this.stepBuilderFactory = stepBuilderFactory;
        this.stepExecutionListener = stepExecutionListener;
    }

    @Bean
    public Job sampleJob() {
        return jobBuilderFactory.get("sampleJob")
                .start(sampleStep())
                .build();
    }

    @Bean
    public Step sampleStep() {
        return stepBuilderFactory.get("sampleStep")
                .<String, String>chunk(10)
                .reader(reader())
                .processor(processor())
                .writer(writer())
                .listener(stepExecutionListener) // Listener 등록
                .build();
    }

    // reader, processor, writer 빈 정의
}

• Step을 구성할 때 listener 메서드를 사용하여 StepExecutionListener를 등록합니다