Skip to content

Commit 3b0868d

Browse files
k42kefmbenhassine
authored andcommitted
Extract bean name string literals to constants
- Extract hardcoded bean name strings to static final constants - Improve code maintainability and reduce the risk of typos - No functional changes Signed-off-by: kimjg <[email protected]>
1 parent f888ebb commit 3b0868d

File tree

1 file changed

+28
-18
lines changed
  • spring-batch-core/src/main/java/org/springframework/batch/core/configuration/annotation

1 file changed

+28
-18
lines changed

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

Lines changed: 28 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2022-2024 the original author or authors.
2+
* Copyright 2022-2025 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -51,6 +51,16 @@ class BatchRegistrar implements ImportBeanDefinitionRegistrar {
5151

5252
private static final String MISSING_ANNOTATION_ERROR_MESSAGE = "EnableBatchProcessing is not present on importing class '%s' as expected";
5353

54+
private static final String JOB_REPOSITORY = "jobRepository";
55+
56+
private static final String JOB_EXPLORER = "jobExplorer";
57+
58+
private static final String JOB_LAUNCHER = "jobLauncher";
59+
60+
private static final String JOB_REGISTRY = "jobRegistry";
61+
62+
private static final String JOB_LOADER = "jobLoader";
63+
5464
@Override
5565
public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
5666
StopWatch watch = new StopWatch();
@@ -80,7 +90,7 @@ private void validateState(AnnotationMetadata importingClassMetadata) {
8090
}
8191

8292
private void registerJobRepository(BeanDefinitionRegistry registry, EnableBatchProcessing batchAnnotation) {
83-
if (registry.containsBeanDefinition("jobRepository")) {
93+
if (registry.containsBeanDefinition(JOB_REPOSITORY)) {
8494
LOGGER.info("Bean jobRepository already defined in the application context, skipping"
8595
+ " the registration of a jobRepository");
8696
return;
@@ -143,11 +153,11 @@ private void registerJobRepository(BeanDefinitionRegistry registry, EnableBatchP
143153

144154
beanDefinitionBuilder.addPropertyValue("maxVarCharLength", batchAnnotation.maxVarCharLength());
145155
beanDefinitionBuilder.addPropertyValue("clobType", batchAnnotation.clobType());
146-
registry.registerBeanDefinition("jobRepository", beanDefinitionBuilder.getBeanDefinition());
156+
registry.registerBeanDefinition(JOB_REPOSITORY, beanDefinitionBuilder.getBeanDefinition());
147157
}
148158

149159
private void registerJobExplorer(BeanDefinitionRegistry registry, EnableBatchProcessing batchAnnotation) {
150-
if (registry.containsBeanDefinition("jobExplorer")) {
160+
if (registry.containsBeanDefinition(JOB_EXPLORER)) {
151161
LOGGER.info("Bean jobExplorer already defined in the application context, skipping"
152162
+ " the registration of a jobExplorer");
153163
return;
@@ -192,37 +202,37 @@ private void registerJobExplorer(BeanDefinitionRegistry registry, EnableBatchPro
192202
if (tablePrefix != null) {
193203
beanDefinitionBuilder.addPropertyValue("tablePrefix", tablePrefix);
194204
}
195-
registry.registerBeanDefinition("jobExplorer", beanDefinitionBuilder.getBeanDefinition());
205+
registry.registerBeanDefinition(JOB_EXPLORER, beanDefinitionBuilder.getBeanDefinition());
196206
}
197207

198208
private void registerJobLauncher(BeanDefinitionRegistry registry, EnableBatchProcessing batchAnnotation) {
199-
if (registry.containsBeanDefinition("jobLauncher")) {
209+
if (registry.containsBeanDefinition(JOB_LAUNCHER)) {
200210
LOGGER.info("Bean jobLauncher already defined in the application context, skipping"
201211
+ " the registration of a jobLauncher");
202212
return;
203213
}
204214
BeanDefinitionBuilder beanDefinitionBuilder = BeanDefinitionBuilder
205215
.genericBeanDefinition(TaskExecutorJobLauncher.class);
206216
// set mandatory properties
207-
beanDefinitionBuilder.addPropertyReference("jobRepository", "jobRepository");
217+
beanDefinitionBuilder.addPropertyReference(JOB_REPOSITORY, JOB_REPOSITORY);
208218

209219
// set optional properties
210220
String taskExecutorRef = batchAnnotation.taskExecutorRef();
211221
if (registry.containsBeanDefinition(taskExecutorRef)) {
212222
beanDefinitionBuilder.addPropertyReference("taskExecutor", taskExecutorRef);
213223
}
214-
registry.registerBeanDefinition("jobLauncher", beanDefinitionBuilder.getBeanDefinition());
224+
registry.registerBeanDefinition(JOB_LAUNCHER, beanDefinitionBuilder.getBeanDefinition());
215225
}
216226

217227
private void registerJobRegistry(BeanDefinitionRegistry registry) {
218-
if (registry.containsBeanDefinition("jobRegistry")) {
228+
if (registry.containsBeanDefinition(JOB_REGISTRY)) {
219229
LOGGER.info("Bean jobRegistry already defined in the application context, skipping"
220230
+ " the registration of a jobRegistry");
221231
return;
222232
}
223233
BeanDefinition beanDefinition = BeanDefinitionBuilder.genericBeanDefinition(MapJobRegistry.class)
224234
.getBeanDefinition();
225-
registry.registerBeanDefinition("jobRegistry", beanDefinition);
235+
registry.registerBeanDefinition(JOB_REGISTRY, beanDefinition);
226236
}
227237

228238
private void registerJobRegistrySmartInitializingSingleton(BeanDefinitionRegistry registry) {
@@ -234,7 +244,7 @@ private void registerJobRegistrySmartInitializingSingleton(BeanDefinitionRegistr
234244
}
235245
BeanDefinitionBuilder beanDefinitionBuilder = BeanDefinitionBuilder
236246
.genericBeanDefinition(JobRegistrySmartInitializingSingleton.class);
237-
beanDefinitionBuilder.addPropertyReference("jobRegistry", "jobRegistry");
247+
beanDefinitionBuilder.addPropertyReference(JOB_REGISTRY, JOB_REGISTRY);
238248

239249
registry.registerBeanDefinition("jobRegistrySmartInitializingSingleton",
240250
beanDefinitionBuilder.getBeanDefinition());
@@ -252,10 +262,10 @@ private void registerJobOperator(BeanDefinitionRegistry registry, EnableBatchPro
252262
String transactionManagerRef = batchAnnotation.transactionManagerRef();
253263
beanDefinitionBuilder.addPropertyReference("transactionManager", transactionManagerRef);
254264

255-
beanDefinitionBuilder.addPropertyReference("jobRepository", "jobRepository");
256-
beanDefinitionBuilder.addPropertyReference("jobLauncher", "jobLauncher");
257-
beanDefinitionBuilder.addPropertyReference("jobExplorer", "jobExplorer");
258-
beanDefinitionBuilder.addPropertyReference("jobRegistry", "jobRegistry");
265+
beanDefinitionBuilder.addPropertyReference(JOB_REPOSITORY, JOB_REPOSITORY);
266+
beanDefinitionBuilder.addPropertyReference(JOB_LAUNCHER, JOB_LAUNCHER);
267+
beanDefinitionBuilder.addPropertyReference(JOB_EXPLORER, JOB_EXPLORER);
268+
beanDefinitionBuilder.addPropertyReference(JOB_REGISTRY, JOB_REGISTRY);
259269

260270
// set optional properties
261271
String jobParametersConverterRef = batchAnnotation.jobParametersConverterRef();
@@ -276,12 +286,12 @@ private void registerAutomaticJobRegistrar(BeanDefinitionRegistry registry, Enab
276286
return;
277287
}
278288
BeanDefinition jobLoaderBeanDefinition = BeanDefinitionBuilder.genericBeanDefinition(DefaultJobLoader.class)
279-
.addPropertyReference("jobRegistry", "jobRegistry")
289+
.addPropertyReference(JOB_REGISTRY, JOB_REGISTRY)
280290
.getBeanDefinition();
281-
registry.registerBeanDefinition("jobLoader", jobLoaderBeanDefinition);
291+
registry.registerBeanDefinition(JOB_LOADER, jobLoaderBeanDefinition);
282292
BeanDefinition jobRegistrarBeanDefinition = BeanDefinitionBuilder
283293
.genericBeanDefinition(AutomaticJobRegistrar.class)
284-
.addPropertyReference("jobLoader", "jobLoader")
294+
.addPropertyReference(JOB_LOADER, JOB_LOADER)
285295
.getBeanDefinition();
286296
registry.registerBeanDefinition("jobRegistrar", jobRegistrarBeanDefinition);
287297
}

0 commit comments

Comments
 (0)