Support user-defined ExecutionContextSerializer in BatchAutoConfiguration

Author: benelog

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

@@ -24,6 +24,7 @@
 import org.springframework.batch.core.configuration.support.DefaultBatchConfiguration;
 import org.springframework.batch.core.explore.JobExplorer;
 import org.springframework.batch.core.launch.JobLauncher;
+import org.springframework.batch.core.repository.ExecutionContextSerializer;
 import org.springframework.batch.core.repository.JobRepository;
 import org.springframework.beans.factory.ObjectProvider;
 import org.springframework.boot.ExitCodeGenerator;
@@ -62,6 +63,7 @@
  * @author Eddú Meléndez
  * @author Kazuki Shimizu
  * @author Mahmoud Ben Hassine
+ * @author Sanghyuk Jung
  * @since 1.0.0
  */
 @AutoConfiguration(after = { HibernateJpaAutoConfiguration.class, TransactionAutoConfiguration.class })
@@ -102,13 +104,17 @@ static class SpringBootBatchConfiguration extends DefaultBatchConfiguration {
 
 		private final List<BatchConversionServiceCustomizer> batchConversionServiceCustomizers;
 
+		private final ExecutionContextSerializer serializer;
+
 		SpringBootBatchConfiguration(DataSource dataSource, @BatchDataSource ObjectProvider<DataSource> batchDataSource,
 				PlatformTransactionManager transactionManager, BatchProperties properties,
-				ObjectProvider<BatchConversionServiceCustomizer> batchConversionServiceCustomizers) {
+				ObjectProvider<BatchConversionServiceCustomizer> batchConversionServiceCustomizers,
+				ObjectProvider<ExecutionContextSerializer> executionContextSerializer) {
 			this.dataSource = batchDataSource.getIfAvailable(() -> dataSource);
 			this.transactionManager = transactionManager;
 			this.properties = properties;
 			this.batchConversionServiceCustomizers = batchConversionServiceCustomizers.orderedStream().toList();
+			this.serializer = executionContextSerializer.getIfAvailable(super::getExecutionContextSerializer);
 		}
 
 		@Override
@@ -133,6 +139,11 @@ protected Isolation getIsolationLevelForCreate() {
 			return (isolation != null) ? isolation : super.getIsolationLevelForCreate();
 		}
 
+		@Override
+		protected ExecutionContextSerializer getExecutionContextSerializer() {
+			return this.serializer;
+		}
+
 		@Override
 		protected ConfigurableConversionService getConversionService() {
 			ConfigurableConversionService conversionService = super.getConversionService();

spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/batch/BatchAutoConfigurationTests.java

@@ -43,6 +43,7 @@
 import org.springframework.batch.core.job.AbstractJob;
 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.BeansException;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -430,6 +431,17 @@ void conversionServiceCustomizersAreCalled() {
 			});
 	}
 
+	@Test
+	void whenTheUserDefinesCustomExecutionContextSerializer() {
+		this.contextRunner.withUserConfiguration(TestConfiguration.class, EmbeddedDataSourceConfiguration.class)
+			.withUserConfiguration(ExecutionContextConfiguration.class)
+			.run((context) -> {
+				ExecutionContextSerializer serializer = context.getBean(ExecutionContextSerializer.class);
+				SpringBootBatchConfiguration batchConfiguration = context.getBean(SpringBootBatchConfiguration.class);
+				assertThat(serializer).isEqualTo(batchConfiguration.getExecutionContextSerializer());
+			});
+	}
+
 	@Test
 	void whenTheUserDefinesAJobNameAsJobInstanceValidates() {
 		JobLauncherApplicationRunner runner = createInstance("another");
@@ -777,4 +789,14 @@ BatchConversionServiceCustomizer anotherBatchConversionServiceCustomizer() {
 
 	}
 
+	@Configuration(proxyBeanMethods = false)
+	static class ExecutionContextConfiguration {
+
+		@Bean
+		ExecutionContextSerializer executionContextSerializer() {
+			return mock(ExecutionContextSerializer.class);
+		}
+
+	}
+
 }