Add a JobRegistryBeanPostProcessor in the default batch configuration

Resolves #4245

Author: fmbenhassine

spring-batch-core/src/main/java/org/springframework/batch/core/configuration/annotation/BatchRegistrar.java

@@ -22,6 +22,7 @@
 
 import org.springframework.batch.core.configuration.support.AutomaticJobRegistrar;
 import org.springframework.batch.core.configuration.support.DefaultJobLoader;
+import org.springframework.batch.core.configuration.support.JobRegistryBeanPostProcessor;
 import org.springframework.batch.core.configuration.support.MapJobRegistry;
 import org.springframework.batch.core.explore.support.JobExplorerFactoryBean;
 import org.springframework.batch.core.launch.support.JobOperatorFactoryBean;
@@ -61,6 +62,7 @@ public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, B
 		registerJobExplorer(registry, batchAnnotation);
 		registerJobLauncher(registry, batchAnnotation);
 		registerJobRegistry(registry);
+		registerJobRegistryBeanPostProcessor(registry);
 		registerJobOperator(registry, batchAnnotation);
 		registerAutomaticJobRegistrar(registry, batchAnnotation);
 		watch.stop();
@@ -217,6 +219,19 @@ private void registerJobRegistry(BeanDefinitionRegistry registry) {
 		registry.registerBeanDefinition("jobRegistry", beanDefinition);
 	}
 
