[Spring Batch] 5.0 버전에서 달라진 점과 기본 예제

진행하던 프로젝트에서 공용충전기의 대한 정보 업데이트를 위해 주기적으로 공용충전기의 대한 정보를 다시 받아와야하는 작업을 진행하기 위해 스프링배치를 공부하게 되었다.

Spring Batch

• 스프링 배치는 로깅, 추적, 트랜젝션 관리, 작업처리 통계, 반복 작업 자동화 등 많은 기능을 제공하는 스프링 기능을 제공한다.
• 스프링배치는 Job과 Step을 관리하는 기능을 제공하며 실제로 실행하는 것은 스케줄러이다.

Srping Batch 5.0 에서 달라진 것들

Spring Batch 5.0 Migration Guide

• 많은 초보 개발자들이 ChatGPT와 블로그 예제를 보면서 코드를 작성할 것이다.
• 현재 많은 스프링배치 포스팅들은 이전 버전을 사용하고 있어서 지금은 사용하지 못하는 것이 많다.

1. @EnableBatchProcessing

PlatformTransactionManage를 명시적으로 표시해야한다.

• @EnableBatchProcessing가 기본적으로 JDBC 기반 JobRepository를 사용하도록 강제됨
• 따라서 DataSource(MySQL 등) 설정이 필요함
• 이전의 MapJobRepository는 제거됨 → 반드시 DB를 사용해야 함

// Sample with v4
@Configuration
@EnableBatchProcessing
public class MyStepConfig {

    @Autowired
    private StepBuilderFactory stepBuilderFactory;

    @Bean
    public Step myStep() {
        return this.stepBuilderFactory.get("myStep")
                .tasklet(..) // or .chunk()
                .build();
    }

}

// Sample with v5
@Configuration
@EnableBatchProcessing
public class MyStepConfig {

    @Bean
    public Tasklet myTasklet() {
       return new MyTasklet();
    }

    @Bean
    public Step myStep(JobRepository jobRepository, Tasklet myTasklet, PlatformTransactionManager transactionManager) {
        return new StepBuilder("myStep", jobRepository)
                .tasklet(myTasklet, transactionManager) // or .chunk(chunkSize, transactionManager)
                .build();
    }

}

1. jobbuilderfactory의 삭제

// Sample with v4
@Configuration
@EnableBatchProcessing
public class MyJobConfig {

    @Autowired
    private JobBuilderFactory jobBuilderFactory;

    @Bean
    public Job myJob(Step step) {
        return this.jobBuilderFactory.get("myJob")
                .start(step)
                .build();
    }

}

// Sample with v5
@Configuration
@EnableBatchProcessing
public class MyJobConfig {

    @Bean
    public Job myJob(JobRepository jobRepository, Step step) {
        return new JobBuilder("myJob", jobRepository)
                .start(step)
                .build();
    }

}

Job을 등록하는 방법이 변경되었다. 좀더 직관적으로 변경하기 위함으로 보인다.

예제

BatchConfig

package project.charger.batch.job;

import org.springframework.batch.core.Job;
import org.springframework.batch.core.configuration.DuplicateJobException;
import org.springframework.batch.core.configuration.support.DefaultBatchConfiguration;
import org.springframework.batch.core.job.builder.JobBuilder;
import org.springframework.batch.core.repository.JobRepository;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.transaction.PlatformTransactionManager;
import project.charger.batch.step.ChargerStepConfig;

@Configuration
public class ChargerJobConfig extends DefaultBatchConfiguration {
    final private ChargerStepConfig chargerStepConfig;

    public ChargerJobConfig(ChargerStepConfig chargerStepConfig) {
        this.chargerStepConfig = chargerStepConfig;
    }

    @Bean
    public Job testJob(JobRepository jobRepository, PlatformTransactionManager transactionManager) throws DuplicateJobException {
        return new JobBuilder("testJob",jobRepository)
                .start(chargerStepConfig.testStep(jobRepository, transactionManager))
                .build();
    }
}

• 스텝 등록을 위해 step confing를 주입받고 Job을 등록
• 이후 모든 Job 등록은 여기서 할 것

