From 80754d5cc2dd7375d41fda60a80a63be4df098dd Mon Sep 17 00:00:00 2001 From: Stephane Nicoll Date: Thu, 23 Jul 2015 10:55:50 +0200 Subject: [PATCH] Polish Closes gh-3534 --- spring-boot-samples/README.adoc | 2 +- .../application.properties | 2 - .../build.gradle | 49 ------------ .../pom.xml | 8 +- .../propertyvalidation/SampleProperties.java | 10 ++- ...or.java => SamplePropertiesValidator.java} | 33 ++------- .../SamplePropertyValidationApplication.java | 36 ++++++--- .../src/main/resources/application.properties | 4 +- ...plePropertyValidationApplicationTests.java | 74 +++++++++++-------- .../src/test/resources/application.properties | 2 - 10 files changed, 92 insertions(+), 128 deletions(-) delete mode 100644 spring-boot-samples/spring-boot-sample-property-validation/application.properties delete mode 100644 spring-boot-samples/spring-boot-sample-property-validation/build.gradle rename spring-boot-samples/spring-boot-sample-property-validation/src/main/java/sample/propertyvalidation/{ConfigurationPropertiesValidator.java => SamplePropertiesValidator.java} (55%) delete mode 100644 spring-boot-samples/spring-boot-sample-property-validation/src/test/resources/application.properties diff --git a/spring-boot-samples/README.adoc b/spring-boot-samples/README.adoc index 549e308ae1..1f4bb2037d 100644 --- a/spring-boot-samples/README.adoc +++ b/spring-boot-samples/README.adoc @@ -71,7 +71,7 @@ * link:spring-boot-sample-profile[spring-boot-sample-profile] -- example showing Spring's `@profile` support * link:spring-boot-sample-property-validation[spring-boot-sample-property-validation] - -- example showing the usage of @ConfigurationProperties` with a Spring's `Validator` + -- example showing the usage of `@ConfigurationProperties` with a Spring `Validator` * link:spring-boot-sample-parent-context[spring-boot-sample-parent-context] -- example showing an `ApplicationContext` with a parent * link:spring-boot-sample-aop[spring-boot-sample-aop] diff --git a/spring-boot-samples/spring-boot-sample-property-validation/application.properties b/spring-boot-samples/spring-boot-sample-property-validation/application.properties deleted file mode 100644 index 2a20a86341..0000000000 --- a/spring-boot-samples/spring-boot-sample-property-validation/application.properties +++ /dev/null @@ -1,2 +0,0 @@ -host: 192.168.0.1 -port: 8080 \ No newline at end of file diff --git a/spring-boot-samples/spring-boot-sample-property-validation/build.gradle b/spring-boot-samples/spring-boot-sample-property-validation/build.gradle deleted file mode 100644 index 1d71e48466..0000000000 --- a/spring-boot-samples/spring-boot-sample-property-validation/build.gradle +++ /dev/null @@ -1,49 +0,0 @@ -buildscript { - ext { - springBootVersion = '1.3.0.BUILD-SNAPSHOT' - } - repositories { - // NOTE: You should declare only repositories that you need here - mavenLocal() - mavenCentral() - maven { url "http://repo.spring.io/release" } - maven { url "http://repo.spring.io/milestone" } - maven { url "http://repo.spring.io/snapshot" } - } - dependencies { - classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}") - } -} - -apply plugin: 'java' -apply plugin: 'eclipse' -apply plugin: 'idea' -apply plugin: 'spring-boot' - -jar { - baseName = 'spring-boot-sample-property-validation' - version = '0.0.0' -} - -run { - systemProperties = System.properties -} - -repositories { - // NOTE: You should declare only repositories that you need here - mavenLocal() - mavenCentral() - maven { url "http://repo.spring.io/release" } - maven { url "http://repo.spring.io/milestone" } - maven { url "http://repo.spring.io/snapshot" } -} - -dependencies { - compile("org.springframework.boot:spring-boot-starter") - compile("org.hibernate:hibernate-validator") - testCompile("org.springframework.boot:spring-boot-starter-test") -} - -task wrapper(type: Wrapper) { - gradleVersion = '1.6' -} diff --git a/spring-boot-samples/spring-boot-sample-property-validation/pom.xml b/spring-boot-samples/spring-boot-sample-property-validation/pom.xml index d94035fe02..d67b931ae0 100644 --- a/spring-boot-samples/spring-boot-sample-property-validation/pom.xml +++ b/spring-boot-samples/spring-boot-sample-property-validation/pom.xml @@ -23,11 +23,13 @@ org.springframework.boot spring-boot-starter + - org.hibernate - hibernate-validator - 5.1.3.Final + org.springframework.boot + spring-boot-configuration-processor + true + org.springframework.boot spring-boot-starter-test diff --git a/spring-boot-samples/spring-boot-sample-property-validation/src/main/java/sample/propertyvalidation/SampleProperties.java b/spring-boot-samples/spring-boot-sample-property-validation/src/main/java/sample/propertyvalidation/SampleProperties.java index ce8be115d8..0f79a28ece 100644 --- a/spring-boot-samples/spring-boot-sample-property-validation/src/main/java/sample/propertyvalidation/SampleProperties.java +++ b/spring-boot-samples/spring-boot-sample-property-validation/src/main/java/sample/propertyvalidation/SampleProperties.java @@ -20,12 +20,18 @@ import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.stereotype.Component; @Component -@ConfigurationProperties +@ConfigurationProperties(prefix = "sample") public class SampleProperties { + /** + * Sample host. + */ private String host; - private Integer port; + /** + * Sample port. + */ + private Integer port = 8080; public String getHost() { return host; diff --git a/spring-boot-samples/spring-boot-sample-property-validation/src/main/java/sample/propertyvalidation/ConfigurationPropertiesValidator.java b/spring-boot-samples/spring-boot-sample-property-validation/src/main/java/sample/propertyvalidation/SamplePropertiesValidator.java similarity index 55% rename from spring-boot-samples/spring-boot-sample-property-validation/src/main/java/sample/propertyvalidation/ConfigurationPropertiesValidator.java rename to spring-boot-samples/spring-boot-sample-property-validation/src/main/java/sample/propertyvalidation/SamplePropertiesValidator.java index 1cd3cf8bc4..8e4feb9e41 100644 --- a/spring-boot-samples/spring-boot-sample-property-validation/src/main/java/sample/propertyvalidation/ConfigurationPropertiesValidator.java +++ b/spring-boot-samples/spring-boot-sample-property-validation/src/main/java/sample/propertyvalidation/SamplePropertiesValidator.java @@ -16,46 +16,29 @@ package sample.propertyvalidation; -import org.springframework.boot.context.properties.ConfigurationProperties; -import org.springframework.core.annotation.AnnotationUtils; -import org.springframework.stereotype.Component; +import java.util.regex.Pattern; + import org.springframework.validation.Errors; import org.springframework.validation.ValidationUtils; import org.springframework.validation.Validator; -import java.util.HashSet; -import java.util.Set; -import java.util.regex.Pattern; - -@Component(value = "configurationPropertiesValidator") -public class ConfigurationPropertiesValidator implements Validator { - - public static final String IP_REGEX = "^(?:[0-9]{1,3}\\.){3}[0-9]{1,3}$"; +public class SamplePropertiesValidator implements Validator { - final Pattern pattern = Pattern.compile(IP_REGEX); - - private Set validatedClasses = new HashSet() {{ - add(SampleProperties.class.getName()); - }}; + final Pattern pattern = Pattern.compile("^(?:[0-9]{1,3}\\.){3}[0-9]{1,3}$"); @Override - public boolean supports(Class aClass) { - return AnnotationUtils.findAnnotation(aClass, ConfigurationProperties.class) != null; + public boolean supports(Class type) { + return type == SampleProperties.class; } @Override public void validate(Object o, Errors errors) { - if(validatedClasses.contains(o.getClass().getName())) { - doValidation(o, errors); - } - } - - private void doValidation(Object o, Errors errors) { ValidationUtils.rejectIfEmpty(errors, "host", "host.empty"); ValidationUtils.rejectIfEmpty(errors, "port", "port.empty"); SampleProperties properties = (SampleProperties) o; - if(!pattern.matcher(properties.getHost()).matches()) { + if (properties.getHost() != null && + !pattern.matcher(properties.getHost()).matches()) { errors.rejectValue("host", "Invalid host"); } } diff --git a/spring-boot-samples/spring-boot-sample-property-validation/src/main/java/sample/propertyvalidation/SamplePropertyValidationApplication.java b/spring-boot-samples/spring-boot-sample-property-validation/src/main/java/sample/propertyvalidation/SamplePropertyValidationApplication.java index 023f32ae48..44e061af47 100644 --- a/spring-boot-samples/spring-boot-sample-property-validation/src/main/java/sample/propertyvalidation/SamplePropertyValidationApplication.java +++ b/spring-boot-samples/spring-boot-sample-property-validation/src/main/java/sample/propertyvalidation/SamplePropertyValidationApplication.java @@ -18,26 +18,42 @@ package sample.propertyvalidation; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.CommandLineRunner; -import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; - +import org.springframework.boot.builder.SpringApplicationBuilder; import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Profile; +import org.springframework.stereotype.Service; +import org.springframework.validation.Validator; @SpringBootApplication @EnableConfigurationProperties -public class SamplePropertyValidationApplication implements CommandLineRunner { +public class SamplePropertyValidationApplication { + + @Bean + public Validator configurationPropertiesValidator() { + return new SamplePropertiesValidator(); + } + + @Service + @Profile("app") + static class Startup implements CommandLineRunner { - @Autowired - private SampleProperties properties; + @Autowired + private SampleProperties properties; - @Override - public void run(String... args) { - System.out.println("host: " + this.properties.getHost()); - System.out.println("port:" + this.properties.getPort()); + @Override + public void run(String... args) { + System.out.println("========================================="); + System.out.println("Sample host: " + this.properties.getHost()); + System.out.println("Sample port: " + this.properties.getPort()); + System.out.println("========================================="); + } } public static void main(String[] args) throws Exception { - SpringApplication.run(SamplePropertyValidationApplication.class, args); + new SpringApplicationBuilder(SamplePropertyValidationApplication.class) + .profiles("app").run(args); } } diff --git a/spring-boot-samples/spring-boot-sample-property-validation/src/main/resources/application.properties b/spring-boot-samples/spring-boot-sample-property-validation/src/main/resources/application.properties index 2a20a86341..b28381563f 100644 --- a/spring-boot-samples/spring-boot-sample-property-validation/src/main/resources/application.properties +++ b/spring-boot-samples/spring-boot-sample-property-validation/src/main/resources/application.properties @@ -1,2 +1,2 @@ -host: 192.168.0.1 -port: 8080 \ No newline at end of file +sample.host=192.168.0.1 +sample.port=7070 \ No newline at end of file diff --git a/spring-boot-samples/spring-boot-sample-property-validation/src/test/java/sample/propertyvalidation/SamplePropertyValidationApplicationTests.java b/spring-boot-samples/spring-boot-sample-property-validation/src/test/java/sample/propertyvalidation/SamplePropertyValidationApplicationTests.java index e8c61d915b..b822fc6aad 100644 --- a/spring-boot-samples/spring-boot-sample-property-validation/src/test/java/sample/propertyvalidation/SamplePropertyValidationApplicationTests.java +++ b/spring-boot-samples/spring-boot-sample-property-validation/src/test/java/sample/propertyvalidation/SamplePropertyValidationApplicationTests.java @@ -16,15 +16,15 @@ package sample.propertyvalidation; +import org.junit.After; +import org.junit.Rule; import org.junit.Test; +import org.junit.rules.ExpectedException; + import org.springframework.beans.factory.BeanCreationException; import org.springframework.boot.autoconfigure.web.ServerProperties; -import org.springframework.boot.context.properties.EnableConfigurationProperties; import org.springframework.boot.test.EnvironmentTestUtils; import org.springframework.context.annotation.AnnotationConfigApplicationContext; -import org.springframework.context.annotation.Bean; -import org.springframework.context.annotation.Configuration; -import org.springframework.validation.Validator; import static org.junit.Assert.assertEquals; @@ -32,54 +32,64 @@ import static org.junit.Assert.assertEquals; * Tests for {@link SamplePropertyValidationApplication}. * * @author Lucas Saldanha + * @author Stephane Nicoll */ public class SamplePropertyValidationApplicationTests { + @Rule + public final ExpectedException thrown = ExpectedException.none(); + private final AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(); + @After + public void closeContext() { + context.close(); + } + @Test - public void testBindingValidProperties() { - this.context.register(TestConfiguration.class); - EnvironmentTestUtils.addEnvironment(this.context, "host:192.168.0.1"); - EnvironmentTestUtils.addEnvironment(this.context, "port:8080"); + public void bindValidProperties() { + this.context.register(SamplePropertyValidationApplication.class); + EnvironmentTestUtils.addEnvironment(this.context, + "sample.host:192.168.0.1", "sample.port:9090"); this.context.refresh(); - assertEquals(1, this.context.getBeanNamesForType(SampleProperties.class).length); SampleProperties properties = this.context.getBean(SampleProperties.class); assertEquals("192.168.0.1", properties.getHost()); - assertEquals(8080, (int) properties.getPort()); + assertEquals(Integer.valueOf(9090), properties.getPort()); } - @Test(expected = BeanCreationException.class) - public void testBindingInvalidProperties() { - this.context.register(TestConfiguration.class); - EnvironmentTestUtils.addEnvironment(this.context, "host:xxxxxx"); - EnvironmentTestUtils.addEnvironment(this.context, "port:8080"); + @Test + public void bindInvalidHost() { + this.context.register(SamplePropertyValidationApplication.class); + EnvironmentTestUtils.addEnvironment(this.context, + "sample.host:xxxxxx", "sample.port:9090"); + + thrown.expect(BeanCreationException.class); + thrown.expectMessage("xxxxxx"); this.context.refresh(); } @Test - public void testBindingValidPropertiesWithMultipleConfigurationPropertiesClasses() { - this.context.register(TestConfiguration.class); - this.context.register(ServerProperties.class); - EnvironmentTestUtils.addEnvironment(this.context, "host:192.168.0.1"); - EnvironmentTestUtils.addEnvironment(this.context, "port:8080"); - this.context.refresh(); + public void bindNullHost() { + this.context.register(SamplePropertyValidationApplication.class); - assertEquals(1, this.context.getBeanNamesForType(SampleProperties.class).length); - SampleProperties properties = this.context.getBean(SampleProperties.class); - assertEquals("192.168.0.1", properties.getHost()); - assertEquals(8080, (int) properties.getPort()); + thrown.expect(BeanCreationException.class); + thrown.expectMessage("null"); + thrown.expectMessage("host"); + this.context.refresh(); } - @Configuration - @EnableConfigurationProperties(SampleProperties.class) - protected static class TestConfiguration { + @Test + public void validatorOnlyCalledOnSupportedClass() { + this.context.register(SamplePropertyValidationApplication.class); + this.context.register(ServerProperties.class); // our validator will not apply here + EnvironmentTestUtils.addEnvironment(this.context, + "sample.host:192.168.0.1", "sample.port:9090"); + this.context.refresh(); - @Bean - public Validator configurationPropertiesValidator() { - return new ConfigurationPropertiesValidator(); - } + SampleProperties properties = this.context.getBean(SampleProperties.class); + assertEquals("192.168.0.1", properties.getHost()); + assertEquals(Integer.valueOf(9090), properties.getPort()); } } diff --git a/spring-boot-samples/spring-boot-sample-property-validation/src/test/resources/application.properties b/spring-boot-samples/spring-boot-sample-property-validation/src/test/resources/application.properties deleted file mode 100644 index 2a20a86341..0000000000 --- a/spring-boot-samples/spring-boot-sample-property-validation/src/test/resources/application.properties +++ /dev/null @@ -1,2 +0,0 @@ -host: 192.168.0.1 -port: 8080 \ No newline at end of file