😇

Spring Boot 3にアップデートしたらSpring Batchが動かなくなった

2023/05/20に公開

どんな人向け?

Spring Boot 3にアップデートしたら、Spring Batchのジョブが起動しなくなった。
Spring Boot 3にアップデートしたら、バッチのメタデータ用DataSourceに@BatchDataSourceを指定していたのに突然メインのDataSourceを使いだした。

@EnableBatchProcessingを付与した場合の挙動が変わったためです。

特にBatchの機能をカスタマイズして使っているわけではない場合、@EnableBatchProcessingを外してみてください。

Spring BootでSpring Batchを使用する場合、関連するBeanはSpring Bootのorg.springframework.boot.autoconfigure.batch.BatchAutoConfigurationで自動構成されます。

Spring Batch 4 → 5へのアップデートでは、設定クラスに破壊的変更がありました。
- https://docs.spring.io/spring-batch/docs/5.0.0/reference/html/whatsnew.html#new-configuration-class
- org.springframework.batch.core.configuration.support.DefaultBatchConfiguration.DefaultBatchConfiguration
Spring Boot 3はこれに追従し、Spring BatchのDefaultBatchConfigurationをベースとしてカスタマイズする方式に変更しました。
- https://github.com/spring-projects/spring-boot/commit/64f4da80cb65e39214910cea93de03584922177d
- org.springframework.boot.autoconfigure.batch.BatchAutoConfiguration
Spring Bootのorg.springframework.boot.autoconfigure.batch.BatchAutoConfigurationは@EnableBatchProcessingが付与されたBeanが存在すると有効にならず、Spring Batch関連Beanがカスタマイズ可能な状態になります。

アプリケーションに@EnableBatchProcessingを付与したままSpring Boot 3系 × Spring Batch 5系にアップデートしてしまうと、意図せずカスタマイズ可能な状態となってしまい、

という状態になってしまいます。

Spring Batch 5系では、解説内に記載した設定クラスの変更に加えて、メタデータスキーマの更新など破壊的変更が多くあります。
マイグレーションガイドが提供されていますので、アップデート対応を行う際は参考にされることをおすすめします。