From 90cf722365cf03c3377cedb15eb9688598555480 Mon Sep 17 00:00:00 2001 From: Stephane Nicoll Date: Mon, 14 Jul 2014 11:04:21 +0200 Subject: [PATCH] Use @ConfigurationProperties for Spring Batch Fixes gh-1249 --- .../batch/BatchAutoConfiguration.java | 12 +-- .../batch/BatchDatabaseInitializer.java | 26 ++----- .../autoconfigure/batch/BatchProperties.java | 77 +++++++++++++++++++ 3 files changed, 90 insertions(+), 25 deletions(-) create mode 100644 spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/batch/BatchProperties.java diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/batch/BatchAutoConfiguration.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/batch/BatchAutoConfiguration.java index 31c4d1ed3bb..5c13e70652c 100644 --- a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/batch/BatchAutoConfiguration.java +++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/batch/BatchAutoConfiguration.java @@ -29,7 +29,6 @@ import org.springframework.batch.core.launch.JobOperator; import org.springframework.batch.core.launch.support.SimpleJobOperator; import org.springframework.batch.core.repository.JobRepository; import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.beans.factory.annotation.Value; import org.springframework.boot.ExitCodeGenerator; import org.springframework.boot.autoconfigure.AutoConfigureAfter; import org.springframework.boot.autoconfigure.EnableAutoConfiguration; @@ -38,6 +37,7 @@ import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; import org.springframework.boot.autoconfigure.condition.ConditionalOnExpression; import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; import org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration; +import org.springframework.boot.context.properties.EnableConfigurationProperties; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.jdbc.core.JdbcOperations; @@ -60,10 +60,11 @@ import org.springframework.util.StringUtils; @ConditionalOnClass({ JobLauncher.class, DataSource.class, JdbcOperations.class }) @AutoConfigureAfter(HibernateJpaAutoConfiguration.class) @ConditionalOnBean(JobLauncher.class) +@EnableConfigurationProperties(BatchProperties.class) public class BatchAutoConfiguration { - @Value("${spring.batch.job.names:}") - private String jobNames; + @Autowired + private BatchProperties properties; @Autowired(required = false) private JobParametersConverter jobParametersConverter; @@ -82,8 +83,9 @@ public class BatchAutoConfiguration { JobLauncher jobLauncher, JobExplorer jobExplorer) { JobLauncherCommandLineRunner runner = new JobLauncherCommandLineRunner( jobLauncher, jobExplorer); - if (StringUtils.hasText(this.jobNames)) { - runner.setJobNames(this.jobNames); + String jobNames = this.properties.getJob().getNames(); + if (StringUtils.hasText(jobNames)) { + runner.setJobNames(jobNames); } return runner; } diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/batch/BatchDatabaseInitializer.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/batch/BatchDatabaseInitializer.java index c08435449af..63b744a6e16 100644 --- a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/batch/BatchDatabaseInitializer.java +++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/batch/BatchDatabaseInitializer.java @@ -21,10 +21,6 @@ import javax.sql.DataSource; import org.springframework.batch.support.DatabaseType; import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.beans.factory.annotation.Value; -import org.springframework.boot.bind.RelaxedPropertyResolver; -import org.springframework.context.EnvironmentAware; -import org.springframework.core.env.Environment; import org.springframework.core.io.ResourceLoader; import org.springframework.jdbc.datasource.init.DatabasePopulatorUtils; import org.springframework.jdbc.datasource.init.ResourceDatabasePopulator; @@ -37,10 +33,11 @@ import org.springframework.stereotype.Component; * @author Dave Syer */ @Component -public class BatchDatabaseInitializer implements EnvironmentAware { +public class BatchDatabaseInitializer { - private static final String DEFAULT_SCHEMA_LOCATION = "classpath:org/springframework/" - + "batch/core/schema-@@platform@@.sql"; + + @Autowired + private BatchProperties properties; @Autowired private DataSource dataSource; @@ -48,19 +45,9 @@ public class BatchDatabaseInitializer implements EnvironmentAware { @Autowired private ResourceLoader resourceLoader; - @Value("${spring.batch.initializer.enabled:true}") - private boolean enabled = true; - - private RelaxedPropertyResolver environment; - - @Override - public void setEnvironment(Environment environment) { - this.environment = new RelaxedPropertyResolver(environment, "spring.batch."); - } - @PostConstruct protected void initialize() { - if (this.enabled) { + if (this.properties.getInitializer().isEnabled()) { String platform = getDatabaseType(); if ("hsql".equals(platform)) { platform = "hsqldb"; @@ -72,8 +59,7 @@ public class BatchDatabaseInitializer implements EnvironmentAware { platform = "oracle10g"; } ResourceDatabasePopulator populator = new ResourceDatabasePopulator(); - String schemaLocation = this.environment.getProperty("schema", - DEFAULT_SCHEMA_LOCATION); + String schemaLocation = this.properties.getSchema(); schemaLocation = schemaLocation.replace("@@platform@@", platform); populator.addScript(this.resourceLoader.getResource(schemaLocation)); populator.setContinueOnError(true); diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/batch/BatchProperties.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/batch/BatchProperties.java new file mode 100644 index 00000000000..717064c30d5 --- /dev/null +++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/batch/BatchProperties.java @@ -0,0 +1,77 @@ +/* + * Copyright 2012-2014 the original author or authors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.springframework.boot.autoconfigure.batch; + +import org.springframework.boot.context.properties.ConfigurationProperties; + +/** + * Configuration properties for Spring Batch. + * + * @author Stephane Nicoll + * @since 1.2.0 + */ +@ConfigurationProperties("spring.batch") +public class BatchProperties { + + private static final String DEFAULT_SCHEMA_LOCATION = "classpath:org/springframework/" + + "batch/core/schema-@@platform@@.sql"; + + + private String schema = DEFAULT_SCHEMA_LOCATION; + + private final Initializer initializer = new Initializer(); + + private final Job job = new Job(); + + public String getSchema() { + return schema; + } + + public void setSchema(String schema) { + this.schema = schema; + } + + public Initializer getInitializer() { + return initializer; + } + + public Job getJob() { + return job; + } + + public static class Initializer { + + private boolean enabled = true; + + public boolean isEnabled() { + return enabled; + } + + public void setEnabled(boolean enabled) { + this.enabled = enabled; + } + } + + public static class Job { + + private String names = ""; + + public String getNames() { + return names; + } + } +}