Spring Batch Configuration

개요

1. Configuring a Job

@Bean
public Job footballJob(JobRepository jobRepository) {
    return new JobBuilder("footballJob", jobRepository)
                     .start(playerLoad())
                     .next(gameLoad())
                     .next(playerSummarization())
                     .build();
}

• playerLoad

• gameLoad

• playerSummarization

2. Restartablitiy

@Bean
public Job footballJob(JobRepository jobRepository) {
    return new JobBuilder("footballJob", jobRepository)
                     .preventRestart()
                     ...
                     .build();
}

3. Interception Job Execution

public interface JobExecutionListener {

    void beforeJob(JobExecution jobExecution);

    void afterJob(JobExecution jobExecution);
}

@Bean
public Job footballJob(JobRepository jobRepository) {
    return new JobBuilder("footballJob", jobRepository)
                     .listener(sampleListener())
                     ...
                     .build();
}

@Component
public class JobLoggerListener {

    @BeforeJob
    public void beforeJob(JobExecution jobExecution) {
        System.out.println(">>> Job is about to start: " + jobExecution.getJobInstance().getJobName());
    }
}

jobBuilder.listener(Object listener)

3. Inheriting from a Parent Job

<job id="baseJob" abstract="true">
    <listeners>
        <listener ref="listenerOne"/>
    </listeners>
</job>

<job id="job1" parent="baseJob">
    <step id="step1" parent="standaloneStep"/>

    <listeners merge="true">
        <listener ref="listenerTwo"/>
    </listeners>
</job>

4. JobParametersValidator

public class CustomJobParametersValidator implements JobParametersValidator {

    @Override
    public void validate(JobParameters parameters) throws JobParametersInvalidException {
        String fileName = parameters.getString("fileName");

        if (fileName == null || fileName.isEmpty()) {
            throw new JobParametersInvalidException("fileName parameter is required.");
        }

        if (!fileName.endsWith(".csv")) {
            throw new JobParametersInvalidException("fileName must be a CSV file.");
        }
    }
}

@Bean
public Job job1(JobRepository jobRepository) {
    return new JobBuilder("job1", jobRepository)
                     .validator(parametersValidator())
                     ...
                     .build();
}

5. DefaultBatchConfiguration

@Configuration
class MyJobConfiguration extends DefaultBatchConfiguration {

	@Bean
	public Job job(JobRepository jobRepository) {
		return new JobBuilder("job", jobRepository)
				// define job flow as needed
				.build();
	}

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

@EnableBatchProcessing과 DefaultBatchConfiguration을 함께 사용해서는 안된다. 선언적 방식과 프로그래밍 방식 중 하나만 선택해서 사용해야 한다.

6. JobRepository

6-1. @EnableBatchProcessing

@Configuration
@EnableBatchProcessing(
		dataSourceRef = "batchDataSource",
		transactionManagerRef = "batchTransactionManager",
		tablePrefix = "BATCH_",
		maxVarCharLength = 1000,
		isolationLevelForCreate = "SERIALIZABLE")
public class MyJobConfiguration {

   // job definition

}

6-2. DefaultBatchConfiguration

@Configuration
public class MyBatchConfig extends DefaultBatchConfiguration {

    @Autowired
    private DataSource batchDataSource;

    @Autowired
    private PlatformTransactionManager batchTransactionManager;

    @Override
    protected DataSource getDataSource() {
        return batchDataSource;
    }

    @Override
    protected PlatformTransactionManager getTransactionManager() {
        return batchTransactionManager;
    }

    @Override
    protected String getTablePrefix() {
        return "BATCH_";
    }

    @Override
    protected int getMaxVarCharLength() {
        return 1000;
    }

    @Override
    protected String getIsolationLevelForCreate() {
        return "ISOLATION_SERIALIZABLE";
    }
}

6-3. Transaction Isolation Level Config (선언적 방식)

@Configuration
@EnableBatchProcessing(isolationLevelForCreate = "ISOLATION_REPEATABLE_READ")
public class MyJobConfiguration {

   // job definition

}

6-4. Transaction Behavior Config (코드적 방식)

@Bean
public TransactionProxyFactoryBean baseProxy() {
	TransactionProxyFactoryBean transactionProxyFactoryBean = new TransactionProxyFactoryBean();
	Properties transactionAttributes = new Properties();
	transactionAttributes.setProperty("*", "PROPAGATION_REQUIRED");
	transactionProxyFactoryBean.setTransactionAttributes(transactionAttributes);
	transactionProxyFactoryBean.setTarget(jobRepository());
	transactionProxyFactoryBean.setTransactionManager(transactionManager());
	return transactionProxyFactoryBean;
}

7. Table Prefix

@Configuration
@EnableBatchProcessing(tablePrefix = "SYSTEM.TEST_")
public class MyJobConfiguration {

   // job definition

}

8. JobLuancher

...
@Bean
public JobLauncher jobLauncher() throws Exception {
	TaskExecutorJobLauncher jobLauncher = new TaskExecutorJobLauncher();
	jobLauncher.setJobRepository(jobRepository);
	jobLauncher.afterPropertiesSet();
	return jobLauncher;
}
...

8-1 Async Execution

@Bean
public JobLauncher jobLauncher() {
	TaskExecutorJobLauncher jobLauncher = new TaskExecutorJobLauncher();
	jobLauncher.setJobRepository(jobRepository());
	jobLauncher.setTaskExecutor(new SimpleAsyncTaskExecutor());
	jobLauncher.afterPropertiesSet();
	return jobLauncher;
}

마무리

Reference

Configuring a JobLauncher :: Spring Batch

When you use @EnableBatchProcessing, a JobRegistry is provided for you. This section describes how to configure your own.

https://docs.spring.io/spring-batch/reference/job/configuring-launcher.html

Java Configuration :: Spring Batch

Spring 3 brought the ability to configure applications with Java instead of XML. As of Spring Batch 2.2.0, you can configure batch jobs by using the same Java configuration. There are three components for the Java-based configuration: the @EnableBatchProcessing annotation and two builders.

https://docs.spring.io/spring-batch/reference/job/java-config.html