Browse Source

Support constructor binding method-level `@NestedConfigurationProperty`

Update `spring-boot-configuration-processor` to support method-level
`@NestedConfigurationProperty` annotations when constructor binding
is being used.

Fixes gh-49734
pull/49790/head
Phillip Webb 1 week ago
parent
commit
d44683180d
  1. 3
      spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/main/java/org/springframework/boot/configurationprocessor/ConstructorParameterPropertyDescriptor.java
  2. 8
      spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationprocessor/ConfigurationMetadataAnnotationProcessorTests.java
  3. 37
      spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/method/NestedPropertiesMethodImmutable.java

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

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

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

@ -27,6 +27,7 @@ import org.springframework.boot.configurationprocessor.metadata.ItemMetadata; @@ -27,6 +27,7 @@ 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.method.NestedPropertiesMethodImmutable;
import org.springframework.boot.configurationsample.record.ExampleRecord;
import org.springframework.boot.configurationsample.record.NestedPropertiesRecord;
import org.springframework.boot.configurationsample.record.RecordWithGetter;
@ -394,6 +395,13 @@ class ConfigurationMetadataAnnotationProcessorTests extends AbstractMetadataGene @@ -394,6 +395,13 @@ class ConfigurationMetadataAnnotationProcessorTests extends AbstractMetadataGene
assertThat(metadata).has(Metadata.withProperty("method-nested.inner.nested.my-nested-property"));
}
@Test
void nestedClassMethodImmutable() {
ConfigurationMetadata metadata = compile(NestedPropertiesMethodImmutable.class);
assertThat(metadata).has(Metadata.withGroup("immutable-nested.nested"));
assertThat(metadata).has(Metadata.withProperty("immutable-nested.nested.my-nested-property"));
}
@Test
void nestedClassChildProperties() {
ConfigurationMetadata metadata = compile(ClassWithNestedProperties.class);

37
spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/method/NestedPropertiesMethodImmutable.java

@ -0,0 +1,37 @@ @@ -0,0 +1,37 @@
/*
* Copyright 2012-present 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.TestConfigurationProperties;
import org.springframework.boot.configurationsample.TestNestedConfigurationProperty;
@TestConfigurationProperties("immutable-nested")
public class NestedPropertiesMethodImmutable {
private final NestedProperty nested;
NestedPropertiesMethodImmutable(NestedProperty nested) {
this.nested = nested;
}
@TestNestedConfigurationProperty
public NestedProperty getNested() {
return this.nested;
}
}
Loading…
Cancel
Save