Fix type detection with annotated getter

This commit makes sure that the `type` of a property is generated
property if the getter of the property is annotated. Previously, a type
implementation may expose the annotation information.

Closes gh-11512
pull/11790/head
Stephane Nicoll 7 years ago
parent 6c191e149d
commit d8b1f1692a

@ -21,6 +21,7 @@
<java.version>1.8</java.version> <java.version>1.8</java.version>
</properties> </properties>
<modules> <modules>
<module>spring-boot-configuration-processor-tests</module>
<module>spring-boot-devtools-tests</module> <module>spring-boot-devtools-tests</module>
<module>spring-boot-integration-tests-embedded-servlet-container</module> <module>spring-boot-integration-tests-embedded-servlet-container</module>
<module>spring-boot-gradle-tests</module> <module>spring-boot-gradle-tests</module>

@ -0,0 +1,49 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-integration-tests</artifactId>
<version>1.5.10.BUILD-SNAPSHOT</version>
</parent>
<artifactId>spring-boot-configuration-processor-tests</artifactId>
<name>Spring Boot Configuration Processor Tests</name>
<description>${project.name}</description>
<url>http://projects.spring.io/spring-boot/</url>
<organization>
<name>Pivotal Software, Inc.</name>
<url>http://www.spring.io</url>
</organization>
<properties>
<main.basedir>${basedir}/../..</main.basedir>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-metadata</artifactId>
</dependency>
<dependency>
<groupId>javax.validation</groupId>
<artifactId>validation-api</artifactId>
<!-- this override is required to reproduce an issue -->
<version>2.0.1.Final</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
</project>

@ -0,0 +1,45 @@
/*
* Copyright 2012-2018 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
*
* http://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 com.example;
import javax.validation.Valid;
import org.springframework.boot.context.properties.ConfigurationProperties;
/**
* Test that a valid type is generated if an annotation is present.
*
* @author Stephane Nicoll
*/
@ConfigurationProperties("annotated")
public class AnnotatedSample {
/**
* A valid name.
*/
private String name;
@Valid
public String getName() {
return this.name;
}
public void setName(String name) {
this.name = name;
}
}

@ -0,0 +1,62 @@
/*
* Copyright 2012-2018 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
*
* http://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.tests;
import java.io.IOException;
import org.junit.BeforeClass;
import org.junit.Test;
import org.springframework.boot.configurationmetadata.ConfigurationMetadataProperty;
import org.springframework.boot.configurationmetadata.ConfigurationMetadataRepository;
import org.springframework.boot.configurationmetadata.ConfigurationMetadataRepositoryJsonBuilder;
import org.springframework.core.io.ClassPathResource;
import org.springframework.core.io.Resource;
import static org.assertj.core.api.Assertions.assertThat;
/**
* Integration tests for the configuration metadata annotation processor.
*
* @author Stephane Nicoll
*/
public class ConfigurationProcessorIntegrationTests {
private static ConfigurationMetadataRepository repository;
@BeforeClass
public static void readMetadata() throws IOException {
Resource resource = new ClassPathResource(
"META-INF/spring-configuration-metadata.json");
assertThat(resource.exists()).isTrue();
// Make sure the right file is detected
assertThat(resource.getURL().toString()).contains(
"spring-boot-configuration-processor-tests");
repository = ConfigurationMetadataRepositoryJsonBuilder
.create(resource.getInputStream()).build();
}
@Test
public void extractTypeFromAnnotatedGetter() {
ConfigurationMetadataProperty property = repository.getAllProperties().get(
"annotated.name");
assertThat(property).isNotNull();
assertThat(property.getType()).isEqualTo("java.lang.String");
}
}

