From 0e7d480545878a243f994787f6f877cdea00998f Mon Sep 17 00:00:00 2001 From: Yanming Zhou Date: Tue, 21 Jan 2025 10:02:49 +0800 Subject: [PATCH 1/2] Add spring.validation.method.adapt-constraint-violations property See gh-43886 Signed-off-by: Yanming Zhou --- .../DocumentConfigurationProperties.java | 3 +- .../ValidationAutoConfiguration.java | 10 +++- .../validation/ValidationProperties.java | 60 +++++++++++++++++++ .../ValidationAutoConfigurationTests.java | 16 ++++- 4 files changed, 85 insertions(+), 4 deletions(-) create mode 100644 spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/validation/ValidationProperties.java diff --git a/buildSrc/src/main/java/org/springframework/boot/build/context/properties/DocumentConfigurationProperties.java b/buildSrc/src/main/java/org/springframework/boot/build/context/properties/DocumentConfigurationProperties.java index a7ac94f60c..164350f408 100644 --- a/buildSrc/src/main/java/org/springframework/boot/build/context/properties/DocumentConfigurationProperties.java +++ b/buildSrc/src/main/java/org/springframework/boot/build/context/properties/DocumentConfigurationProperties.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2024 the original author or authors. + * Copyright 2012-2025 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. @@ -101,6 +101,7 @@ public abstract class DocumentConfigurationProperties extends DefaultTask { config.accept("spring.ssl"); config.accept("spring.task"); config.accept("spring.threads"); + config.accept("spring.validation"); config.accept("spring.mandatory-file-encoding"); config.accept("info"); config.accept("spring.output.ansi.enabled"); diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/validation/ValidationAutoConfiguration.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/validation/ValidationAutoConfiguration.java index a3df37fb11..2e1571bc28 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/validation/ValidationAutoConfiguration.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/validation/ValidationAutoConfiguration.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2023 the original author or authors. + * Copyright 2012-2025 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. @@ -27,6 +27,7 @@ import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; import org.springframework.boot.autoconfigure.condition.ConditionalOnResource; import org.springframework.boot.autoconfigure.condition.SearchStrategy; +import org.springframework.boot.context.properties.EnableConfigurationProperties; import org.springframework.boot.validation.MessageInterpolatorFactory; import org.springframework.boot.validation.beanvalidation.FilteredMethodValidationPostProcessor; import org.springframework.boot.validation.beanvalidation.MethodValidationExcludeFilter; @@ -44,11 +45,13 @@ import org.springframework.validation.beanvalidation.MethodValidationPostProcess * * @author Stephane Nicoll * @author Madhura Bhave + * @author Yanming Zhou * @since 1.5.0 */ @AutoConfiguration @ConditionalOnClass(ExecutableValidator.class) @ConditionalOnResource(resources = "classpath:META-INF/services/jakarta.validation.spi.ValidationProvider") +@EnableConfigurationProperties(ValidationProperties.class) @Import(PrimaryDefaultValidatorPostProcessor.class) public class ValidationAutoConfiguration { @@ -68,11 +71,14 @@ public class ValidationAutoConfiguration { @Bean @ConditionalOnMissingBean(search = SearchStrategy.CURRENT) public static MethodValidationPostProcessor methodValidationPostProcessor(Environment environment, - ObjectProvider validator, ObjectProvider excludeFilters) { + ObjectProvider validator, ObjectProvider excludeFilters, + ObjectProvider validationProperties) { FilteredMethodValidationPostProcessor processor = new FilteredMethodValidationPostProcessor( excludeFilters.orderedStream()); boolean proxyTargetClass = environment.getProperty("spring.aop.proxy-target-class", Boolean.class, true); processor.setProxyTargetClass(proxyTargetClass); + processor + .setAdaptConstraintViolations(validationProperties.getObject().getMethod().isAdaptConstraintViolations()); processor.setValidatorProvider(validator); return processor; } diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/validation/ValidationProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/validation/ValidationProperties.java new file mode 100644 index 0000000000..693ed613c2 --- /dev/null +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/validation/ValidationProperties.java @@ -0,0 +1,60 @@ +/* + * Copyright 2012-2025 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 + * + * https://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.validation; + +import org.springframework.boot.context.properties.ConfigurationProperties; + +/** + * Configuration properties for validation. + * + * @author Yanming Zhou + * @since 3.5.0 + */ +@ConfigurationProperties(prefix = "spring.validation") +public class ValidationProperties { + + private Method method = new Method(); + + public Method getMethod() { + return this.method; + } + + public void setMethod(Method method) { + this.method = method; + } + + /** + * Method validation properties. + */ + public static class Method { + + /** + * Whether to adapt ConstraintViolations to MethodValidationResult. + */ + private boolean adaptConstraintViolations; + + public boolean isAdaptConstraintViolations() { + return this.adaptConstraintViolations; + } + + public void setAdaptConstraintViolations(boolean adaptConstraintViolations) { + this.adaptConstraintViolations = adaptConstraintViolations; + } + + } + +} diff --git a/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/validation/ValidationAutoConfigurationTests.java b/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/validation/ValidationAutoConfigurationTests.java index 66dc324099..2136c1d991 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/validation/ValidationAutoConfigurationTests.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/validation/ValidationAutoConfigurationTests.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2023 the original author or authors. + * Copyright 2012-2025 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. @@ -46,6 +46,7 @@ import org.springframework.validation.beanvalidation.CustomValidatorBean; import org.springframework.validation.beanvalidation.LocalValidatorFactoryBean; import org.springframework.validation.beanvalidation.MethodValidationPostProcessor; import org.springframework.validation.beanvalidation.OptionalValidatorFactoryBean; +import org.springframework.validation.method.MethodValidationException; import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThatExceptionOfType; @@ -59,6 +60,7 @@ import static org.mockito.Mockito.mock; * * @author Stephane Nicoll * @author Phillip Webb + * @author Yanming Zhou */ class ValidationAutoConfigurationTests { @@ -207,6 +209,18 @@ class ValidationAutoConfigurationTests { }); } + @Test + void validationCanBeConfiguredToAdaptConstraintViolations() { + this.contextRunner.withUserConfiguration(AnotherSampleServiceConfiguration.class) + .withPropertyValues("spring.validation.method.adapt-constraint-violations=true") + .run((context) -> { + assertThat(context.getBeansOfType(Validator.class)).hasSize(1); + AnotherSampleService service = context.getBean(AnotherSampleService.class); + service.doSomething(42); + assertThatExceptionOfType(MethodValidationException.class).isThrownBy(() -> service.doSomething(2)); + }); + } + @Test @SuppressWarnings("unchecked") void userDefinedMethodValidationPostProcessorTakesPrecedence() { From c20f6cba8addb54b7fc2c0cd862b631cc0a9d628 Mon Sep 17 00:00:00 2001 From: Andy Wilkinson Date: Wed, 22 Jan 2025 14:36:18 +0000 Subject: [PATCH 2/2] Polish "Add spring.validation.method.adapt-constraint-violations property" See gh-43886 --- .../ValidationAutoConfiguration.java | 7 ++-- .../validation/ValidationProperties.java | 6 ++- .../validation/ValidationPropertiesTests.java | 38 +++++++++++++++++++ 3 files changed, 46 insertions(+), 5 deletions(-) create mode 100644 spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/validation/ValidationPropertiesTests.java diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/validation/ValidationAutoConfiguration.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/validation/ValidationAutoConfiguration.java index 2e1571bc28..d1af26e17a 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/validation/ValidationAutoConfiguration.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/validation/ValidationAutoConfiguration.java @@ -71,14 +71,13 @@ public class ValidationAutoConfiguration { @Bean @ConditionalOnMissingBean(search = SearchStrategy.CURRENT) public static MethodValidationPostProcessor methodValidationPostProcessor(Environment environment, - ObjectProvider validator, ObjectProvider excludeFilters, - ObjectProvider validationProperties) { + ValidationProperties validationProperties, ObjectProvider validator, + ObjectProvider excludeFilters) { FilteredMethodValidationPostProcessor processor = new FilteredMethodValidationPostProcessor( excludeFilters.orderedStream()); boolean proxyTargetClass = environment.getProperty("spring.aop.proxy-target-class", Boolean.class, true); processor.setProxyTargetClass(proxyTargetClass); - processor - .setAdaptConstraintViolations(validationProperties.getObject().getMethod().isAdaptConstraintViolations()); + processor.setAdaptConstraintViolations(validationProperties.getMethod().isAdaptConstraintViolations()); processor.setValidatorProvider(validator); return processor; } diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/validation/ValidationProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/validation/ValidationProperties.java index 693ed613c2..67e8bd8fea 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/validation/ValidationProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/validation/ValidationProperties.java @@ -16,14 +16,18 @@ package org.springframework.boot.autoconfigure.validation; +import org.springframework.beans.factory.config.BeanDefinition; import org.springframework.boot.context.properties.ConfigurationProperties; +import org.springframework.context.annotation.Role; /** - * Configuration properties for validation. + * {@link ConfigurationProperties @ConfigurationProperties} for validation. * * @author Yanming Zhou + * @author Andy Wilkinson * @since 3.5.0 */ +@Role(BeanDefinition.ROLE_INFRASTRUCTURE) @ConfigurationProperties(prefix = "spring.validation") public class ValidationProperties { diff --git a/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/validation/ValidationPropertiesTests.java b/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/validation/ValidationPropertiesTests.java new file mode 100644 index 0000000000..d507516c80 --- /dev/null +++ b/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/validation/ValidationPropertiesTests.java @@ -0,0 +1,38 @@ +/* + * Copyright 2012-2025 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 + * + * https://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.validation; + +import org.junit.jupiter.api.Test; + +import org.springframework.validation.beanvalidation.MethodValidationPostProcessor; + +import static org.assertj.core.api.Assertions.assertThat; + +/** + * Tests for {@link ValidationProperties}. + * + * @author Andy Wilkinson + */ +class ValidationPropertiesTests { + + @Test + void adaptConstraintViolationsPropertyDefaultMatchesPostProcessorDefault() { + assertThat(new MethodValidationPostProcessor()).extracting("adaptConstraintViolations") + .isEqualTo(new ValidationProperties().getMethod().isAdaptConstraintViolations()); + } + +}