Spring Batch (6) ExecutionContext

📎 ExecutionContext

지난 시간에는 Step, StepExecution에 대해 살펴보았습니다.

 

이번 시간에는 JobExecution 및 StepExecution 객체에 존재하는 ExecutionContext에 대해 살펴보겠습니다.

(예제 코드는 GitHub에서 확인할 수 있습니다. 😃)

 

 

📌 해당 포스팅의 목표

• Spring Batch ExecutionContext (JobExecution, StepExecution)

 

 

📌 ExecutionContext

기본 개념

• Spring Batch 프레임워크에서 지원하는 key/value 형식 공유 객체로 Job을 실행하면서 필요한 데이터를 저장하는 공간
• 공유 범위
  • Job 범위 - 각 Job의 JobExecution에 저장되며 서로 다른 Job 간에는 공유가 안되지만 동일한 Job 내의 서로 다른 Step 사이에서는 데이터 공유가 가능
  • Step 범위 - 각 Step의 StepExecution에 저장되며 Step 사이에서는 데이터 공유 불가능

 

※ ExecutionContext는 JobExecution 및 StepExecution의 필드에 존재합니다.

public class JobExecution extends Entity {

	private final JobParameters jobParameters;

	private JobInstance jobInstance;

	private volatile Collection<StepExecution> stepExecutions = Collections.synchronizedSet(new LinkedHashSet<>());

	...

	private volatile ExecutionContext executionContext = new ExecutionContext();
    
}


public class StepExecution extends Entity {

	private final JobExecution jobExecution;

	private final String stepName;

	private volatile BatchStatus status = BatchStatus.STARTING;
    
	...
    
	private volatile ExecutionContext executionContext = new ExecutionContext();
    
}

 

 

 

예제 코드

@RequiredArgsConstructor
@Configuration
public class ExecutionContextConfiguration {
 
    private final JobBuilderFactory jobBuilderFactory;
    private final StepBuilderFactory stepBuilderFactory;
 
    private final ExecutionContextTasklet1 executionContextTasklet1;
    private final ExecutionContextTasklet2 executionContextTasklet2;
    private final ExecutionContextTasklet3 executionContextTasklet3;
    private final ExecutionContextTasklet4 executionContextTasklet4;
 
    @Bean
    public Job executionContextJob() {
        return this.jobBuilderFactory.get("executionContextJob")
                .start(executionContextStep1())
                .next(executionContextStep2())
                .next(executionContextStep3())
                .next(executionContextStep4())
                .build();
    }
 
    @Bean
    public Step executionContextStep1() {
        return stepBuilderFactory.get("executionContextStep1")
                .tasklet(executionContextTasklet1)
                .build();
    }
 
    @Bean
    public Step executionContextStep2() {
        return stepBuilderFactory.get("executionContextStep2")
                .tasklet(executionContextTasklet2)
                .build();
    }
 
    @Bean
    public Step executionContextStep3() {
        return stepBuilderFactory.get("executionContextStep3")
                .tasklet(executionContextTasklet3)
                .build();
    }
 
    @Bean
    public Step executionContextStep4() {
        return stepBuilderFactory.get("executionContextStep4")
                .tasklet(executionContextTasklet4)
                .build();
    }
}
 

 

@Slf4j
@Component
public class ExecutionContextTasklet1 implements Tasklet {
 
    @Override
    public RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception {
        ExecutionContext jobExecutionContext = chunkContext.getStepContext().getStepExecution().getJobExecution().getExecutionContext();
        ExecutionContext stepExecutionContext = chunkContext.getStepContext().getStepExecution().getExecutionContext();
 
        String jobName = chunkContext.getStepContext().getStepExecution().getJobExecution().getJobInstance().getJobName();
        String stepName = chunkContext.getStepContext().getStepExecution().getStepName();
 
        log.info("ExecutionContextTasklet1 JobName: {}", jobExecutionContext.get("jobName"));
        log.info("ExecutionContextTasklet1 StepName: {}", stepExecutionContext.get("stepName"));
 
        // Job ExecutionContext에 데이터가 존재하지 않는 경우 저장
        if (jobExecutionContext.get("jobName") == null) {
            jobExecutionContext.put("jobName", jobName);
        }
 
        // Step ExecutionContext에 데이터가 존재하지 않는 경우 저장
        if (stepExecutionContext.get("stepName") == null) {
            stepExecutionContext.put("stepName", stepName);
        }
 
        log.info("ExecutionContextTasklet1 JobName: {}", jobExecutionContext.get("jobName"));
        log.info("ExecutionContextTasklet1 StepName: {}", stepExecutionContext.get("stepName"));
 
        return RepeatStatus.FINISHED;
    }
}
 

 

@Slf4j
@Component
public class ExecutionContextTasklet2 implements Tasklet {
 
    @Override
    public RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception {
        ExecutionContext jobExecutionContext = chunkContext.getStepContext().getStepExecution().getJobExecution().getExecutionContext();
        ExecutionContext stepExecutionContext = chunkContext.getStepContext().getStepExecution().getExecutionContext();
 
        // Tasklet1에서 ExecutionContext 공간에 저장한 데이터 조회(Job 내의 Step들은 데이터 공유 가능)
        log.info("ExecutionContextTasklet2 JobName: {}", jobExecutionContext.get("jobName"));
        log.info("ExecutionContextTasklet2 StepName: {}", stepExecutionContext.get("stepName"));
 
        String stepName = chunkContext.getStepContext().getStepExecution().getStepName();
 
        if (stepExecutionContext.get("stepName") == null) {
            stepExecutionContext.put("stepName", stepName);
        }
 
        return RepeatStatus.FINISHED;
    }
}
 

 

@Component
public class ExecutionContextTasklet3 implements Tasklet {
 
    @Override
    public RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception {
        Object name = chunkContext.getStepContext().getStepExecution().getJobExecution().getExecutionContext().get("name");
 
        // 예외 발생 시 이후 Step은 실행 X
        if (name == null) {
            chunkContext.getStepContext().getStepExecution().getJobExecution().getExecutionContext().put("name", "user1");
            throw new RuntimeException("step has failed");
        }
 
        return RepeatStatus.FINISHED;
    }
}
 

 

@Slf4j
@Component
public class ExecutionContextTasklet4 implements Tasklet {
 
    @Override
    public RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception {
        log.info("name: {} ", chunkContext.getStepContext().getStepExecution().getJobExecution().getExecutionContext().get("name"));
 
        return RepeatStatus.FINISHED;
    }
}
 

 

 

예제 코드는 4개의 Tasklet 구현체 클래스와 1개의 Job, Step, Tasklet 설정 클래스입니다.

 

위 기본 개념에서 말씀드렸던 JobExecution의 경우 서로 다른 Job들 사이에서는 공유가 안되지만 동일한 Job 내의 Step들 사이에는 데이터가 공유된다고 말씀을 드렸었는데요, 위 예제 코드를 통해 실제 데이터가 공유되는지 살펴보겠습니다.

 

 

ExecutionContextConfiguration

• Job, Step, Tasklet 구성 및 build

 

ExecutionContextTasklet1

• 최초 실행되는 Tasklet으로 JobExecution 및 StepExecution 내에 존재하는 ExecutionContext에 key가 jobName, stepName인 데이터를 조회하고 없으면 데이터를 저장합니다.
• 참고로 execute 메서드의 contribution, context 어떠한 Execution를 참조하든 상관이 없습니다.
• https://stackoverflow.com/questions/61828817/stepcontribution-or-chunkcontext-for-executioncontext-info

ExecutionContextTasklet1

Spring Batch Job이 실행된 후 Tasklet1이 호출될 당시에는 ExecutionContext 저장소에 아무런 데이터(key/value)가 존재하지 않기 때문에 jobExecutionContext, stepExecutionContext의 map에는 아무런 값도 존재하지 않습니다.

(batch.taskletType, bacth.stepType의 경우 실행될 때 이미 존재하는 값으로 뒤에서 데이터베이스에 저장된 데이터와 함께 추가로 설명드리겠습니다.)

 

이후 조건문을 통해 jobExecutionContext, stepExecutionContext에 'jobName', 'stepName'를 key로 하는 데이터를 저장합니다.

ExecutionContextTasklet1

따라서 해당 Tasklet이 종료되면 Job, Step의 ExecutionContext에는 jobName, stepName을 key로 가지는 데이터가 저장됩니다.

 

 

 

ExecutionContextTasklet2

• ExecutionContext가 Job, Step 간 데이터 공유가 가능한지 파악하기 위해 Tasklet1에서 저장한 데이터를 조회하여 확인합니다.

ExecutionContextTasklet2

ExecutionContext의 데이터를 확인해 보면 jobExecutionContext에는 이전 Tasklet1에서 저장한 {jobName:executionContextJob} 데이터가 존재하고, stepExecutionContext에는 기존 값 외 아무런 데이터도 존재하지 않는 걸 확인할 수 있습니다.

즉, JobExecution의 ExecutionContext 내의 데이터들은 Step들 사이에서는 데이터 공유가 가능합니다.

 

 

 

ExecutionContextTasklet3

• JobExecution의 ExecutionContext에서 key가 name인 데이터를 조회한 후 존재하지 않으면 user1이라는 데이터를 저장한 후 예외를 발생시킵니다.

ExecutionContextTasklet3

다음으로 Tasklet3에서 JobExecution의 ExecutionContext에는 key가 name인 데이터가 존재하기 않기 때문에 예외를 발생시킨 후 Job을 중지하고, 이후 Tasklet4는 실행이 되지 않습니다.

 

현재까지 실행된 Job & Step에 대한 데이터베이스에 저장된 데이터를 살펴보면 다음과 같습니다.

BATCH_JOB_EXECUTION

BATCH_JOB_EXECUTION_CONTEXT

BATCH_STEP_EXECUTION

BATCH_STEP_EXECUTION_CONTEXT

마지막 사진인 BATCH_STEP_EXECUTION_CONTEXT에는 위에서 살펴보았던 map의 기본 데이터를 포함하여 SHORT_CONTEXT 컬럼에 저장을 합니다.

 

위 상태에서 Spring Batch를 다시 실행해보면 이전과는 달리 Tasklet3에서 JobExecution의 ExecutionContext 저장소에 key가 name인 데이터가 존재하기 때문에 예외가 발생하지 않고 실패했던 step인 Tasklet3와 수행되지 않았던 Tasklet4가 정상적으로 수행됩니다.

 

 

ExecutionContextTasklet4

• JobExecution의 ExecutionContext 내에 key가 name인 데이터를 출력합니다.

 

 

📌 정리

(참고: 인프런 Spring Batch)

 

위 사진을 토대로 정리해 보면 다음과 같습니다.

• JobExecution에서 생성되는 ExecutionContext
  • 서로 다른 Job은 데이터 공유 불가능
  • 동일한 Job 내에서 Step 사이에서는 공유 가능
• StepExecution에서 생성되는 ExecutionContext
  • Step 사이에서도 공유가 불가능

 

 

 

참고 문서

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