Migrate to Spring Batch 6

See gh-46216

Author: fmbenhassine

spring-boot-project/spring-boot-batch/src/main/java/org/springframework/boot/batch/autoconfigure/BatchAutoConfiguration.java

@@ -22,9 +22,9 @@
 
 import org.springframework.batch.core.configuration.annotation.EnableBatchProcessing;
 import org.springframework.batch.core.configuration.support.DefaultBatchConfiguration;
+import org.springframework.batch.core.configuration.support.JdbcDefaultBatchConfiguration;
 import org.springframework.batch.core.converter.JobParametersConverter;
-import org.springframework.batch.core.explore.JobExplorer;
-import org.springframework.batch.core.launch.JobLauncher;
+import org.springframework.batch.core.launch.JobOperator;
 import org.springframework.batch.core.repository.ExecutionContextSerializer;
 import org.springframework.batch.core.repository.JobRepository;
 import org.springframework.beans.factory.ObjectProvider;
@@ -72,7 +72,7 @@
  */
 @AutoConfiguration(after = { DataSourceAutoConfiguration.class, TransactionAutoConfiguration.class },
 		afterName = "org.springframework.boot.hibernate.autoconfigure.HibernateJpaAutoConfiguration")
-@ConditionalOnClass({ JobLauncher.class, DataSource.class, DatabasePopulator.class })
+@ConditionalOnClass({ JobOperator.class, DataSource.class, DatabasePopulator.class })
 @ConditionalOnBean({ DataSource.class, PlatformTransactionManager.class })
 @ConditionalOnMissingBean(value = DefaultBatchConfiguration.class, annotation = EnableBatchProcessing.class)
 @EnableConfigurationProperties(BatchProperties.class)
