[Spring Batch] @JobScope, @StepScope 에 대해

Spring Batch @JobScope, @StepScope 에 대해

• 스프링 빈에 scope 가 있는 것 처럼 Job과 Step에도 빈 생성과 관련한 scope이다.
• 해당 스코프가 선언되면 빈 생성이 어플리케이션 구동시점이 아니라 빈의 실행시점에 이루어지게 된다.
  • @Values를 주입해서 빈의 실행 시점에 값을 참조할 수 있어 지연 로딩이 가능해진다.
  • @Value("#{jobParameters[파라미터명]}") 와 같이 표현식 언어를 런타임 시점에 주입받을 수 있다.
  • @Values를 사용시에 반드시 빈 선언문에 @JobScope, @StepScope 정의가 필요하다.
• 프록시 모드를 기본으로 잡고있는 스코프이기 때문에 어플리케이션이 구동될 때에 해당 빈의 프록시 객체가 생성되어 실행 시점에 실제 빈을 호출한다.
• 병렬 처리 시에 각 스레드마다 Step 객체가 생성되어 할당되기 때문에 멤버 변수등의 동시적 접근과 같은 동시성 문제를 차단할 수 있다.

@JobScope

• Step 선언문에 정의
• @Value: jobParameter, jobExecutionContext만 사용 가능

@StepScope

• Tasklet이나 ItemReader, ItemWriter, ItemProcessor 선언문에 정의
• @Value: jobParameter, jobExecutionContext, stepExecutionContext 사용 가능

    @Bean
    public Job job() throws RetryableException {
        return jobBuilderFactory.get("Job")
                                .incrementer(new RunIdIncrementer())
                                .start(step2())
                                .build();
    }

    @Bean
    @JobScope
    public Step step1(@Value("#{jobParameters['name']}") String name) {
        System.out.println("jobParameter is: " + name);
        return stepBuilderFactory.get("step1")
                                 .tasklet(((contribution, chunkContext) -> {

                                     return RepeatStatus.FINISHED;
                                 }))
                                 .build();
    }

    @Bean
    public Step step2() {
        return stepBuilderFactory.get("step2")
                                 .chunk(3)
                                 .reader(itemReader(null))
                                 .writer(new ItemWriter<Object>() {
                                     @Override
                                     public void write(List<?> items) {
                                         items.forEach(System.out::print);
                                     }
                                 })
                                 .build();
    }

    @Bean
    @StepScope
    public ItemReader<Integer> itemReader(@Value("#{jobParameters['name']}") String name) {
        System.out.println("jobParameter with using stepScope: " + name);
        return new ListItemReader(List.of(1, 2, 3));
    }

위와 같이 사용을 하면된다. 위에서도 언급했지만 프록시를 통한 호출을 하기 때문에 어플리케이션 구동 시점에 빈이 생성이 되는 것이 아니라 호출이 될 때에 생성된다.

위의 Job을 name=kangggggg jobParameter를 주고 돌려보면 jobParamer is: kangggggg, jobParameter with using stepScope: kangggggg 로 잘 출력되는 것을 확인할 수가 있다.

REFERENCE

정수원님 스프링 배치 강의