Spring Batch (2) 프로젝트 구성 및 의존성 설정, Hello World

📌 해당 포스팅의 목표

• Spring Batch 프로젝트 설정
• Spring Batch 설정 내부
• Spring Batch Hello World

 

 

📌 Spring Batch 프로젝트 구성

프로젝트 구성은 IntelliJ, Java 11, Gradle, MySQL(Docker), H2, Spring Boot, Batch 등을 사용할 예정입니다.

(프로젝트 설정 관련 설명은 없으니 GitHub를 참고해주세요.)

 

 

📌 Spring Batch 의존성 설정

스프링 배치를 작동시키기 위해 메인 클래스에 @EnableBatchProcessing 어노테이션을 선언해야 합니다.

import org.springframework.batch.core.configuration.annotation.EnableBatchProcessing;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@EnableBatchProcessing
@SpringBootApplication
public class SpringBatchApplication {

    public static void main(String[] args) {
        SpringApplication.run(SpringBatchApplication.class, args);
    }

}

@EnableBatchProcessing 어노테이션은 4개의 설정 클래스를 실행시키고, 스프링 배치의 초기화 및 실행 구성이 이루어지게 됩니다.

@EnableBatchProcessing에 의한 실행 구성

 

1. @EnableBatchProcessing

스프링 배치 작동을 위해 선언해야 하는 어노테이션으로 내부에는 BatchConfigurationSelector 클래스가 Import 되어 있습니다.

 

BatchConfigurationSelectors 클래스

BatchConfigurationSelector 클래스에는 modular 여부에 따라 설정할 클래스를 선택하는데, modular는 따로 설정하지 않기에 SimpleBatchConfiguration 클래스를 가장 먼저 설정하게 됩니다.

 

 

2. AbstractBatchConfiguration 추상 클래스 & SimpleBatchConfiguration 클래스

SimpleBatchConfiguration 클래스는 AbstractBatchConfiguration 추상 클래스를 상속받습니다.

AbstractBatchConfiguration 추상 클래스는 JobRepository, JobBuilderFactory, StepBuilderFactory 등을 빈으로 등록합니다.

JobBuilderFactory, StepBuilderFactory 객체는 Bean 초기화 시 설정 메서드인 afterPropertiesSet() 메서드에서 새로운 객체를 생성하여 주입합니다.

...

@Override
public void afterPropertiesSet() throws Exception {
    this.jobBuilderFactory = new JobBuilderFactory(jobRepository());
    this.stepBuilderFactory = new StepBuilderFactory(jobRepository(), transactionManager());
}

 

SimpleBatchConfiguration는 스프링 배치의 주요 구성 요소를 프록시 객체(createLazyProxy() 메서드)로 생성합니다.

(프록시 패턴에 대한 개념은 해당 포스팅을 참고해주세요.)

• JobRepository
• JobLauncher
• JobRegistry
• ...

 

3. BatchConfigurerConfiguration 클래스

위 SimpleBatchConfiguration 과정이 끝나면 BatchConfigurerConfiguration 클래스가 작동하게 됩니다.

BatchConfigurerConfiguration 클래스에는 BasicBatchConfigurer, JpaBatchConfigurer 두 설정이 존재합니다.

• BasicBatchConfigurer: SipmleBatchConfiguration 클래스에서 생성한 프록시 객체의 실제 대상 객체를 생성하는 설정 클래스
• JpaBatchConfigurer: JPA 관련 객체를 생성하는 설정 클래스

JpaBatchConfigurer 클래스는 BasicBatchConfigurer 클래스를 상속받고 있기에 필드나 메서드들은 공유가 됩니다.

 

4. BatchAutoConfiguration 클래스

마지막으로 실제 애플리케이션의 Job 실행과 관련된 Launcher를 생성하는 설정 클래스입니다.

위 사진의 76라인에서 생성되는 JobLauncherApplicationRunner 클래스가 실제 Job을 실행하는 클래스입니다.

JobLauncherApplicationRunner

JobLauncherApplicationRunner 클래스는 위와 같이 구성되어 있으며 실제 195 라인의 execute() 메서드를 통해 스프링 프레임워크의 ApplicationEventPublisher 인터페이스를 통해 이벤트를 발행하여 Job을 실행합니다.

 

 

📌 Spring Batch Hello World

spring:
  datasource:
    driver-class-name: org.h2.Driver
    url: jdbc:h2:~/test
    username: sa
    password:
  h2:
    console:
      enabled: true
      path: /h2-console
  batch:
    jdbc:
      initialize-schema: always

package io.spring.springbatch;

import lombok.RequiredArgsConstructor;
import org.springframework.batch.core.Job;
import org.springframework.batch.core.Step;
import org.springframework.batch.core.StepContribution;
import org.springframework.batch.core.configuration.annotation.JobBuilderFactory;
import org.springframework.batch.core.configuration.annotation.StepBuilderFactory;
import org.springframework.batch.core.scope.context.ChunkContext;
import org.springframework.batch.core.step.tasklet.Tasklet;
import org.springframework.batch.repeat.RepeatStatus;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@RequiredArgsConstructor
@Configuration
public class HelloJobConfiguration {

    private final JobBuilderFactory jobBuilderFactory;
    private final StepBuilderFactory stepBuilderFactory;

    @Bean
    public Job helloJob() {
        return this.jobBuilderFactory.get("helloJob")
                .start(helloStep1())
                .next(helloStep2())
                .build();
    }

    @Bean
    public Step helloStep1() {
        return stepBuilderFactory.get("helloStep1")
                .tasklet((contribution, chunkContext) -> {
                    System.out.println(" ============================");
                    System.out.println(" >> Hello Spring Batch");
                    System.out.println(" ============================");
                    return RepeatStatus.FINISHED;
                })
                .build();
    }
    public Step helloStep2() {
        return stepBuilderFactory.get("helloStep2")
                .tasklet((contribution, chunkContext) -> {
                    System.out.println(" ============================");
                    System.out.println(" >> Step2 has executed");
                    System.out.println(" ============================");
                    return RepeatStatus.FINISHED;
                })
                .build();
    }
}

• @Configuration : Batch Job 정의 및 빈 설정
• JobBuilderFactory : Job을 생성하는 빌더 팩토리, AbstractBatchConfiguration 추상 클래스에서 Bean으로 등록
• StepBuilderFactory : Step을 생성하는 빌더 팩토리, AbstractBatchConfiguration 추상 클래스에서 Bean으로 등록
• Job -> Step -> Tasklet(Step 내에서 단일 테스크로 수행되는 로직) 순으로 구성

https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-%EB%B0%B0%EC%B9%98/dashboard

 

 

참고 문서

• 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