Spring Batch 5 사용해보기

😢 배경

토이 프로젝트 Spring Boot 3 환경에서 Spring Batch 5를 사용하려고 했는데, 기존에 Spring Boot 2에서 사용했던 Job, Step 선언 방식으로는 실행되지 않는다는 걸 알게 되었다.

 

0. 기본 조건

Spring Batch 5는 Spring framework 6, Spring Boot 3 환경에서 사용하므로 최소 Jdk 17을 필요로 한다.

 

1. StepBuilderFactory, JobBuilderFactory = Deprecated

기존 Spring Batch 4에서는 JobBuilderFactory, StepBuilderFactory를 사용해 Job과 Step 구성하는 방식으로 사용했었다. 하지만 Spring Batch 5에서는 BuilderFactory가 Deprecated 되었으므로, 직접 명시하는 방식을 사용해야 한다.

 

BuilderFactory는 사실 Job, Step을 구성뿐 아니라, JobRepository를 생성하고 설정하는 기능도 포함하고 있었다.

 

기존 JobBuilderFacotry 내부

그러므로 개발자가 직접 Job, Step 선언뿐 아니라 JobRepository 또한 명시적으로 제공해야 한다.

 

@Bean
public Job todayScheduleJob(JobRepository jobRepository, Step todayScheduleStep) {
	return new JobBuilder("today-schedule-job", jobRepository)
			.incrementer(new RunIdIncrementer())
			.start(todayScheduleStep)
			.build();
}

 

Step도 마찬가지로 필요한 Repository를 제공해야 하며 Tasklet 또는 Chunk를 사용할 때, TransactionManager를 명시적으로 제공해야 한다.

 

@Bean
public Step todayScheduleStep(JobRepository jobRepository,  PlatformTransactionManager transactionManager) {
	return new StepBuilder("today-schedule-step", jobRepository)
			.tasklet((stepContribution, chunkContext) -> {
				System.out.println("hello");
				return RepeatStatus.FINISHED;
			}, transactionManager).build();
}

 

2. @EnableBatchProcessing 사용은 필수가 아니다.

기존에는 @EnableBatchProcessing를 메인 클래스에 선언하고 Job, Step들은 별도의 설정 클래스에서 Bean으로 등록하는 형식을 사용했었다. 하지만 더 이상 @EnableBatchProcessing을 필수로 선언하지 않아도 된다.

 

3. 설정 커스터 마이징이 필요하다면 DefaultBatchConfiguration를 상속해 보자. 

Spring Batch 5에서는 DefaultBatchConfiguration 클래스를 상속해서 여러 설정들을 커스터마이징 하게 사용할 수 있도록 지원한다. 필요하다면 해당 클래스에서 제공하는 getTransactionManager(), getDataSource(), getCharset() 등을 오버라이딩해서 사용할 수 있다.

 

@Override
protected Charset getCharset() {
	return StandardCharsets.UTF_8;
}

 

주의할 점은 @EnableBatchProcessing와 DefaultBatchConfiguration를 동시에 사용하면 안 된다.

 

그리고, 필요하지 않다면 둘 다 사용하지 않아도 된다.

REFERENCE

https://spring.io/guides/gs/batch-processing/

https://github.com/spring-projects/spring-batch/wiki/Spring-Batch-5.0-Migration-Guide

https://docs.spring.io/spring-batch/docs/current/reference/html/whatsnew.html