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

Merge pull request #38844 from jaredtbates

Browse Source 
* pr/38844:
  Polish "Allow NestedConfigurationProperty on getters"
  Allow NestedConfigurationProperty on getters

Closes gh-38844
This commit is contained in:
Stéphane Nicoll
2024-07-15 10:15:02 +02:00
parent 5d4a777d27 4415b4ab1c
commit 2da38753f9
10 changed files with 210 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/packaging/native-image/advanced-topics.adoc
View File

@@ -17,6 +17,7 @@ include-code::Nested[]
The example above produces configuration properties for `my.properties.name` and `my.properties.nested.number`.
Without the `@NestedConfigurationProperty` annotation on the `nested` field, the `my.properties.nested.number` property would not be bindable in a native image.
You can also annotate the getter method.
When using constructor binding, you have to annotate the field with `@NestedConfigurationProperty`:

2
spring-boot-project/spring-boot-docs/src/docs/antora/modules/specification/pages/configuration-metadata/annotation-processor.adoc
View File

@@ -130,7 +130,7 @@ Consider the updated example:
include-code::MyServerProperties[]
The preceding example produces metadata information for `my.server.name`, `my.server.host.ip`, and `my.server.host.port` properties.
You can use the `@NestedConfigurationProperty` annotation on a field to indicate that a regular (non-inner) class should be treated as if it were nested.
You can use the `@NestedConfigurationProperty` annotation on a field or a getter method to indicate that a regular (non-inner) class should be treated as if it were nested.
TIP: This has no effect on collections and maps, as those types are automatically identified, and a single metadata property is generated for each of them.

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

