Spring Batch の基本的な使い方とCommandLineRunner による CLI 実行

spring.datasource.driver-class-name=org.h2.Driver
spring.datasource.url=jdbc:h2:file:./target/h2sampledb
spring.datasource.username=<user>
spring.datasource.password=<password>

# spring.batch.jdbc.schema=classpath:/org/springframework/batch/core/schema-h2.sql
spring.batch.jdbc.initialize-schema=always

// @Configuration: 内部で @Bean を利用するため
// @EnableBatchProcessing: JobBuilderFactory, StepBuilderFactory を利用するため
// @RequiredArgsConstructor: 上記を DI するため
@Configuration
@EnableBatchProcessing
@RequiredArgsConstructor
public class BatchConfig {

    private final JobBuilderFactory jobBuilderFactory;

    private final StepBuilderFactory stepBuilderFactory;

    private final Tasklet tasklet1;

    /**
     * Step を作成、helloStep1 という名前のステップで、
     * 実際の処理は tasklet1 を行う
     */
    @Bean
    public Step step1() {
        return stepBuilderFactory.get("helloStep1")
                .tasklet(tasklet1)
                .build();
    }

    /**
     * Job の作成、helloJob というジョブ
     * 実行毎に実行IDをインクリメントすることでパラメータ重複しないようにする
     * 実際の処理は step1 を行う
     */
    @Bean
    public Job job() {
        return jobBuilderFactory.get("helloJob")
                .incrementer(new RunIdIncrementer())
                .start(step1())
                .build();
    }
}

/**
 * @Component: Bean として登録するため
 * @StepScope: Stepごとにスコープを定義。
 *      StepScope インタフェースは次のアノテーションを持ちます。
 *      @Scope(value = "step", proxyMode = ScopedProxyMode.TARGET_CLASS)
 */
@Component
@StepScope
public class BatchTasklet1 implements Tasklet {

    /**
     * job の実行時に指定されたパラメータがセットされます。
     * param1=テスト1 param2=202 param3=テスト3 の場合、「テスト1」です。
     */
    @Value("#{jobParameters[param1]}")
    private String param1;

    /**
     * job の実行時に指定されたパラメータがセットされます。
     * param1=テスト1 param2=202 param3=テスト3 の場合、「202」です。
     */
    @Value("#{jobParameters[param2]}")
    private int param2;

    @Override
    public RepeatStatus execute(StepContribution contribution, ChunkContext context) {
        System.out.println("Batch Task1 is called !");
        System.out.println("param1: " + param1);
        System.out.println("param2: " + param2);

        contribution.setExitStatus(new ExitStatus("success"));

        return RepeatStatus.FINISHED;
    }
}

@Component
public class BatchJobListener extends JobExecutionListenerSupport {

    @Override
    public void beforeJob(JobExecution jobExecution) {
        System.out.println("beforeJob");
    }

    @Override
    public void afterJob(JobExecution jobExecution) {
        System.out.println("aftefJob");
    }
}

@Component
public class BatchStepListener extends StepExecutionListenerSupport {

    @Override
    public void beforeStep(StepExecution stepExecution) {
        System.out.println("beforeStep");
    }

    @Override
    public ExitStatus afterStep(StepExecution stepExecution) {
        System.out.println("aftefStep");
        return stepExecution.getExitStatus();
    }
}

~~
    @Bean
    public Step step1() {
        return stepBuilderFactory.get("helloStep1")
                .tasklet(tasklet1)
                .listener(stepListener)
                .build();
    }

~~
    @Bean
    public Job job() {
        return jobBuilderFactory.get("helloJob")
                .incrementer(new RunIdIncrementer())
                .start(step1())
                .listener(jobListener)
                .build();
    }

@Component
@EnableBatchProcessing
@RequiredArgsConstructor
@ConditionalOnProperty(value = { "batch" }, havingValue = "my-batch")
public class MyBatchCommandLineRunner  implements CommandLineRunner {

    private final JobLauncher jobLauncher;

    private final Job job;

    private DefaultJobParametersConverter converter = new DefaultJobParametersConverter();

    @Override
    public void run(String... args) throws Exception {
        System.out.println("run my-batch");
        Properties properties = StringUtils.splitArrayElementsIntoProperties(args, "=");
        JobParameters jobParameters = this.converter.getJobParameters(properties);
        // パラメータ
        System.out.println(jobParameters.toString());

        // ジョブ実行
        JobExecution jobExecution = jobLauncher.run(job, jobParameters);

        // 終了ステータス
        System.out.println("my-batch status: " + jobExecution.getExitStatus().getExitCode());
    }
}

spring.batch.job.enabled=false

--batch=my-batch param1=テスト1 param2=202 param3=テスト3

//MyBatchCommandLineRunner.java - run メソッド

JobParameters jobParameters = this.converter.getJobParameters(properties);
// これを設定する
// その後、実行パラメータに run.id=1 をつけると、今度は run.id=2 で実行してくれます
jobParameters = job.getJobParametersIncrementer().getNext(jobParameters);