@ -25,8 +25,10 @@ import javax.annotation.processing.ProcessingEnvironment;
import javax.lang.model.element.Element; import javax.lang.model.element.Element;
import javax.lang.model.element.TypeElement; import javax.lang.model.element.TypeElement;
import javax.lang.model.type.DeclaredType; import javax.lang.model.type.DeclaredType;
import javax.lang.model.type.PrimitiveType;
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.util.SimpleTypeVisitor6;
import javax.lang.model.util.Types; import javax.lang.model.util.Types;
/** /**
@ -65,6 +67,8 @@ class TypeUtils {
private final ProcessingEnvironment env; private final ProcessingEnvironment env;
private final TypeExtractor typeExtractor;
private final TypeMirror collectionType; private final TypeMirror collectionType;
private final TypeMirror mapType; private final TypeMirror mapType;
@ -72,6 +76,7 @@ class TypeUtils {
TypeUtils(ProcessingEnvironment env) { TypeUtils(ProcessingEnvironment env) {
this.env = env; this.env = env;
Types types = env.getTypeUtils(); Types types = env.getTypeUtils();
this.typeExtractor = new TypeExtractor(types);
this.collectionType = getDeclaredType(types, Collection.class, 1); this.collectionType = getDeclaredType(types, Collection.class, 1);
this.mapType = getDeclaredType(types, Map.class, 2); this.mapType = getDeclaredType(types, Map.class, 2);
} }
@ -100,20 +105,7 @@ class TypeUtils {
* {@link Class#forName(String)} * {@link Class#forName(String)}
*/ */
public String getQualifiedName(Element element) { public String getQualifiedName(Element element) {
if (element == null) { return this.typeExtractor.getQualifiedName(element);
return null;
}
TypeElement enclosingElement = getEnclosingTypeElement(element.asType());
if (enclosingElement != null) {
return getQualifiedName(enclosingElement) + "$"
+ ((DeclaredType) element.asType()).asElement().getSimpleName()
.toString();
}
if (element instanceof TypeElement) {
return ((TypeElement) element).getQualifiedName().toString();
}
throw new IllegalStateException(
"Could not extract qualified name from " + element);
} }
/** /**
@ -126,27 +118,7 @@ class TypeUtils {
if (type == null) { if (type == null) {
return null; return null;
} }
Class<?> wrapper = getWrapperFor(type); return type.accept(this.typeExtractor, null);
if (wrapper != null) {
return wrapper.getName();
}
TypeElement enclosingElement = getEnclosingTypeElement(type);
if (enclosingElement != null) {
return getQualifiedName(enclosingElement) + "$"
+ ((DeclaredType) type).asElement().getSimpleName().toString();
}
return type.toString();
}
private TypeElement getEnclosingTypeElement(TypeMirror type) {
if (type instanceof DeclaredType) {
DeclaredType declaredType = (DeclaredType) type;
Element enclosingElement = declaredType.asElement().getEnclosingElement();
if (enclosingElement != null && enclosingElement instanceof TypeElement) {
return (TypeElement) enclosingElement;
}
}
return null;
} }
public boolean isCollectionOrMap(TypeMirror type) { public boolean isCollectionOrMap(TypeMirror type) {
@ -194,4 +166,62 @@ class TypeUtils {
return WRAPPER_TO_PRIMITIVE.get(type.toString()); return WRAPPER_TO_PRIMITIVE.get(type.toString());
} }
/**
* A visitor that extracts the full qualified name of a type, including generic
* information.
*/
private static class TypeExtractor extends SimpleTypeVisitor6<String, Void> {
private final Types types;
TypeExtractor(Types types) {
this.types = types;
}
@Override
public String visitDeclared(DeclaredType type, Void none) {
TypeElement enclosingElement = getEnclosingTypeElement(type);
if (enclosingElement != null) {
return getQualifiedName(enclosingElement) + "$"
+ type.asElement().getSimpleName().toString();
}
return type.toString();
}
@Override
public String visitPrimitive(PrimitiveType t, Void none) {
return this.types.boxedClass(t).getQualifiedName().toString();
}
public String getQualifiedName(Element element) {
if (element == null) {
return null;
}
TypeElement enclosingElement = getEnclosingTypeElement(element.asType());
if (enclosingElement != null) {
return getQualifiedName(enclosingElement) + "$"
+ ((DeclaredType) element.asType()).asElement().getSimpleName()
.toString();
}
if (element instanceof TypeElement) {
return ((TypeElement) element).getQualifiedName().toString();
}
throw new IllegalStateException(
"Could not extract qualified name from " + element);
}
private TypeElement getEnclosingTypeElement(TypeMirror type) {
if (type instanceof DeclaredType) {
DeclaredType declaredType = (DeclaredType) type;
Element enclosingElement = declaredType.asElement().getEnclosingElement();
if (enclosingElement != null && enclosingElement instanceof TypeElement) {
return (TypeElement) enclosingElement;
}
}
return null;
}
}
} }

Loading…
Cancel
Save