@@ -82,9 +82,9 @@ public class BatchAutoConfiguration {
 	@Bean
 	@ConditionalOnMissingBean
 	@ConditionalOnBooleanProperty(name = "spring.batch.job.enabled", matchIfMissing = true)
-	public JobLauncherApplicationRunner jobLauncherApplicationRunner(JobLauncher jobLauncher, JobExplorer jobExplorer,
+	public JobLauncherApplicationRunner jobLauncherApplicationRunner(JobOperator jobOperator,
 			JobRepository jobRepository, BatchProperties properties) {
-		JobLauncherApplicationRunner runner = new JobLauncherApplicationRunner(jobLauncher, jobExplorer, jobRepository);
+		JobLauncherApplicationRunner runner = new JobLauncherApplicationRunner(jobOperator, jobRepository);
 		String jobName = properties.getJob().getName();
 		if (StringUtils.hasText(jobName)) {
 			runner.setJobName(jobName);
@@ -99,7 +99,7 @@ public JobExecutionExitCodeGenerator jobExecutionExitCodeGenerator() {
 	}
 
 	@Configuration(proxyBeanMethods = false)
-	static class SpringBootBatchConfiguration extends DefaultBatchConfiguration {
+	static class SpringBootBatchConfiguration extends JdbcDefaultBatchConfiguration {
 
 		private final DataSource dataSource;
 
@@ -173,6 +173,7 @@ protected ExecutionContextSerializer getExecutionContextSerializer() {
 					: super.getExecutionContextSerializer();
 		}
 
+		@SuppressWarnings("removal")
 		@Override
 		protected JobParametersConverter getJobParametersConverter() {
 			return (this.jobParametersConverter != null) ? this.jobParametersConverter

spring-boot-project/spring-boot-batch/src/main/java/org/springframework/boot/batch/autoconfigure/BatchConversionServiceCustomizer.java

@@ -16,14 +16,12 @@
 
 package org.springframework.boot.batch.autoconfigure;
 
-import org.springframework.batch.core.configuration.support.DefaultBatchConfiguration;
 import org.springframework.core.convert.support.ConfigurableConversionService;
 
 /**
  * Callback interface that can be implemented by beans wishing to customize the
- * {@link ConfigurableConversionService} that is
- * {@link DefaultBatchConfiguration#getConversionService provided by
- * DefaultBatchConfiguration} while retaining its default auto-configuration.
+ * {@link ConfigurableConversionService} that is used by the batch infrastructure
+ * while retaining its default auto-configuration.
  *
  * @author Claudio Nave
  * @since 4.0.0

spring-boot-project/spring-boot-batch/src/main/java/org/springframework/boot/batch/autoconfigure/JobExecutionEvent.java

@@ -16,7 +16,7 @@
 
 package org.springframework.boot.batch.autoconfigure;
 
-import org.springframework.batch.core.JobExecution;
+import org.springframework.batch.core.job.JobExecution;
 import org.springframework.context.ApplicationEvent;
 
 /**

spring-boot-project/spring-boot-batch/src/main/java/org/springframework/boot/batch/autoconfigure/JobExecutionExitCodeGenerator.java

@@ -19,7 +19,7 @@
 import java.util.List;
 import java.util.concurrent.CopyOnWriteArrayList;
 
-import org.springframework.batch.core.JobExecution;
+import org.springframework.batch.core.job.JobExecution;
 import org.springframework.boot.ExitCodeGenerator;
 import org.springframework.context.ApplicationListener;
 

spring-boot-project/spring-boot-batch/src/main/java/org/springframework/boot/batch/autoconfigure/JobLauncherApplicationRunner.java

@@ -27,18 +27,18 @@
 import org.apache.commons.logging.LogFactory;
 
 import org.springframework.batch.core.BatchStatus;
-import org.springframework.batch.core.Job;
-import org.springframework.batch.core.JobExecution;
-import org.springframework.batch.core.JobExecutionException;
-import org.springframework.batch.core.JobParameter;
-import org.springframework.batch.core.JobParameters;
-import org.springframework.batch.core.JobParametersBuilder;
-import org.springframework.batch.core.JobParametersInvalidException;
 import org.springframework.batch.core.configuration.JobRegistry;
 import org.springframework.batch.core.converter.DefaultJobParametersConverter;
 import org.springframework.batch.core.converter.JobParametersConverter;
-import org.springframework.batch.core.explore.JobExplorer;
-import org.springframework.batch.core.launch.JobLauncher;
+import org.springframework.batch.core.job.Job;
+import org.springframework.batch.core.job.JobExecution;
+import org.springframework.batch.core.job.JobExecutionException;
+import org.springframework.batch.core.job.parameters.JobParameter;
+import org.springframework.batch.core.job.parameters.JobParameters;
+import org.springframework.batch.core.job.parameters.JobParametersBuilder;
+import org.springframework.batch.core.job.parameters.JobParametersInvalidException;
+import org.springframework.batch.core.launch.JobOperator;
+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.JobRepository;
@@ -55,7 +55,7 @@
 import org.springframework.util.StringUtils;
 
 /**
- * {@link ApplicationRunner} to {@link JobLauncher launch} Spring Batch jobs. If a single
+ * {@link ApplicationRunner} to {@link JobOperator launch} Spring Batch jobs. If a single
  * job is found in the context, it will be executed by default. If multiple jobs are
  * found, launch a specific job by providing a jobName.
  *
@@ -78,9 +78,7 @@ public class JobLauncherApplicationRunner
 
 	private JobParametersConverter converter = new DefaultJobParametersConverter();
 
-	private final JobLauncher jobLauncher;
-
-	private final JobExplorer jobExplorer;
+	private final JobOperator jobOperator;
 
 	private final JobRepository jobRepository;
 
@@ -96,17 +94,14 @@ public class JobLauncherApplicationRunner
 
 	/**
 	 * Create a new {@link JobLauncherApplicationRunner}.
-	 * @param jobLauncher to launch jobs
-	 * @param jobExplorer to check the job repository for previous executions
+	 * @param jobOperator to launch jobs
 	 * @param jobRepository to check if a job instance exists with the given parameters
 	 * when running a job
 	 */
-	public JobLauncherApplicationRunner(JobLauncher jobLauncher, JobExplorer jobExplorer, JobRepository jobRepository) {
-		Assert.notNull(jobLauncher, "'jobLauncher' must not be null");
-		Assert.notNull(jobExplorer, "'jobExplorer' must not be null");
+	public JobLauncherApplicationRunner(JobOperator jobOperator, JobRepository jobRepository) {
+		Assert.notNull(jobOperator, "'jobOperator' must not be null");
 		Assert.notNull(jobRepository, "'jobRepository' must not be null");
-		this.jobLauncher = jobLauncher;
-		this.jobExplorer = jobExplorer;
+		this.jobOperator = jobOperator;
 		this.jobRepository = jobRepository;
 	}
 
@@ -199,23 +194,24 @@ private void executeRegisteredJobs(JobParameters jobParameters) throws JobExecut
 		}
 	}
 
-	protected void execute(Job job, JobParameters jobParameters) throws JobExecutionAlreadyRunningException,
-			JobRestartException, JobInstanceAlreadyCompleteException, JobParametersInvalidException {
+	protected void execute(Job job, JobParameters jobParameters)
+			throws JobExecutionAlreadyRunningException, NoSuchJobException, JobRestartException,
+			JobInstanceAlreadyCompleteException, JobParametersInvalidException {
 		JobParameters parameters = getNextJobParameters(job, jobParameters);
-		JobExecution execution = this.jobLauncher.run(job, parameters);
+		JobExecution execution = this.jobOperator.start(job, parameters);
 		if (this.publisher != null) {
 			this.publisher.publishEvent(new JobExecutionEvent(execution));
 		}
 	}
 
 	private JobParameters getNextJobParameters(Job job, JobParameters jobParameters) {
-		if (this.jobRepository != null && this.jobRepository.isJobInstanceExists(job.getName(), jobParameters)) {
+		if (this.jobRepository != null && this.jobRepository.getJobInstance(job.getName(), jobParameters) != null) {
 			return getNextJobParametersForExisting(job, jobParameters);
 		}
 		if (job.getJobParametersIncrementer() == null) {
 			return jobParameters;
 		}
-		JobParameters nextParameters = new JobParametersBuilder(jobParameters, this.jobExplorer)
+		JobParameters nextParameters = new JobParametersBuilder(jobParameters, this.jobRepository)
 			.getNextJobParameters(job)
 			.toJobParameters();
 		return merge(nextParameters, jobParameters);