SpringBatchのTaskletでトランザクションを設定

Java SpringBoot

SpringBatchのTaskletでトランザクションを設定

Spring BatchでTaskletを使用する際、トランザクション管理は非常に重要です。
Taskletは、基本的には1つのステップで特定のタスクを実行するために使用され、通常はデータの読み込み、処理、または書き込みのようなバッチ処理の一部を担当します。
Spring Batchでは、トランザクション管理を使用して、処理が成功した場合のみコミットし、失敗した場合はロールバックすることでデータの整合性を保つことができます。

以下に、Spring BatchのTaskletでトランザクションを設定する方法について説明します。

1. Taskletの実装

まず、Taskletインターフェースを実装するクラスを作成します。
このクラスは、executeメソッドをオーバーライドする必要があります。

import org.springframework.batch.core.StepContribution;
import org.springframework.batch.core.scope.context.ChunkContext;
import org.springframework.batch.core.step.tasklet.Tasklet;
import org.springframework.batch.repeat.RepeatStatus;

public class MyTasklet implements Tasklet {

  @Override
  public RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception {
    // トランザクション内で実行する処理をここに記述

    // 処理が正常に完了した場合
    return RepeatStatus.FINISHED;
  }
}

2. トランザクション管理の設定

Taskletを使用するステップでトランザクションを有効にするには、stepメソッド内でtransactionManagerを設定する必要があります。
Spring Batchでは、デフォルトでステップ全体が1つのトランザクションとして管理されます。

import org.springframework.batch.core.Step;
import org.springframework.batch.core.configuration.annotation.StepBuilderFactory;
import org.springframework.batch.core.configuration.annotation.EnableBatchProcessing;
import org.springframework.batch.core.job.builder.JobBuilder;
import org.springframework.batch.core.job.builder.JobBuilderFactory;
import org.springframework.batch.core.launch.support.RunIdIncrementer;
import org.springframework.batch.core.repository.JobRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.transaction.PlatformTransactionManager;

@Configuration
@EnableBatchProcessing
public class BatchConfig {

  @Autowired
  private JobBuilderFactory jobBuilderFactory;

  @Autowired
  private StepBuilderFactory stepBuilderFactory;

  @Autowired
  private PlatformTransactionManager transactionManager;

  @Bean
  public Step step1() {
    return stepBuilderFactory.get("step1")
        .tasklet(new MyTasklet())
        .transactionManager(transactionManager) // トランザクションマネージャーを設定
        .build();
  }

  @Bean
  public Job job(JobRepository jobRepository) {
    return jobBuilderFactory.get("job")
        .incrementer(new RunIdIncrementer())
        .start(step1())
        .build();
  }
}

3. トランザクションの制御

Taskletのトランザクションは、デフォルトでステップ全体に適用されますが、特定のシナリオではトランザクションの設定を細かく制御したい場合があります。
たとえば、トランザクションの伝播を変更したり、タイムアウトを設定したりすることができます。

トランザクションの伝播の変更

トランザクションの伝播は、@Transactionalアノテーションを使用してTaskletクラスやメソッドレベルで指定できます。

import org.springframework.transaction.annotation.Propagation;
import org.springframework.transaction.annotation.Transactional;

public class MyTasklet implements Tasklet {

  @Override
  @Transactional(propagation = Propagation.REQUIRES_NEW) // 新しいトランザクションを開始
  public RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception {
    // トランザクション内で実行する処理をここに記述

    return RepeatStatus.FINISHED;
  }
}
トランザクションのタイムアウト設定

特定のトランザクションが指定された時間内に完了しない場合、ロールバックさせることもできます。

import org.springframework.transaction.annotation.Transactional;

public class MyTasklet implements Tasklet {

  @Override
  @Transactional(timeout = 5) // タイムアウトを5秒に設定
  public RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception {
    // トランザクション内で実行する処理をここに記述

    return RepeatStatus.FINISHED;
  }
}

まとめ

Spring BatchのTaskletにおいてトランザクション管理を設定するには、主にステップの定義時にtransactionManagerを指定し、必要に応じて@Transactionalアノテーションを使用してトランザクションの伝播やタイムアウトなどを細かく制御します。
これにより、バッチ処理の一貫性とデータ整合性を保ちながら、安全にタスクを実行することが可能です。