StepConfig

package project.charger.batch.step;

import org.springframework.batch.core.Step;
import org.springframework.batch.core.repository.JobRepository;
import org.springframework.batch.core.step.builder.StepBuilder;
import org.springframework.batch.core.step.tasklet.Tasklet;
import org.springframework.batch.repeat.RepeatStatus;
import org.springframework.stereotype.Component;
import org.springframework.transaction.PlatformTransactionManager;

@Component
public class ChargerStepConfig {
    public Step testStep(JobRepository jobRepository, PlatformTransactionManager transactionManager){
        return new StepBuilder("testStep",jobRepository)
                .tasklet(testTasklet(),transactionManager)
                .build();
    }

    public Tasklet testTasklet(){
        return ((contribution, chunkContext) -> {
            System.out.println("***** hello batch! *****");
            // 원하는 비지니스 로직 작성
            return RepeatStatus.FINISHED;
        });
    }
}

• Tasklet, chunk 방식 등 필요한 방식으로 스텝을 작성
• 실제로 비즈니스 로직이 이루어지는 곳이고 Bean 등록을 위해 Component 어노테이션을 붙임

Batch Scheduler

package project.charger.batch.config;

import org.springframework.batch.core.Job;
import org.springframework.batch.core.JobParametersBuilder;
import org.springframework.batch.core.JobParametersInvalidException;
import org.springframework.batch.core.configuration.JobRegistry;
import org.springframework.batch.core.configuration.support.JobRegistryBeanPostProcessor;
import org.springframework.batch.core.launch.JobLauncher;
import org.springframework.batch.core.launch.NoSuchJobException;
import org.springframework.batch.core.repository.JobExecutionAlreadyRunningException;
import org.springframework.batch.core.repository.JobInstanceAlreadyCompleteException;
import org.springframework.batch.core.repository.JobRestartException;
import org.springframework.context.annotation.Bean;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;

import java.time.LocalDateTime;

@Component
public class BatchScheduler {
    private final JobLauncher jobLauncher;
    private final JobRegistry jobRegistry;

    public BatchScheduler(JobLauncher jobLauncher, JobRegistry jobRegistry) {
        this.jobLauncher = jobLauncher;
        this.jobRegistry = jobRegistry;
    }

    @Scheduled(cron = "0/10 * * * * *") // 10초마다 실행
    public void runJob() throws Exception {
        String time = LocalDateTime.now().toString();
        try {
            Job job = jobRegistry.getJob("testJob"); // job 이름
            JobParametersBuilder jobParam = new JobParametersBuilder().addString("time", time);
            jobLauncher.run(job, jobParam.toJobParameters());
        } catch (Exception e){
            throw new Exception("배치작업 중 문제 발생");
        }
    }
}

• 위에서 말했듯 Batch는 Job과 Step을 관리하고 실제 실행은 스케줄러가 관리한다.
• 배치를 얼마의 간격으로 실행할지 cron 방식으로 관리한다. JobParameterBuilder 를 통해 파라미터를 넘길 수 있다. 여기서는 현재 시간을 파라미터로 넘겨본다.

에러

org.springframework.jdbc.BadSqlGrammarException: PreparedStatementCallback; bad SQL grammar

실행하면 이런 에러가 발생할 수도 있다.

스프링배치는 Job이 실행될 때 마다 BATCH_STEP_EXECUTION, BATCH_JOB_EXECUTION 테이블에 관련 로그를 저장하는데 이것이 만들어져 있지 않다는 의미이다. 

 

원래는 이 테이블을 자동으로 만들어주는 쿼리가 실행되지만 실행되지 않는 경우가 있다. 그럴 땐 직접 쿼리를 실행해줘야하는데

컨트롤 F 로 org.springframework.batch.core 를 검색하여 찾아간다. 

 

그럼 여러 sql이 담긴 파일을 찾을 수 있는데 여기서 자신이 쓰는 DBMS 에 맞는 것을 열어 직접 실행시켜 테이블을 만들어주면 된다.