Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
6 changed files
with
209 additions
and
107 deletions.
There are no files selected for viewing
91 changes: 0 additions & 91 deletions
91
...ringframework/boot/context/properties/ConfigurationPropertiesBeanDefinitionValidator.java
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
83 changes: 83 additions & 0 deletions
83
.../springframework/boot/context/properties/NotConstructorBoundInjectionFailureAnalyzer.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,83 @@ | ||
/* | ||
* Copyright 2012-2020 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.context.properties; | ||
|
||
import java.lang.reflect.Constructor; | ||
|
||
import org.springframework.beans.factory.InjectionPoint; | ||
import org.springframework.beans.factory.NoSuchBeanDefinitionException; | ||
import org.springframework.beans.factory.UnsatisfiedDependencyException; | ||
import org.springframework.boot.context.properties.ConfigurationPropertiesBean.BindMethod; | ||
import org.springframework.boot.diagnostics.FailureAnalysis; | ||
import org.springframework.boot.diagnostics.analyzer.AbstractInjectionFailureAnalyzer; | ||
import org.springframework.core.Ordered; | ||
import org.springframework.core.annotation.MergedAnnotation; | ||
import org.springframework.core.annotation.MergedAnnotations; | ||
|
||
/** | ||
* An {@AbstractInjectionFailureAnalyzer} for | ||
* {@link ConfigurationProperties @ConfigurationProperties} that are intended to use | ||
* {@link ConstructorBinding constructor binding} but did not. | ||
* | ||
* @author Andy Wilkinson | ||
*/ | ||
class NotConstructorBoundInjectionFailureAnalyzer | ||
extends AbstractInjectionFailureAnalyzer<NoSuchBeanDefinitionException> implements Ordered { | ||
|
||
@Override | ||
public int getOrder() { | ||
return 0; | ||
} | ||
|
||
@Override | ||
protected FailureAnalysis analyze(Throwable rootFailure, NoSuchBeanDefinitionException cause, String description) { | ||
InjectionPoint injectionPoint = findInjectionPoint(rootFailure); | ||
if (isConstructorBindingConfigurationProperties(injectionPoint)) { | ||
String simpleName = injectionPoint.getMember().getDeclaringClass().getSimpleName(); | ||
String action = String.format("Update your configuration so that " + simpleName + " is defined via @" | ||
+ ConfigurationPropertiesScan.class.getSimpleName() + " or @" | ||
+ EnableConfigurationProperties.class.getSimpleName() + ".", simpleName); | ||
return new FailureAnalysis( | ||
simpleName + " is annotated with @" + ConstructorBinding.class.getSimpleName() | ||
+ " but it is defined as a regular bean which caused dependency injection to fail.", | ||
action, cause); | ||
} | ||
return null; | ||
} | ||
|
||
private boolean isConstructorBindingConfigurationProperties(InjectionPoint injectionPoint) { | ||
if (injectionPoint != null && injectionPoint.getMember() instanceof Constructor) { | ||
Constructor<?> constructor = (Constructor<?>) injectionPoint.getMember(); | ||
Class<?> declaringClass = constructor.getDeclaringClass(); | ||
MergedAnnotation<ConfigurationProperties> configurationProperties = MergedAnnotations.from(declaringClass) | ||
.get(ConfigurationProperties.class); | ||
return configurationProperties.isPresent() | ||
&& BindMethod.forType(constructor.getDeclaringClass()) == BindMethod.VALUE_OBJECT; | ||
} | ||
return false; | ||
} | ||
|
||
private InjectionPoint findInjectionPoint(Throwable failure) { | ||
UnsatisfiedDependencyException unsatisfiedDependencyException = findCause(failure, | ||
UnsatisfiedDependencyException.class); | ||
if (unsatisfiedDependencyException == null) { | ||
return null; | ||
} | ||
return unsatisfiedDependencyException.getInjectionPoint(); | ||
} | ||
|
||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
125 changes: 125 additions & 0 deletions
125
...ngframework/boot/context/properties/NotConstructorBoundInjectionFailureAnalyzerTests.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,125 @@ | ||
/* | ||
* Copyright 2012-2020 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.context.properties; | ||
|
||
import org.junit.jupiter.api.Test; | ||
|
||
import org.springframework.beans.FatalBeanException; | ||
import org.springframework.boot.diagnostics.FailureAnalysis; | ||
import org.springframework.boot.diagnostics.LoggingFailureAnalysisReporter; | ||
import org.springframework.context.annotation.AnnotationConfigApplicationContext; | ||
import org.springframework.context.annotation.Configuration; | ||
import org.springframework.context.annotation.Import; | ||
|
||
import static org.assertj.core.api.Assertions.assertThat; | ||
|
||
/** | ||
* Tests for {@link NotConstructorBoundInjectionFailureAnalyzer}. | ||
* | ||
* @author Andy Wilkinson | ||
*/ | ||
class NotConstructorBoundInjectionFailureAnalyzerTests { | ||
|
||
private final NotConstructorBoundInjectionFailureAnalyzer analyzer = new NotConstructorBoundInjectionFailureAnalyzer(); | ||
|
||
@Test | ||
void failureAnalysisForConfigurationPropertiesThatShouldHaveBeenConstructorBound() { | ||
FailureAnalysis analysis = analyzeFailure( | ||
createFailure(ShouldHaveUsedConstructorBindingPropertiesConfiguration.class)); | ||
assertThat(analysis.getDescription()).isEqualTo(ConstructorBoundProperties.class.getSimpleName() | ||
+ " is annotated with @" + ConstructorBinding.class.getSimpleName() | ||
+ " but it is defined as a regular bean which caused dependency injection to fail."); | ||
assertThat(analysis.getAction()) | ||
.isEqualTo("Update your configuration so that " + ConstructorBoundProperties.class.getSimpleName() | ||
+ " is defined via @" + ConfigurationPropertiesScan.class.getSimpleName() + " or @" | ||
+ EnableConfigurationProperties.class.getSimpleName() + "."); | ||
} | ||
|
||
@Test | ||
void failureAnaylsisForNonConstructorBoundProperties() { | ||
FailureAnalysis analysis = analyzeFailure(createFailure(JavaBeanBoundPropertiesConfiguration.class)); | ||
assertThat(analysis).isNull(); | ||
} | ||
|
||
private FatalBeanException createFailure(Class<?> config) { | ||
try (AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext()) { | ||
context.register(config); | ||
context.refresh(); | ||
return null; | ||
} | ||
catch (FatalBeanException ex) { | ||
return ex; | ||
} | ||
} | ||
|
||
private FailureAnalysis analyzeFailure(Exception failure) { | ||
assertThat(failure).isNotNull(); | ||
FailureAnalysis analysis = this.analyzer.analyze(failure); | ||
if (analysis != null) { | ||
new LoggingFailureAnalysisReporter().report(analysis); | ||
} | ||
return analysis; | ||
} | ||
|
||
@ConstructorBinding | ||
@ConfigurationProperties("test") | ||
static class ConstructorBoundProperties { | ||
|
||
private final String name; | ||
|
||
ConstructorBoundProperties(String name) { | ||
this.name = name; | ||
} | ||
|
||
String getName() { | ||
return this.name; | ||
} | ||
|
||
} | ||
|
||
@Configuration(proxyBeanMethods = false) | ||
@Import(ConstructorBoundProperties.class) | ||
static class ShouldHaveUsedConstructorBindingPropertiesConfiguration { | ||
|
||
} | ||
|
||
@ConfigurationProperties("test") | ||
static class JavaBeanBoundProperties { | ||
|
||
private String name; | ||
|
||
JavaBeanBoundProperties(String dependency) { | ||
|
||
} | ||
|
||
String getName() { | ||
return this.name; | ||
} | ||
|
||
void setName(String name) { | ||
this.name = name; | ||
} | ||
|
||
} | ||
|
||
@Configuration(proxyBeanMethods = false) | ||
@Import(JavaBeanBoundProperties.class) | ||
static class JavaBeanBoundPropertiesConfiguration { | ||
|
||
} | ||
|
||
} |