@@ -53,7 +53,8 @@ class JavaBeanPropertyDescriptor extends PropertyDescriptor {
@Override
protected boolean isMarkedAsNested(MetadataGenerationEnvironment environment) {
return environment.getNestedConfigurationPropertyAnnotation(this.field) != null;
return environment.getNestedConfigurationPropertyAnnotation(this.field) != null
|| environment.getNestedConfigurationPropertyAnnotation(getGetter()) != null;
}
@Override

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

@@ -22,6 +22,7 @@ import org.springframework.boot.configurationprocessor.metadata.ConfigurationMet
import org.springframework.boot.configurationprocessor.metadata.ItemMetadata;
import org.springframework.boot.configurationprocessor.metadata.Metadata;
import org.springframework.boot.configurationsample.deprecation.Dbcp2Configuration;
import org.springframework.boot.configurationsample.method.NestedPropertiesMethod;
import org.springframework.boot.configurationsample.record.ExampleRecord;
import org.springframework.boot.configurationsample.record.NestedPropertiesRecord;
import org.springframework.boot.configurationsample.record.RecordWithGetter;
@@ -45,6 +46,7 @@ import org.springframework.boot.configurationsample.specific.AnnotatedGetter;
import org.springframework.boot.configurationsample.specific.BoxingPojo;
import org.springframework.boot.configurationsample.specific.BuilderPojo;
import org.springframework.boot.configurationsample.specific.DeprecatedLessPreciseTypePojo;
import org.springframework.boot.configurationsample.specific.DeprecatedSimplePojo;
import org.springframework.boot.configurationsample.specific.DeprecatedUnrelatedMethodPojo;
import org.springframework.boot.configurationsample.specific.DoubleRegistrationProperties;
import org.springframework.boot.configurationsample.specific.EmptyDefaultValueProperties;
@@ -336,6 +338,10 @@ class ConfigurationMetadataAnnotationProcessorTests extends AbstractMetadataGene
assertThat(metadata).has(Metadata.withProperty("config.third.value"));
assertThat(metadata).has(Metadata.withProperty("config.fourth"));
assertThat(metadata).isNotEqualTo(Metadata.withGroup("config.fourth"));
assertThat(metadata).has(Metadata.withGroup("config.fifth")
.ofType(DeprecatedSimplePojo.class)
.fromSource(InnerClassProperties.class));
assertThat(metadata).has(Metadata.withProperty("config.fifth.value").withDeprecation());
}
@Test
@@ -358,6 +364,15 @@ class ConfigurationMetadataAnnotationProcessorTests extends AbstractMetadataGene
assertThat(metadata).isNotEqualTo(Metadata.withProperty("specific.foo"));
}
@Test
void nestedClassMethod() {
ConfigurationMetadata metadata = compile(NestedPropertiesMethod.class);
assertThat(metadata).has(Metadata.withGroup("method-nested.nested"));
assertThat(metadata).has(Metadata.withProperty("method-nested.nested.my-nested-property"));
assertThat(metadata).has(Metadata.withGroup("method-nested.inner.nested"));
assertThat(metadata).has(Metadata.withProperty("method-nested.inner.nested.my-nested-property"));
}
@Test
void nestedClassChildProperties() {
ConfigurationMetadata metadata = compile(ClassWithNestedProperties.class);

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

@@ -1,5 +1,5 @@
/*
* Copyright 2012-2019 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.
@@ -30,7 +30,7 @@ import java.lang.annotation.Target;
* @author Phillip Webb
* @since 1.2.0
*/
@Target({ ElementType.FIELD, ElementType.RECORD_COMPONENT })
@Target({ ElementType.FIELD, ElementType.RECORD_COMPONENT, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface NestedConfigurationProperty {

69
spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/method/NestedPropertiesMethod.java Normal file
View File

@@ -0,0 +1,69 @@
/*
* 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.method;
import org.springframework.boot.configurationsample.ConfigurationProperties;
import org.springframework.boot.configurationsample.NestedConfigurationProperty;
@ConfigurationProperties("method-nested")
public class NestedPropertiesMethod {
private String myProperty;
private final NestedProperty nested = new NestedProperty();
private final Inner inner = new Inner();
public String getMyProperty() {
return this.myProperty;
}
public void setMyProperty(String myProperty) {
this.myProperty = myProperty;
}
@NestedConfigurationProperty
public NestedProperty getNested() {
return this.nested;
}
public Inner getInner() {
return this.inner;
}
public static class Inner {
private String myInnerProperty;
private final NestedProperty nested = new NestedProperty();
public String getMyInnerProperty() {
return this.myInnerProperty;
}
public void setMyInnerProperty(String myInnerProperty) {
this.myInnerProperty = myInnerProperty;
}
@NestedConfigurationProperty
public NestedProperty getNested() {
return this.nested;
}
}
}

31
spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/method/NestedProperty.java Normal file
View File

@@ -0,0 +1,31 @@
/*
* 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.method;
public class NestedProperty {
private String myNestedProperty;
public String getMyNestedProperty() {
return this.myNestedProperty;
}
public void setMyNestedProperty(String myNestedProperty) {
this.myNestedProperty = myNestedProperty;
}
}

37
spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/specific/DeprecatedSimplePojo.java Normal file
View File

@@ -0,0 +1,37 @@
/*
* 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.specific;
/**
* POJO for use with samples needing a deprecated value.
*
* @author Jared Bates
*/
public class DeprecatedSimplePojo {
private int value;
@Deprecated
public int getValue() {
return this.value;
}
public void setValue(int value) {
this.value = value;
}
}

9
spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/specific/InnerClassProperties.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2012-2019 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.
@@ -36,6 +36,8 @@ public class InnerClassProperties {
private Fourth fourth;
private final DeprecatedSimplePojo fifth = new DeprecatedSimplePojo();
public Foo getFirst() {
return this.first;
}
@@ -60,6 +62,11 @@ public class InnerClassProperties {
this.fourth = fourth;
}
@NestedConfigurationProperty
public DeprecatedSimplePojo getFifth() {
return this.fifth;
}
public static class Foo {
private String name;

50
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/properties/NestedConfigurationProperty.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.
@@ -25,20 +25,58 @@ import java.lang.annotation.Target;
import org.springframework.boot.context.properties.bind.Nested;
/**
* Indicates that a field in a {@link ConfigurationProperties @ConfigurationProperties}
* Indicates that a property in a {@link ConfigurationProperties @ConfigurationProperties}
* object should be treated as if it were a nested type. This annotation has no bearing on
* the actual binding processes, but it is used by the
* {@code spring-boot-configuration-processor} as a hint that a field is not bound as a
* single value. When this is specified, a nested group is created for the field and its
* type is harvested.
* {@code spring-boot-configuration-processor} as a hint that a property is not bound as a
* single value. When this is specified, a nested group is created for the property and
* its type is harvested.
* <p>
* In the example below, {@code Host} is flagged as a nested property using its field and
* an {@code example.server.host} nested group is created with any property that
* {@code Host} defines:<pre><code class="java">
* &#064;ConfigurationProperties("example.server")
* class ServerProperties {
*
* &#064;NestedConfigurationProperty
* private final Host host = new Host();
*
* public Host getHost() { ... }
*
* // Other properties, getter, setter.
*
* }</code></pre>
* <p>
* The annotation can also be specified on a getter method. If you use records, you can
* annotate the record component.
* <p>
* This has no effect on collections and maps as these types are automatically identified.
* Also, the annotation is not necessary if the target type is an inner class of the
* {@link ConfigurationProperties @ConfigurationProperties} object. In the example below,
* {@code Host} is detected as a nested type as it is defined as an inner class:
* <pre><code class="java">
* &#064;ConfigurationProperties("example.server")
* class ServerProperties {
*
* private final Host host = new Host();
*
* public Host getHost() { ... }
*
* // Other properties, getter, setter.
*
* public static class Host {
*
* // properties, getter, setter.
*
* }
*
* }</code></pre>
*
* @author Stephane Nicoll
* @author Phillip Webb
* @since 1.2.0
*/
@Target({ ElementType.FIELD, ElementType.RECORD_COMPONENT })
@Target({ ElementType.FIELD, ElementType.RECORD_COMPONENT, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Nested