Commit b3643965 authored by Stephane Nicoll's avatar Stephane Nicoll

Polish "Detect config props using builder pattern and generics"

See gh-19099
parent 743f4a4c
...@@ -28,10 +28,8 @@ import javax.lang.model.element.ExecutableElement; ...@@ -28,10 +28,8 @@ import javax.lang.model.element.ExecutableElement;
import javax.lang.model.element.Modifier; import javax.lang.model.element.Modifier;
import javax.lang.model.element.TypeElement; import javax.lang.model.element.TypeElement;
import javax.lang.model.element.VariableElement; import javax.lang.model.element.VariableElement;
import javax.lang.model.type.DeclaredType;
import javax.lang.model.type.TypeKind; import javax.lang.model.type.TypeKind;
import javax.lang.model.type.TypeMirror; import javax.lang.model.type.TypeMirror;
import javax.lang.model.type.TypeVariable;
import javax.lang.model.util.ElementFilter; import javax.lang.model.util.ElementFilter;
/** /**
...@@ -46,15 +44,18 @@ class TypeElementMembers { ...@@ -46,15 +44,18 @@ class TypeElementMembers {
private final MetadataGenerationEnvironment env; private final MetadataGenerationEnvironment env;
private final TypeElement targetType;
private final Map<String, VariableElement> fields = new LinkedHashMap<>(); private final Map<String, VariableElement> fields = new LinkedHashMap<>();
private final Map<String, ExecutableElement> publicGetters = new LinkedHashMap<>(); private final Map<String, ExecutableElement> publicGetters = new LinkedHashMap<>();
private final Map<String, List<ExecutableElement>> publicSetters = new LinkedHashMap<>(); private final Map<String, List<ExecutableElement>> publicSetters = new LinkedHashMap<>();
TypeElementMembers(MetadataGenerationEnvironment env, TypeElement element) { TypeElementMembers(MetadataGenerationEnvironment env, TypeElement targetType) {
this.env = env; this.env = env;
process(element); this.targetType = targetType;
process(targetType);
} }
private void process(TypeElement element) { private void process(TypeElement element) {
...@@ -118,26 +119,19 @@ class TypeElementMembers { ...@@ -118,26 +119,19 @@ class TypeElementMembers {
private boolean isSetterReturnType(ExecutableElement method) { private boolean isSetterReturnType(ExecutableElement method) {
TypeMirror returnType = method.getReturnType(); TypeMirror returnType = method.getReturnType();
// void
if (TypeKind.VOID == returnType.getKind()) { if (TypeKind.VOID == returnType.getKind()) {
return true; return true;
} }
if (TypeKind.DECLARED == returnType.getKind()
TypeMirror classType = method.getEnclosingElement().asType(); && this.env.getTypeUtils().isSameType(method.getEnclosingElement().asType(), returnType)) {
TypeUtils typeUtils = this.env.getTypeUtils();
// Chain
if (typeUtils.isSameType(classType, returnType)) {
return true; return true;
} }
if (TypeKind.TYPEVAR == returnType.getKind()) {
// Chain generic type, <T extends classType> String resolvedType = this.env.getTypeUtils().getType(this.targetType, returnType);
List<? extends TypeMirror> genericTypes = ((DeclaredType) classType).getTypeArguments(); return (resolvedType != null
return genericTypes.stream().anyMatch((genericType) -> { && resolvedType.equals(this.env.getTypeUtils().getQualifiedName(this.targetType)));
TypeMirror upperBound = ((TypeVariable) genericType).getUpperBound(); }
String classTypeName = typeUtils.getQualifiedName(((DeclaredType) classType).asElement()); return false;
String genericTypeName = typeUtils.getQualifiedName(((DeclaredType) upperBound).asElement());
return classTypeName.equals(genericTypeName);
});
} }
private String getAccessorName(String methodName) { private String getAccessorName(String methodName) {
......
...@@ -21,9 +21,8 @@ import org.junit.jupiter.api.Test; ...@@ -21,9 +21,8 @@ import org.junit.jupiter.api.Test;
import org.springframework.boot.configurationprocessor.metadata.ConfigurationMetadata; import org.springframework.boot.configurationprocessor.metadata.ConfigurationMetadata;
import org.springframework.boot.configurationprocessor.metadata.Metadata; import org.springframework.boot.configurationprocessor.metadata.Metadata;
import org.springframework.boot.configurationsample.generic.AbstractGenericProperties; import org.springframework.boot.configurationsample.generic.AbstractGenericProperties;
import org.springframework.boot.configurationsample.generic.ChainGenericConfig;
import org.springframework.boot.configurationsample.generic.ChainGenericProperties;
import org.springframework.boot.configurationsample.generic.ComplexGenericProperties; import org.springframework.boot.configurationsample.generic.ComplexGenericProperties;
import org.springframework.boot.configurationsample.generic.ConcreteBuilderProperties;
import org.springframework.boot.configurationsample.generic.GenericConfig; import org.springframework.boot.configurationsample.generic.GenericConfig;
import org.springframework.boot.configurationsample.generic.SimpleGenericProperties; import org.springframework.boot.configurationsample.generic.SimpleGenericProperties;
import org.springframework.boot.configurationsample.generic.UnresolvedGenericProperties; import org.springframework.boot.configurationsample.generic.UnresolvedGenericProperties;
...@@ -113,13 +112,13 @@ class GenericsMetadataGenerationTests extends AbstractMetadataGenerationTests { ...@@ -113,13 +112,13 @@ class GenericsMetadataGenerationTests extends AbstractMetadataGenerationTests {
} }
@Test @Test
void chainGenericProperties() { void builderPatternWithGenericReturnType() {
ConfigurationMetadata metadata = compile(ChainGenericProperties.class); ConfigurationMetadata metadata = compile(ConcreteBuilderProperties.class);
assertThat(metadata).has(Metadata.withGroup("generic").fromSource(ChainGenericProperties.class)); assertThat(metadata).has(Metadata.withGroup("builder").fromSource(ConcreteBuilderProperties.class));
assertThat(metadata).has(Metadata.withGroup("generic.config", ChainGenericConfig.class) assertThat(metadata).has(
.fromSource(ChainGenericProperties.class)); Metadata.withProperty("builder.number", Integer.class).fromSource(ConcreteBuilderProperties.class));
assertThat(metadata).has(Metadata.withProperty("generic.config.ping-timeout", Integer.class) assertThat(metadata).has(
.fromSource(ChainGenericConfig.class).withDefaultValue(null)); Metadata.withProperty("builder.description", String.class).fromSource(ConcreteBuilderProperties.class));
assertThat(metadata.getItems()).hasSize(3); assertThat(metadata.getItems()).hasSize(3);
} }
......
...@@ -17,28 +17,24 @@ ...@@ -17,28 +17,24 @@
package org.springframework.boot.configurationsample.generic; package org.springframework.boot.configurationsample.generic;
import org.springframework.boot.configurationsample.ConfigurationProperties; import org.springframework.boot.configurationsample.ConfigurationProperties;
import org.springframework.boot.configurationsample.NestedConfigurationProperty;
/** /**
* Chain Generic Properties * Builder pattern with a resolved generic
* *
* @author L.cm * @author Stephane Nicoll
*/ */
@ConfigurationProperties("generic") @ConfigurationProperties("builder")
public class ChainGenericProperties { public class ConcreteBuilderProperties extends GenericBuilderProperties<ConcreteBuilderProperties> {
/** private String description;
* Generic config.
*/
@NestedConfigurationProperty
private ChainGenericConfig config;
public ChainGenericConfig getConfig() { public String getDescription() {
return this.config; return this.description;
} }
public void setConfig(ChainGenericConfig config) { public ConcreteBuilderProperties setDescription(String description) {
this.config = config; this.description = description;
return this;
} }
} }
...@@ -17,24 +17,21 @@ ...@@ -17,24 +17,21 @@
package org.springframework.boot.configurationsample.generic; package org.springframework.boot.configurationsample.generic;
/** /**
* Chain Generic * A configuration properties that uses the builder pattern with a generic.
* *
* @param <T> name type * @param <T> the type of the return type
* @author L.cm * @author Stephane Nicoll
*/ */
public class ChainGenericConfig<T extends ChainGenericConfig> { public class GenericBuilderProperties<T extends GenericBuilderProperties<T>> {
/** private int number;
* Generic config pingTimeout.
*/
private Integer pingTimeout = 1000;
public int getPingTimeout() { public int getNumber() {
return this.pingTimeout; return this.number;
} }
public T setPingTimeout(int pingTimeout) { public T setNumber(int number) {
this.pingTimeout = pingTimeout; this.number = number;
return (T) this; return (T) this;
} }
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment