Spring/spring-boot
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #39452 from BenchmarkingBuffalo

Browse Source 
* gh-39452:
  Polish "Support `@Name` with JavaBean-based configuration properties"
  Support `@Name` with JavaBean-based configuration properties

Closes gh-39452
This commit is contained in:
Andy Wilkinson
2024-07-23 15:05:17 +01:00
parent c790deb7d2 23b344691d
commit 0209ab50d3
13 changed files with 229 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/features/external-config.adoc
View File

@@ -713,6 +713,8 @@ The preceding POJO defines the following properties:
* `my.service.security.password`.
* `my.service.security.roles`, with a collection of `String` that defaults to `USER`.
TIP: To use a reserved keyword in the name of a property, such as `my.service.import`, use the `@Name` annotation on the property's field.
NOTE: The properties that map to `@ConfigurationProperties` classes available in Spring Boot, which are configured through properties files, YAML files, environment variables, and other mechanisms, are public API but the accessors (getters/setters) of the class itself are not meant to be used directly.
[NOTE]

18
spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/main/java/org/springframework/boot/configurationprocessor/PropertyDescriptorResolver.java
View File

@@ -85,7 +85,7 @@ class PropertyDescriptorResolver {
private PropertyDescriptor extracted(TypeElement declaringElement, TypeElementMembers members,
VariableElement parameter) {
String name = getParameterName(parameter);
String name = getPropertyName(parameter);
TypeMirror type = parameter.asType();
ExecutableElement getter = members.getPublicGetter(name, type);
ExecutableElement setter = members.getPublicSetter(name, type);
@@ -98,12 +98,16 @@ class PropertyDescriptorResolver {
field);
}
private String getParameterName(VariableElement parameter) {
private String getPropertyName(VariableElement parameter) {
return getPropertyName(parameter, parameter.getSimpleName().toString());
}
private String getPropertyName(VariableElement parameter, String fallback) {
AnnotationMirror nameAnnotation = this.environment.getNameAnnotation(parameter);
if (nameAnnotation != null) {
return this.environment.getAnnotationElementStringValue(nameAnnotation, "value");
}
return parameter.getSimpleName().toString();
return fallback;
}
private Stream<PropertyDescriptor> resolveJavaBeanProperties(TypeElement declaringElement,
@@ -114,16 +118,16 @@ class PropertyDescriptorResolver {
VariableElement field = members.getFields().get(name);
ExecutableElement getter = findMatchingGetter(members, getters, field);
TypeMirror propertyType = getter.getReturnType();
register(candidates, new JavaBeanPropertyDescriptor(name, propertyType, declaringElement, getter,
members.getPublicSetter(name, propertyType), field, factoryMethod));
register(candidates, new JavaBeanPropertyDescriptor(getPropertyName(field, name), propertyType,
declaringElement, getter, members.getPublicSetter(name, propertyType), field, factoryMethod));
});
// Then check for Lombok ones
members.getFields().forEach((name, field) -> {
TypeMirror propertyType = field.asType();
ExecutableElement getter = members.getPublicGetter(name, propertyType);
ExecutableElement setter = members.getPublicSetter(name, propertyType);
register(candidates, new LombokPropertyDescriptor(name, propertyType, declaringElement, getter, setter,
field, factoryMethod));
register(candidates, new LombokPropertyDescriptor(getPropertyName(field, name), propertyType,
declaringElement, getter, setter, field, factoryMethod));
});
return candidates.values().stream();
}

41
spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationprocessor/ImmutableNameAnnotationPropertiesTests.java
View File

@@ -1,41 +0,0 @@
/*
* Copyright 2012-2023 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.configurationprocessor;
import org.junit.jupiter.api.Test;
import org.springframework.boot.configurationprocessor.metadata.ConfigurationMetadata;
import org.springframework.boot.configurationprocessor.metadata.Metadata;
import org.springframework.boot.configurationsample.immutable.ImmutableNameAnnotationProperties;
import static org.assertj.core.api.Assertions.assertThat;
/**
* Metadata generation tests for immutable properties using {@code @Name}.
*
* @author Phillip Webb
*/
class ImmutableNameAnnotationPropertiesTests extends AbstractMetadataGenerationTests {
@Test
void immutableNameAnnotationProperties() {
ConfigurationMetadata metadata = compile(ImmutableNameAnnotationProperties.class);
assertThat(metadata).has(Metadata.withProperty("named.import", String.class)
.fromSource(ImmutableNameAnnotationProperties.class));
}
}

57
spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationprocessor/NameAnnotationPropertiesTests.java Normal file
View File

@@ -0,0 +1,57 @@
/*
* Copyright 2012-2024 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.configurationprocessor;
import org.junit.jupiter.api.Test;
import org.springframework.boot.configurationprocessor.metadata.ConfigurationMetadata;
import org.springframework.boot.configurationprocessor.metadata.Metadata;
import org.springframework.boot.configurationsample.immutable.ConstructorParameterNameAnnotationProperties;
import org.springframework.boot.configurationsample.immutable.JavaBeanNameAnnotationProperties;
import org.springframework.boot.configurationsample.immutable.RecordComponentNameAnnotationProperties;
import static org.assertj.core.api.Assertions.assertThat;
/**
* Metadata generation tests for using {@code @Name}.
*
* @author Phillip Webb
*/
class NameAnnotationPropertiesTests extends AbstractMetadataGenerationTests {
@Test
void constructorParameterNameAnnotationProperties() {
ConfigurationMetadata metadata = compile(ConstructorParameterNameAnnotationProperties.class);
assertThat(metadata).has(Metadata.withProperty("named.import", String.class)
.fromSource(ConstructorParameterNameAnnotationProperties.class));
}
@Test
void recordComponentNameAnnotationProperties() {
ConfigurationMetadata metadata = compile(RecordComponentNameAnnotationProperties.class);
assertThat(metadata).has(Metadata.withProperty("named.import", String.class)
.fromSource(RecordComponentNameAnnotationProperties.class));
}
@Test
void javaBeanNameAnnotationProperties() {
ConfigurationMetadata metadata = compile(JavaBeanNameAnnotationProperties.class);
assertThat(metadata).has(
Metadata.withProperty("named.import", String.class).fromSource(JavaBeanNameAnnotationProperties.class));
}
}

20
spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationprocessor/PropertyDescriptorResolverTests.java
View File

@@ -31,11 +31,13 @@ import org.junit.jupiter.api.Test;
import org.springframework.boot.configurationprocessor.metadata.ItemMetadata;
import org.springframework.boot.configurationprocessor.test.RoundEnvironmentTester;
import org.springframework.boot.configurationprocessor.test.TestableAnnotationProcessor;
import org.springframework.boot.configurationsample.immutable.ConstructorParameterNameAnnotationProperties;
import org.springframework.boot.configurationsample.immutable.ImmutableClassConstructorBindingProperties;
import org.springframework.boot.configurationsample.immutable.ImmutableDeducedConstructorBindingProperties;
import org.springframework.boot.configurationsample.immutable.ImmutableMultiConstructorProperties;
import org.springframework.boot.configurationsample.immutable.ImmutableNameAnnotationProperties;
import org.springframework.boot.configurationsample.immutable.ImmutableSimpleProperties;
import org.springframework.boot.configurationsample.immutable.JavaBeanNameAnnotationProperties;
import org.springframework.boot.configurationsample.immutable.RecordComponentNameAnnotationProperties;
import org.springframework.boot.configurationsample.lombok.LombokExplicitProperties;
import org.springframework.boot.configurationsample.lombok.LombokSimpleDataProperties;
import org.springframework.boot.configurationsample.lombok.LombokSimpleProperties;
@@ -155,8 +157,20 @@ class PropertyDescriptorResolverTests {
}
@Test
void propertiesWithNameAnnotationParameter() {
process(ImmutableNameAnnotationProperties.class,
void contructorParameterPropertyWithNameAnnotationParameter() {
process(ConstructorParameterNameAnnotationProperties.class,
propertyNames((stream) -> assertThat(stream).containsExactly("import")));
}
@Test
void recordComponentPropertyWithNameAnnotationParameter() {
process(RecordComponentNameAnnotationProperties.class,
propertyNames((stream) -> assertThat(stream).containsExactly("import")));
}
@Test
void javaBeanPropertyWithNameAnnotationParameter() {
process(JavaBeanNameAnnotationProperties.class,
propertyNames((stream) -> assertThat(stream).containsExactly("import")));
}

4
spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/Name.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2012-2020 the original author or authors.
* Copyright 2012-2024 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.
@@ -28,7 +28,7 @@ import java.lang.annotation.Target;
*
* @author Phillip Webb
*/
@Target(ElementType.PARAMETER)
@Target({ ElementType.PARAMETER, ElementType.FIELD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Name {

8
spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/immutable/ImmutableNameAnnotationProperties.java → spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/immutable/ConstructorParameterNameAnnotationProperties.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2012-2022 the original author or authors.
* Copyright 2012-2024 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.
@@ -20,16 +20,16 @@ import org.springframework.boot.configurationsample.ConfigurationProperties;
import org.springframework.boot.configurationsample.Name;
/**
* Immutable properties making use of {@code @Name}.
* Immutable class properties making use of {@code @Name}.
*
* @author Phillip Webb
*/
@ConfigurationProperties("named")
public class ImmutableNameAnnotationProperties {
public class ConstructorParameterNameAnnotationProperties {
private final String imports;
public ImmutableNameAnnotationProperties(@Name("import") String imports) {
public ConstructorParameterNameAnnotationProperties(@Name("import") String imports) {
this.imports = imports;
}

41
spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/immutable/JavaBeanNameAnnotationProperties.java Normal file
View File

@@ -0,0 +1,41 @@
/*
* Copyright 2012-2024 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.configurationsample.immutable;
import org.springframework.boot.configurationsample.ConfigurationProperties;
import org.springframework.boot.configurationsample.Name;
/**
* Java bean properties making use of {@code @Name}.
*
* @author Andy Wilkinson
*/
@ConfigurationProperties("named")
public class JavaBeanNameAnnotationProperties {
@Name("import")
private String imports;
public String getImports() {
return this.imports;
}
public void setImports(String imports) {
this.imports = imports;
}
}

30
spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/immutable/RecordComponentNameAnnotationProperties.java Normal file
View File

@@ -0,0 +1,30 @@
/*
* Copyright 2012-2024 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.configurationsample.immutable;
import org.springframework.boot.configurationsample.ConfigurationProperties;
import org.springframework.boot.configurationsample.Name;
/**
* Immutable record properties making use of {@code @Name}.
*
* @author Andy Wilkinson
*/
@ConfigurationProperties("named")
public record RecordComponentNameAnnotationProperties(@Name("import") String imports) {
}

12
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/properties/bind/JavaBeanBinder.java
View File

@@ -46,6 +46,7 @@ import org.springframework.core.ResolvableType;
*
* @author Phillip Webb
* @author Madhura Bhave
* @author Lasse Wulff
*/
class JavaBeanBinder implements DataObjectBinder {
@@ -92,7 +93,7 @@ class JavaBeanBinder implements DataObjectBinder {
private <T> boolean bind(BeanSupplier<T> beanSupplier, DataObjectPropertyBinder propertyBinder,
BeanProperty property) {
String propertyName = property.getName();
String propertyName = determinePropertyName(property);
ResolvableType type = property.getType();
Supplier<Object> value = property.getValue(beanSupplier);
Annotation[] annotations = property.getAnnotations();
@@ -110,6 +111,15 @@ class JavaBeanBinder implements DataObjectBinder {
return true;
}
private String determinePropertyName(BeanProperty property) {
return Arrays.stream((property.getAnnotations() != null) ? property.getAnnotations() : new Annotation[0])
.filter((annotation) -> annotation.annotationType() == Name.class)
.findFirst()
.map(Name.class::cast)
.map(Name::value)
.orElse(property.getName());
}
/**
* The properties of a bean that may be bound.
*/

12
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/properties/bind/Name.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2012-2022 the original author or authors.
* Copyright 2012-2024 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.
@@ -23,15 +23,19 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Annotation that can be used to specify the name when binding to an immutable property.
* This annotation may be required when binding to names that clash with reserved language
* Annotation that can be used to specify the name when binding to a property. This
* annotation may be required when binding to names that clash with reserved language
* keywords.
* <p>
* When naming a JavaBean-based property, annotate the field. When naming a
* constructor-bound property, annotate the constructor parameter or record component.
*
* @author Phillip Webb
* @author Lasse Wulff
* @since 2.4.0
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.PARAMETER)
@Target({ ElementType.FIELD, ElementType.PARAMETER })
@Documented
public @interface Name {

26
spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/properties/bind/JavaBeanBinderTests.java
View File

@@ -52,6 +52,7 @@ import static org.assertj.core.api.Assertions.entry;
* @author Phillip Webb
* @author Madhura Bhave
* @author Andy Wilkinson
* @author Lasse Wulff
*/
class JavaBeanBinderTests {
@@ -74,6 +75,16 @@ class JavaBeanBinderTests {
assertThat(bean.getEnumValue()).isEqualTo(ExampleEnum.FOO_BAR);
}
@Test
void bindRenamedPropertyToClassBean() {
MockConfigurationPropertySource source = new MockConfigurationPropertySource();
source.put("renamed.public", "alpha");
this.sources.add(source);
ExampleRenamedPropertyBean bean = this.binder.bind("renamed", Bindable.of(ExampleRenamedPropertyBean.class))
.get();
assertThat(bean.getExampleProperty()).isEqualTo("alpha");
}
@Test
void bindToClassWhenHasNoPrefixShouldCreateBoundBean() {
MockConfigurationPropertySource source = new MockConfigurationPropertySource();
@@ -648,6 +659,21 @@ class JavaBeanBinderTests {
}
static class ExampleRenamedPropertyBean {
@Name("public")
private String exampleProperty;
String getExampleProperty() {
return this.exampleProperty;
}
void setExampleProperty(String exampleProperty) {
this.exampleProperty = exampleProperty;
}
}
static class ExampleDefaultsBean {
private int foo = 123;

21
spring-boot-project/spring-boot/src/test/kotlin/org/springframework/boot/context/properties/KotlinConfigurationPropertiesTests.kt
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2012-2023 the original author or authors.
* Copyright 2012-2024 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.
@@ -26,11 +26,13 @@ import org.springframework.context.annotation.Import
import org.springframework.test.context.support.TestPropertySourceUtils
import org.assertj.core.api.Assertions.assertThat
import org.springframework.boot.context.properties.bind.Name
/**
* Tests for {@link ConfigurationProperties @ConfigurationProperties}-annotated beans.
*
* @author Madhura Bhave
* @author Lasse Wulff
*/
class KotlinConfigurationPropertiesTests {
@@ -59,6 +61,14 @@ class KotlinConfigurationPropertiesTests {
assertThat(this.context.getBean(LateInitProperties::class.java).inner.value).isEqualTo("alpha")
}
@Test
fun `renamed property can be bound`() {
this.context.register(EnableRenamedProperties::class.java)
TestPropertySourceUtils.addInlinedPropertiesToEnvironment(this.context, "renamed.var=beta")
this.context.refresh()
assertThat(this.context.getBean(RenamedProperties::class.java).bar).isEqualTo("beta")
}
@Test
fun `type with constructor bound lateinit property with default can be bound`() {
this.context.register(EnableLateInitPropertiesWithDefault::class.java)
@@ -117,4 +127,13 @@ class KotlinConfigurationPropertiesTests {
var prop: String = ""
)
@EnableConfigurationProperties(RenamedProperties::class)
class EnableRenamedProperties
@ConfigurationProperties(prefix = "renamed")
class RenamedProperties{
@Name("var")
var bar: String = ""
}
}