Detect default values defined in the parent

Closes gh-5434
This commit is contained in:
Hrishikesh Joshi 2016-11-26 23:31:30 +11:00 committed by Stephane Nicoll
parent b618c70e52
commit b3220985bb
4 changed files with 100 additions and 13 deletions

View File

@ -20,7 +20,6 @@ import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.PrintWriter;
import java.io.StringWriter;
import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.Set;
@ -192,23 +191,14 @@ public class ConfigurationMetadataAnnotationProcessor extends AbstractProcessor
private void processTypeElement(String prefix, TypeElement element,
ExecutableElement source) {
TypeElementMembers members = new TypeElementMembers(this.processingEnv, element);
Map<String, Object> fieldValues = getFieldValues(element);
TypeElementMembers members = new TypeElementMembers(this.processingEnv, this.fieldValuesParser, element);
Map<String, Object> fieldValues = members.getFieldValues();
processSimpleTypes(prefix, element, source, members, fieldValues);
processSimpleLombokTypes(prefix, element, source, members, fieldValues);
processNestedTypes(prefix, element, source, members);
processNestedLombokTypes(prefix, element, source, members);
}
private Map<String, Object> getFieldValues(TypeElement element) {
try {
return this.fieldValuesParser.getFieldValues(element);
}
catch (Exception ex) {
return Collections.emptyMap();
}
}
private void processSimpleTypes(String prefix, TypeElement element,
ExecutableElement source, TypeElementMembers members,
Map<String, Object> fieldValues) {

View File

@ -31,6 +31,9 @@ import javax.lang.model.element.VariableElement;
import javax.lang.model.type.TypeKind;
import javax.lang.model.type.TypeMirror;
import javax.lang.model.util.ElementFilter;
import javax.tools.Diagnostic;
import org.springframework.boot.configurationprocessor.fieldvalues.FieldValuesParser;
/**
* Provides access to relevant {@link TypeElement} members.
@ -53,10 +56,16 @@ class TypeElementMembers {
private final Map<String, List<ExecutableElement>> publicSetters = new LinkedHashMap<String, List<ExecutableElement>>();
TypeElementMembers(ProcessingEnvironment env, TypeElement element) {
private final Map<String, Object> fieldValues = new LinkedHashMap<String, Object>();
private final FieldValuesParser fieldValuesParser;
TypeElementMembers(ProcessingEnvironment env, FieldValuesParser fieldValuesParser, TypeElement element) {
this.env = env;
this.typeUtils = new TypeUtils(this.env);
this.fieldValuesParser = fieldValuesParser;
process(element);
processFieldValues(element);
}
private void process(TypeElement element) {
@ -165,4 +174,26 @@ class TypeElementMembers {
return null;
}
private void processFieldValues(TypeElement element) {
try {
this.fieldValues.putAll(this.fieldValuesParser.getFieldValues(element));
}
catch (Exception ex) {
logWarning("Could not get values for type :" + element.getSimpleName().toString());
}
Element superType = this.env.getTypeUtils().asElement(element.getSuperclass());
if (superType != null && superType instanceof TypeElement && !Object.class.getName().equals(superType.toString())) {
processFieldValues((TypeElement) superType);
}
}
private void logWarning(String message) {
this.env.getMessager().printMessage(Diagnostic.Kind.WARNING, message);
}
public Map<String, Object> getFieldValues() {
return Collections.unmodifiableMap(this.fieldValues);
}
}

View File

@ -47,6 +47,7 @@ import org.springframework.boot.configurationsample.method.EmptyTypeMethodConfig
import org.springframework.boot.configurationsample.method.InvalidMethodConfig;
import org.springframework.boot.configurationsample.method.MethodAndClassConfig;
import org.springframework.boot.configurationsample.method.SimpleMethodConfig;
import org.springframework.boot.configurationsample.simple.ClassWithNestedProperties;
import org.springframework.boot.configurationsample.simple.DeprecatedSingleProperty;
import org.springframework.boot.configurationsample.simple.HierarchicalProperties;
import org.springframework.boot.configurationsample.simple.NotAnnotated;
@ -767,6 +768,17 @@ public class ConfigurationMetadataAnnotationProcessorTests {
}
}
@Test
public void nestedClassChildProperties() throws Exception {
ConfigurationMetadata metadata = compile(ClassWithNestedProperties.class);
assertThat(metadata).has(Metadata.withGroup("nestedChildProps")
.fromSource(ClassWithNestedProperties.NestedChildClass.class));
assertThat(metadata).has(Metadata.withProperty("nestedChildProps.child-class-property", Integer.class)
.fromSource(ClassWithNestedProperties.NestedChildClass.class).withDefaultValue(20));
assertThat(metadata).has(Metadata.withProperty("nestedChildProps.parent-class-property", Integer.class)
.fromSource(ClassWithNestedProperties.NestedChildClass.class).withDefaultValue(10));
}
private static class AdditionalMetadata {
}

View File

@ -0,0 +1,54 @@
/*
* Copyright 2012-2014 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.configurationsample.simple;
import org.springframework.boot.configurationsample.ConfigurationProperties;
/**
* Class with nested configuration properties.
*
* @author Hrishikesh Joshi
*/
public class ClassWithNestedProperties {
public static class NestedParentClass {
private int parentClassProperty = 10;
public int getParentClassProperty() {
return this.parentClassProperty;
}
public void setParentClassProperty(int parentClassProperty) {
this.parentClassProperty = parentClassProperty;
}
}
@ConfigurationProperties(prefix = "nestedChildProps")
public static class NestedChildClass extends NestedParentClass {
private int childClassProperty = 20;
public int getChildClassProperty() {
return this.childClassProperty;
}
public void setChildClassProperty(int childClassProperty) {
this.childClassProperty = childClassProperty;
}
}
}