From 743f4a4cb1e65629a5a1b87beec6f83de7e98de0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=A6=82=E6=A2=A6=E6=8A=80=E6=9C=AF?= <596392912@qq.com> Date: Fri, 22 Nov 2019 18:06:31 +0800 Subject: [PATCH 1/2] Detect config props using builder pattern and generics See gh-19099 --- .../TypeElementMembers.java | 24 +++++++++- .../GenericsMetadataGenerationTests.java | 13 ++++++ .../generic/ChainGenericConfig.java | 41 +++++++++++++++++ .../generic/ChainGenericProperties.java | 44 +++++++++++++++++++ 4 files changed, 120 insertions(+), 2 deletions(-) create mode 100644 spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/generic/ChainGenericConfig.java create mode 100644 spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/generic/ChainGenericProperties.java diff --git a/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/main/java/org/springframework/boot/configurationprocessor/TypeElementMembers.java b/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/main/java/org/springframework/boot/configurationprocessor/TypeElementMembers.java index 75be606b3b..9a317e6314 100644 --- a/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/main/java/org/springframework/boot/configurationprocessor/TypeElementMembers.java +++ b/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/main/java/org/springframework/boot/configurationprocessor/TypeElementMembers.java @@ -28,8 +28,10 @@ import javax.lang.model.element.ExecutableElement; import javax.lang.model.element.Modifier; import javax.lang.model.element.TypeElement; import javax.lang.model.element.VariableElement; +import javax.lang.model.type.DeclaredType; import javax.lang.model.type.TypeKind; import javax.lang.model.type.TypeMirror; +import javax.lang.model.type.TypeVariable; import javax.lang.model.util.ElementFilter; /** @@ -116,8 +118,26 @@ class TypeElementMembers { private boolean isSetterReturnType(ExecutableElement method) { TypeMirror returnType = method.getReturnType(); - return (TypeKind.VOID == returnType.getKind() - || this.env.getTypeUtils().isSameType(method.getEnclosingElement().asType(), returnType)); + // void + if (TypeKind.VOID == returnType.getKind()) { + return true; + } + + TypeMirror classType = method.getEnclosingElement().asType(); + TypeUtils typeUtils = this.env.getTypeUtils(); + // Chain + if (typeUtils.isSameType(classType, returnType)) { + return true; + } + + // Chain generic type, + List genericTypes = ((DeclaredType) classType).getTypeArguments(); + return genericTypes.stream().anyMatch((genericType) -> { + TypeMirror upperBound = ((TypeVariable) genericType).getUpperBound(); + String classTypeName = typeUtils.getQualifiedName(((DeclaredType) classType).asElement()); + String genericTypeName = typeUtils.getQualifiedName(((DeclaredType) upperBound).asElement()); + return classTypeName.equals(genericTypeName); + }); } private String getAccessorName(String methodName) { diff --git a/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationprocessor/GenericsMetadataGenerationTests.java b/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationprocessor/GenericsMetadataGenerationTests.java index 0643c22cc0..8b6085d3b6 100644 --- a/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationprocessor/GenericsMetadataGenerationTests.java +++ b/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationprocessor/GenericsMetadataGenerationTests.java @@ -21,6 +21,8 @@ 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.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.GenericConfig; import org.springframework.boot.configurationsample.generic.SimpleGenericProperties; @@ -110,4 +112,15 @@ class GenericsMetadataGenerationTests extends AbstractMetadataGenerationTests { assertThat(metadata.getItems()).hasSize(3); } + @Test + void chainGenericProperties() { + ConfigurationMetadata metadata = compile(ChainGenericProperties.class); + assertThat(metadata).has(Metadata.withGroup("generic").fromSource(ChainGenericProperties.class)); + assertThat(metadata).has(Metadata.withGroup("generic.config", ChainGenericConfig.class) + .fromSource(ChainGenericProperties.class)); + assertThat(metadata).has(Metadata.withProperty("generic.config.ping-timeout", Integer.class) + .fromSource(ChainGenericConfig.class).withDefaultValue(null)); + assertThat(metadata.getItems()).hasSize(3); + } + } diff --git a/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/generic/ChainGenericConfig.java b/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/generic/ChainGenericConfig.java new file mode 100644 index 0000000000..4864b77dce --- /dev/null +++ b/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/generic/ChainGenericConfig.java @@ -0,0 +1,41 @@ +/* + * Copyright 2012-2019 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.generic; + +/** + * Chain Generic + * + * @param name type + * @author L.cm + */ +public class ChainGenericConfig { + + /** + * Generic config pingTimeout. + */ + private Integer pingTimeout = 1000; + + public int getPingTimeout() { + return this.pingTimeout; + } + + public T setPingTimeout(int pingTimeout) { + this.pingTimeout = pingTimeout; + return (T) this; + } + +} diff --git a/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/generic/ChainGenericProperties.java b/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/generic/ChainGenericProperties.java new file mode 100644 index 0000000000..0006fdf219 --- /dev/null +++ b/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/generic/ChainGenericProperties.java @@ -0,0 +1,44 @@ +/* + * Copyright 2012-2019 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.generic; + +import org.springframework.boot.configurationsample.ConfigurationProperties; +import org.springframework.boot.configurationsample.NestedConfigurationProperty; + +/** + * Chain Generic Properties + * + * @author L.cm + */ +@ConfigurationProperties("generic") +public class ChainGenericProperties { + + /** + * Generic config. + */ + @NestedConfigurationProperty + private ChainGenericConfig config; + + public ChainGenericConfig getConfig() { + return this.config; + } + + public void setConfig(ChainGenericConfig config) { + this.config = config; + } + +} From b3643965f00d306a84abc09b3c269abc6ef6fd11 Mon Sep 17 00:00:00 2001 From: Stephane Nicoll Date: Mon, 23 Dec 2019 14:50:13 +0100 Subject: [PATCH 2/2] Polish "Detect config props using builder pattern and generics" See gh-19099 --- .../TypeElementMembers.java | 32 ++++++++----------- .../GenericsMetadataGenerationTests.java | 17 +++++----- ...es.java => ConcreteBuilderProperties.java} | 24 ++++++-------- ...fig.java => GenericBuilderProperties.java} | 21 ++++++------ 4 files changed, 40 insertions(+), 54 deletions(-) rename spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/generic/{ChainGenericProperties.java => ConcreteBuilderProperties.java} (64%) rename spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/generic/{ChainGenericConfig.java => GenericBuilderProperties.java} (67%) diff --git a/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/main/java/org/springframework/boot/configurationprocessor/TypeElementMembers.java b/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/main/java/org/springframework/boot/configurationprocessor/TypeElementMembers.java index 9a317e6314..4f683d5fba 100644 --- a/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/main/java/org/springframework/boot/configurationprocessor/TypeElementMembers.java +++ b/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/main/java/org/springframework/boot/configurationprocessor/TypeElementMembers.java @@ -28,10 +28,8 @@ import javax.lang.model.element.ExecutableElement; import javax.lang.model.element.Modifier; import javax.lang.model.element.TypeElement; import javax.lang.model.element.VariableElement; -import javax.lang.model.type.DeclaredType; import javax.lang.model.type.TypeKind; import javax.lang.model.type.TypeMirror; -import javax.lang.model.type.TypeVariable; import javax.lang.model.util.ElementFilter; /** @@ -46,15 +44,18 @@ class TypeElementMembers { private final MetadataGenerationEnvironment env; + private final TypeElement targetType; + private final Map fields = new LinkedHashMap<>(); private final Map publicGetters = new LinkedHashMap<>(); private final Map> publicSetters = new LinkedHashMap<>(); - TypeElementMembers(MetadataGenerationEnvironment env, TypeElement element) { + TypeElementMembers(MetadataGenerationEnvironment env, TypeElement targetType) { this.env = env; - process(element); + this.targetType = targetType; + process(targetType); } private void process(TypeElement element) { @@ -118,26 +119,19 @@ class TypeElementMembers { private boolean isSetterReturnType(ExecutableElement method) { TypeMirror returnType = method.getReturnType(); - // void if (TypeKind.VOID == returnType.getKind()) { return true; } - - TypeMirror classType = method.getEnclosingElement().asType(); - TypeUtils typeUtils = this.env.getTypeUtils(); - // Chain - if (typeUtils.isSameType(classType, returnType)) { + if (TypeKind.DECLARED == returnType.getKind() + && this.env.getTypeUtils().isSameType(method.getEnclosingElement().asType(), returnType)) { return true; } - - // Chain generic type, - List genericTypes = ((DeclaredType) classType).getTypeArguments(); - return genericTypes.stream().anyMatch((genericType) -> { - TypeMirror upperBound = ((TypeVariable) genericType).getUpperBound(); - String classTypeName = typeUtils.getQualifiedName(((DeclaredType) classType).asElement()); - String genericTypeName = typeUtils.getQualifiedName(((DeclaredType) upperBound).asElement()); - return classTypeName.equals(genericTypeName); - }); + if (TypeKind.TYPEVAR == returnType.getKind()) { + String resolvedType = this.env.getTypeUtils().getType(this.targetType, returnType); + return (resolvedType != null + && resolvedType.equals(this.env.getTypeUtils().getQualifiedName(this.targetType))); + } + return false; } private String getAccessorName(String methodName) { diff --git a/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationprocessor/GenericsMetadataGenerationTests.java b/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationprocessor/GenericsMetadataGenerationTests.java index 8b6085d3b6..575ea90cc1 100644 --- a/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationprocessor/GenericsMetadataGenerationTests.java +++ b/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationprocessor/GenericsMetadataGenerationTests.java @@ -21,9 +21,8 @@ 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.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.ConcreteBuilderProperties; import org.springframework.boot.configurationsample.generic.GenericConfig; import org.springframework.boot.configurationsample.generic.SimpleGenericProperties; import org.springframework.boot.configurationsample.generic.UnresolvedGenericProperties; @@ -113,13 +112,13 @@ class GenericsMetadataGenerationTests extends AbstractMetadataGenerationTests { } @Test - void chainGenericProperties() { - ConfigurationMetadata metadata = compile(ChainGenericProperties.class); - assertThat(metadata).has(Metadata.withGroup("generic").fromSource(ChainGenericProperties.class)); - assertThat(metadata).has(Metadata.withGroup("generic.config", ChainGenericConfig.class) - .fromSource(ChainGenericProperties.class)); - assertThat(metadata).has(Metadata.withProperty("generic.config.ping-timeout", Integer.class) - .fromSource(ChainGenericConfig.class).withDefaultValue(null)); + void builderPatternWithGenericReturnType() { + ConfigurationMetadata metadata = compile(ConcreteBuilderProperties.class); + assertThat(metadata).has(Metadata.withGroup("builder").fromSource(ConcreteBuilderProperties.class)); + assertThat(metadata).has( + Metadata.withProperty("builder.number", Integer.class).fromSource(ConcreteBuilderProperties.class)); + assertThat(metadata).has( + Metadata.withProperty("builder.description", String.class).fromSource(ConcreteBuilderProperties.class)); assertThat(metadata.getItems()).hasSize(3); } diff --git a/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/generic/ChainGenericProperties.java b/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/generic/ConcreteBuilderProperties.java similarity index 64% rename from spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/generic/ChainGenericProperties.java rename to spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/generic/ConcreteBuilderProperties.java index 0006fdf219..94e78ee0b1 100644 --- a/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/generic/ChainGenericProperties.java +++ b/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/generic/ConcreteBuilderProperties.java @@ -17,28 +17,24 @@ package org.springframework.boot.configurationsample.generic; 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") -public class ChainGenericProperties { +@ConfigurationProperties("builder") +public class ConcreteBuilderProperties extends GenericBuilderProperties { - /** - * Generic config. - */ - @NestedConfigurationProperty - private ChainGenericConfig config; + private String description; - public ChainGenericConfig getConfig() { - return this.config; + public String getDescription() { + return this.description; } - public void setConfig(ChainGenericConfig config) { - this.config = config; + public ConcreteBuilderProperties setDescription(String description) { + this.description = description; + return this; } } diff --git a/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/generic/ChainGenericConfig.java b/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/generic/GenericBuilderProperties.java similarity index 67% rename from spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/generic/ChainGenericConfig.java rename to spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/generic/GenericBuilderProperties.java index 4864b77dce..bb8db7e3c5 100644 --- a/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/generic/ChainGenericConfig.java +++ b/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/generic/GenericBuilderProperties.java @@ -17,24 +17,21 @@ package org.springframework.boot.configurationsample.generic; /** - * Chain Generic + * A configuration properties that uses the builder pattern with a generic. * - * @param name type - * @author L.cm + * @param the type of the return type + * @author Stephane Nicoll */ -public class ChainGenericConfig { +public class GenericBuilderProperties> { - /** - * Generic config pingTimeout. - */ - private Integer pingTimeout = 1000; + private int number; - public int getPingTimeout() { - return this.pingTimeout; + public int getNumber() { + return this.number; } - public T setPingTimeout(int pingTimeout) { - this.pingTimeout = pingTimeout; + public T setNumber(int number) { + this.number = number; return (T) this; }