섹션 5. 스프링 배치 실행 - Step

[0JUUU]

• [x] StepBuilderFactory
• [x] TaskletStep - 개념 및 API 소개
• [x] TaskletStep - tasklet()
• [x] TaskletStep - startLimit() / allowStartIfComplete()
• [x] TaskletStep 아키텍처
• [x] JobStep

[0JUUU]

StepBuilderFactory

StepBuilderFactory

• StepBuilder를 생성하는 팩토리 클래스 ➡️ get(String name) 메서드 제공

  StepBuilder

• Step을 구성하는 설정 조건에 따라 다섯 개의 하위 빌더 클래스를 생성하고 하위 빌더 클래스에게 실제 Step 생성을 위임
• TaskletStepBuilder
  • Tasklet을 생성하는 기본 빌더 클래스 ➡️ Tasklet 구현체
• SimpleStepBuilder
  • Tasklet을 생성하여 내부적으로 Chunk 기반의 작업을 처리하는 ChunkOrientedTasklet 클래스 생성
• PartitionStepBuilder
  • PartitionStep을 생성하여 멀티 스레드 방식으로 Job 실행
• JobStepBuilder
  • JobStep을 생성하여 Step 안에서 Job 실행
• FlowStepBuilder
  • FlowStep을 생성하여 Step 안에서 Flow 실행

상속 구조

[0JUUU]

TaskletStep - 개념 및 API 소개

• 스프링 배치에서 제공하는 Step의 구현체 ➡️ Tasklet을 실행시키는 도메인 객체
• RepeatTemplate(반복하는 기능을 가짐) 사용 ➡️ Tasklet 구문을 트랜잭션 경계 내에서 반복 실행
• Task 기반과 Chunk 기반으로 나누어 Tasklet 샐행

Task vs Chunk

• Chunk 기반
  • 하나의 큰 덩어리를 n개씩 나눠 실행
  • 대량 처리를 하는 경우 효과적
  • ItemReader, ItemProcessor, ItemWriter 사용 ➡️ Chunk 기반 전용 Tasklet인 ChunkOrientedTasklet 구현체 제공
  • Task 기반
    • 단일 작업 기반으로 처리되는 것에 효율적
    • Tasklet 구현체를 만들어 사용

사용 방법

[0JUUU]

TaskletStep - tasklet()

• Tasklet 타입의 클래스 설정
• 익명 클래스 or 구현 클래스를 만들어 사용
• 실행 시 TaskletStepBuilder 반환 ➡️ 관련 API 설정 가능
• Step에 오직 하나의 Tasklet 설정 가능 ➡️ 2개 이상 설정했을 경우, 마지막으로 설정한 객체가 실행

Tasklet

• Step 내에서 구성 & 실행되는 도메인 객체 ➡️ 단일 태스크 수행을 위한 것
• TaskletStep에 의해 반복적 수행 ➡️ 반환값에 따라 수행 여부 결정
• RepeatStatus - Taskle 반복 여부 상태 값
  • RepeatStatus.FINISHED - 종료, null로 반환 시 같은 의미로 해석됨
  • RepeatStatus.CONTINUABLE - 반복

[0JUUU]

TaskletStep - startLimit() / allowStartIfComplete()

startLimit()

• Step의 실행 횟수 조절
• 설정값 초과 & 다시 실행 ➡️ StartLimitExceededException 발생
• default : Integer.MAX_VALUE

startLimit 확인

    @Bean
    public Step step2() {
        return stepBuilderFactory.get("step2")
            .tasklet(new Tasklet() {
                @Override
                public RepeatStatus execute(StepContribution stepContribution, ChunkContext chunkContext) throws Exception {
                    System.out.println("stepContribution = " + stepContribution + ", chunkContext = " + chunkContext);
                    throw new RuntimeException("");
//                        return RepeatStatus.FINISHED;
                }
            })
            .startLimit(3)
            .build();
    }

• Step에 startLimit 설정 ➡️ 횟수 제한

처음 실행 - BATCH_STEP_EXECUTION

Step2 3번 이상 실행

• StartLimitExceededException 에러 발생

allowStartIfComplete(true)

• 재시작 가능한 Job에서 Step의 이전 성공 여부와 상관 없이 항상 step을 실행하기 위한 설정
• 실행마다 유효성 검증 or 사전 작업이 꼭 필요한 Step 에 사용

BATCH_STEP_EXECUTION

• 기본 : 성공한 Step은 재 실행 ❌
• allowStartComplete(true) 설정 : 성공한 Step도 재 실행 ⭕️

[0JUUU]

TaskletStep 아키텍처

[0JUUU]

JobStep

• Job에 속하는 Step 중 외부 Job을 포함하고 있는 Step
• 모든 메타데이터 : 기본 Job과 외부 Job별로 각각 저장

// 실습코드
@RequiredArgsConstructor
@Configuration
public class JobStepConfiguration {

    private final JobBuilderFactory jobBuilderFactory;
    private final StepBuilderFactory stepBuilderFactory;

    @Bean
    public Job parentJob() {
        return this.jobBuilderFactory.get("parentJob")
                                     .start(jobStep(null))
                                     .next(step2())
                                     .build();
    }

    @Bean
    public Step jobStep(JobLauncher jobLauncher) {
        return stepBuilderFactory.get("jobStep")
            .job(childJob())
            .launcher(jobLauncher)
            .parametersExtractor(jobParametersExtractor())
            .listener(new StepExecutionListener() {
                @Override
                public void beforeStep(StepExecution stepExecution) {
                    stepExecution.getExecutionContext().putString("name", "user1");
                }

                @Override
                public ExitStatus afterStep(StepExecution stepExecution) {
                    return null;
                }
            })
            .build();
    }

    @Bean
    public Job childJob() {
        return this.jobBuilderFactory.get("childJob")
                                     .start(step1())
                                     .build();
    }

    @Bean
    public Step step1() {
        return stepBuilderFactory.get("step1")
                                 .tasklet(new Tasklet() {
                                     @Override
                                     public RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception {
                                        return RepeatStatus.FINISHED;
                                     }
                                 })
                                 .build();
    }

    @Bean
    public Step step2() {
        return stepBuilderFactory.get("step2")
                                 .tasklet(new Tasklet() {
                                     @Override
                                     public RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception {
                        return RepeatStatus.FINISHED;
                                     }
                                 })
                                 .build();
    }

    private DefaultJobParametersExtractor jobParametersExtractor() {
        DefaultJobParametersExtractor extractor = new DefaultJobParametersExtractor();
        extractor.setKeys(new String[]{"name"});
        return extractor;
    }
}

BATCH_JOB_INSTANCE

BATCH_JOB_EXECUTION

• 별도의 JOB 생성

BATCH_JOB_EXEUCTION_PARAMS

• ParentJob : 기본 설정한 Date만 params로
• ChildJob : 기본 설정 Date + JobParametersExtractor로 설정한 것

BATCH_STEP_EXECUTION

• 순서 확인

Step1에 의도적인 에러

BATCH_JOB_EXECUTION

BATCH_STEP_EXECUTION

Step2를 실패

BATCH_JOB_EXECUTION

• ParentJob : 실패
• ChildJob : 성공

BATCH_STEP_EXECUTION