+	private void registerJobRegistryBeanPostProcessor(BeanDefinitionRegistry registry) {
+		if (registry.containsBeanDefinition("jobRegistryBeanPostProcessor")) {
+			LOGGER.info("Bean jobRegistryBeanPostProcessor already defined in the application context, skipping"
+					+ " the registration of a jobRegistryBeanPostProcessor");
+			return;
+		}
+		BeanDefinitionBuilder beanDefinitionBuilder = BeanDefinitionBuilder
+			.genericBeanDefinition(JobRegistryBeanPostProcessor.class);
+		beanDefinitionBuilder.addPropertyReference("jobRegistry", "jobRegistry");
+
+		registry.registerBeanDefinition("jobRegistryBeanPostProcessor", beanDefinitionBuilder.getBeanDefinition());
+	}
+
 	private void registerJobOperator(BeanDefinitionRegistry registry, EnableBatchProcessing batchAnnotation) {
 		if (registry.containsBeanDefinition("jobOperator")) {
 			LOGGER.info("Bean jobOperator already defined in the application context, skipping"

spring-batch-core/src/main/java/org/springframework/batch/core/configuration/annotation/EnableBatchProcessing.java

@@ -91,6 +91,10 @@
  * <li>a {@link org.springframework.batch.core.launch.JobOperator} (bean name
  * "jobOperator" of type
  * {@link org.springframework.batch.core.launch.support.SimpleJobOperator})</li>
+ * <li>a
+ * {@link org.springframework.batch.core.configuration.support.JobRegistryBeanPostProcessor}
+ * (bean name "jobRegistryBeanPostProcessor" of type
+ * {@link org.springframework.batch.core.configuration.support.JobRegistryBeanPostProcessor})</li>
  * </ul>
  *
  * If the configuration is specified as <code>modular=true</code>, the context also

spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/DefaultBatchConfiguration.java

@@ -84,6 +84,7 @@
  * <li>a {@link JobLauncher} named "jobLauncher"</li>
  * <li>a {@link JobRegistry} named "jobRegistry"</li>
  * <li>a {@link JobOperator} named "JobOperator"</li>
+ * <li>a {@link JobRegistryBeanPostProcessor} named "jobRegistryBeanPostProcessor"</li>
  * <li>a {@link org.springframework.batch.core.scope.StepScope} named "stepScope"</li>
  * <li>a {@link org.springframework.batch.core.scope.JobScope} named "jobScope"</li>
  * </ul>
@@ -208,6 +209,19 @@ public JobOperator jobOperator() throws BatchConfigurationException {
 		}
 	}
 
+	@Bean
+	public JobRegistryBeanPostProcessor jobRegistryBeanPostProcessor() throws BatchConfigurationException {
+		JobRegistryBeanPostProcessor jobRegistryBeanPostProcessor = new JobRegistryBeanPostProcessor();
+		jobRegistryBeanPostProcessor.setJobRegistry(jobRegistry());
+		try {
+			jobRegistryBeanPostProcessor.afterPropertiesSet();
+			return jobRegistryBeanPostProcessor;
+		}
+		catch (Exception e) {
+			throw new BatchConfigurationException("Unable to configure the default job registry BeanPostProcessor", e);
+		}
+	}
+
 	/*
 	 * Getters to customize the configuration of infrastructure beans
 	 */

spring-batch-core/src/test/java/org/springframework/batch/core/configuration/annotation/BatchRegistrarTests.java

@@ -27,6 +27,7 @@
 import org.springframework.batch.core.DefaultJobKeyGenerator;
 import org.springframework.batch.core.JobKeyGenerator;
 import org.springframework.batch.core.configuration.JobRegistry;
+import org.springframework.batch.core.configuration.support.JobRegistryBeanPostProcessor;
 import org.springframework.batch.core.explore.JobExplorer;
 import org.springframework.batch.core.launch.JobLauncher;
 import org.springframework.batch.core.launch.JobOperator;
@@ -78,6 +79,7 @@ void testConfigurationWithUserDefinedBeans() {
 		Assertions.assertTrue(Mockito.mockingDetails(context.getBean(JobLauncher.class)).isMock());
 		Assertions.assertTrue(Mockito.mockingDetails(context.getBean(JobRegistry.class)).isMock());
 		Assertions.assertTrue(Mockito.mockingDetails(context.getBean(JobOperator.class)).isMock());
+		Assertions.assertTrue(Mockito.mockingDetails(context.getBean(JobRegistryBeanPostProcessor.class)).isMock());
 	}
 
 	@Test
@@ -160,13 +162,15 @@ void testDefaultInfrastructureBeansRegistration() {
 		JobExplorer jobExplorer = context.getBean(JobExplorer.class);
 		JobRegistry jobRegistry = context.getBean(JobRegistry.class);
 		JobOperator jobOperator = context.getBean(JobOperator.class);
+		JobRegistryBeanPostProcessor jobRegistryBeanPostProcessor = context.getBean(JobRegistryBeanPostProcessor.class);
 
 		// then
 		Assertions.assertNotNull(jobLauncher);
 		Assertions.assertNotNull(jobRepository);
 		Assertions.assertNotNull(jobExplorer);
 		Assertions.assertNotNull(jobRegistry);
 		Assertions.assertNotNull(jobOperator);
+		Assertions.assertNotNull(jobRegistryBeanPostProcessor);
 	}
 
 	@Test
@@ -244,6 +248,11 @@ public JobOperator jobOperator() {
 			return Mockito.mock();
 		}
 
+		@Bean
+		public JobRegistryBeanPostProcessor jobRegistryBeanPostProcessor() {
+			return Mockito.mock();
+		}
+
 	}
 
 	@Configuration

spring-batch-core/src/test/java/org/springframework/batch/core/configuration/support/DefaultBatchConfigurationTests.java

@@ -85,6 +85,9 @@ void testConfigurationWithCustomInfrastructureBean() {
 		Assertions.assertEquals(1, jobRepositories.size());
 		JobRepository jobRepository = jobRepositories.entrySet().iterator().next().getValue();
 		Assertions.assertInstanceOf(DummyJobRepository.class, jobRepository);
+		Map<String, JobRegistryBeanPostProcessor> jobRegistryBeanPostProcessorMap = context
+			.getBeansOfType(JobRegistryBeanPostProcessor.class);
+		Assertions.assertEquals(1, jobRegistryBeanPostProcessorMap.size());
 	}
 
 	@Test
@@ -98,13 +101,15 @@ void testDefaultInfrastructureBeansRegistration() {
 		JobExplorer jobExplorer = context.getBean(JobExplorer.class);
 		JobRegistry jobRegistry = context.getBean(JobRegistry.class);
 		JobOperator jobOperator = context.getBean(JobOperator.class);
+		JobRegistryBeanPostProcessor jobRegistryBeanPostProcessor = context.getBean(JobRegistryBeanPostProcessor.class);
 
 		// then
 		Assertions.assertNotNull(jobLauncher);
 		Assertions.assertNotNull(jobRepository);
 		Assertions.assertNotNull(jobExplorer);
 		Assertions.assertNotNull(jobRegistry);
 		Assertions.assertNotNull(jobOperator);
+		Assertions.assertNotNull(jobRegistryBeanPostProcessor);
 	}
 
 	@Configuration
@@ -154,6 +159,13 @@ public JobRepository jobRepository() {
 			return new DummyJobRepository();
 		}
 
+		@Bean
+		public JobRegistryBeanPostProcessor jobRegistryBeanPostProcessor(JobRegistry jobRegistry) {
+			JobRegistryBeanPostProcessor postProcessor = new JobRegistryBeanPostProcessor();
+			postProcessor.setJobRegistry(jobRegistry);
+			return postProcessor;
+		}
+
 	}
 
 }

spring-batch-docs/modules/ROOT/pages/job/advanced-meta-data.adoc

@@ -222,6 +222,8 @@ example has been given an `id` so that it can be included in child
 contexts (for example, as a parent bean definition) and cause all jobs created
 there to also be registered automatically.
 
+As of version 5.1, the `@EnableBatchProcessing` annotation automatically registers a `jobRegistryBeanPostProcessor` bean in the application context.
+
 [[automaticjobregistrar]]
 === AutomaticJobRegistrar