spring InvalidConfigurationPropertyValueFailureAnalyzer 源码
springboot InvalidConfigurationPropertyValueFailureAnalyzer 代码
文件路径:/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/diagnostics/analyzer/InvalidConfigurationPropertyValueFailureAnalyzer.java
/*
* Copyright 2012-2022 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.diagnostics.analyzer;
import java.util.List;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import org.springframework.boot.context.properties.source.ConfigurationPropertySources;
import org.springframework.boot.context.properties.source.InvalidConfigurationPropertyValueException;
import org.springframework.boot.diagnostics.AbstractFailureAnalyzer;
import org.springframework.boot.diagnostics.FailureAnalysis;
import org.springframework.boot.diagnostics.FailureAnalyzer;
import org.springframework.boot.origin.Origin;
import org.springframework.boot.origin.OriginLookup;
import org.springframework.core.env.ConfigurableEnvironment;
import org.springframework.core.env.Environment;
import org.springframework.core.env.PropertySource;
import org.springframework.util.StringUtils;
/**
* A {@link FailureAnalyzer} that performs analysis of failures caused by an
* {@link InvalidConfigurationPropertyValueException}.
*
* @author Stephane Nicoll
* @author Scott Frederick
*/
class InvalidConfigurationPropertyValueFailureAnalyzer
extends AbstractFailureAnalyzer<InvalidConfigurationPropertyValueException> {
private final ConfigurableEnvironment environment;
InvalidConfigurationPropertyValueFailureAnalyzer(Environment environment) {
this.environment = (ConfigurableEnvironment) environment;
}
@Override
protected FailureAnalysis analyze(Throwable rootFailure, InvalidConfigurationPropertyValueException cause) {
List<Descriptor> descriptors = getDescriptors(cause.getName());
if (descriptors.isEmpty()) {
return null;
}
StringBuilder description = new StringBuilder();
appendDetails(description, cause, descriptors);
appendReason(description, cause);
appendAdditionalProperties(description, descriptors);
return new FailureAnalysis(description.toString(), getAction(cause), cause);
}
private List<Descriptor> getDescriptors(String propertyName) {
return getPropertySources().filter((source) -> source.containsProperty(propertyName))
.map((source) -> Descriptor.get(source, propertyName)).collect(Collectors.toList());
}
private Stream<PropertySource<?>> getPropertySources() {
if (this.environment == null) {
return Stream.empty();
}
return this.environment.getPropertySources().stream()
.filter((source) -> !ConfigurationPropertySources.isAttachedConfigurationPropertySource(source));
}
private void appendDetails(StringBuilder message, InvalidConfigurationPropertyValueException cause,
List<Descriptor> descriptors) {
Descriptor mainDescriptor = descriptors.get(0);
message.append("Invalid value '").append(mainDescriptor.getValue()).append("' for configuration property '");
message.append(cause.getName()).append("'");
mainDescriptor.appendOrigin(message);
message.append(".");
}
private void appendReason(StringBuilder message, InvalidConfigurationPropertyValueException cause) {
if (StringUtils.hasText(cause.getReason())) {
message.append(String.format(" Validation failed for the following reason:%n%n"));
message.append(cause.getReason());
}
else {
message.append(" No reason was provided.");
}
}
private void appendAdditionalProperties(StringBuilder message, List<Descriptor> descriptors) {
List<Descriptor> others = descriptors.subList(1, descriptors.size());
if (!others.isEmpty()) {
message.append(
String.format("%n%nAdditionally, this property is also set in the following property %s:%n%n",
(others.size() > 1) ? "sources" : "source"));
for (Descriptor other : others) {
message.append("\t- In '").append(other.getPropertySource()).append("'");
message.append(" with the value '").append(other.getValue()).append("'");
other.appendOrigin(message);
message.append(String.format(".%n"));
}
}
}
private String getAction(InvalidConfigurationPropertyValueException cause) {
StringBuilder action = new StringBuilder();
action.append("Review the value of the property");
if (cause.getReason() != null) {
action.append(" with the provided reason");
}
action.append(".");
return action.toString();
}
private static final class Descriptor {
private final String propertySource;
private final Object value;
private final Origin origin;
private Descriptor(String propertySource, Object value, Origin origin) {
this.propertySource = propertySource;
this.value = value;
this.origin = origin;
}
String getPropertySource() {
return this.propertySource;
}
Object getValue() {
return this.value;
}
void appendOrigin(StringBuilder message) {
if (this.origin != null) {
message.append(" (originating from '").append(this.origin).append("')");
}
}
static Descriptor get(PropertySource<?> source, String propertyName) {
Object value = source.getProperty(propertyName);
Origin origin = OriginLookup.getOrigin(source, propertyName);
return new Descriptor(source.getName(), value, origin);
}
}
}
相关信息
相关文章
spring AbstractInjectionFailureAnalyzer 源码
spring BeanCurrentlyInCreationFailureAnalyzer 源码
spring BeanDefinitionOverrideFailureAnalyzer 源码
spring BeanNotOfRequiredTypeFailureAnalyzer 源码
spring BindValidationFailureAnalyzer 源码
spring InvalidConfigurationPropertyNameFailureAnalyzer 源码
spring MutuallyExclusiveConfigurationPropertiesFailureAnalyzer 源码
0
赞
- 所属分类: 后端技术
- 本文标签: Spring Boot Java Spring
热门推荐
-
2、 - 优质文章
-
3、 gate.io
-
8、 golang
-
9、 openharmony
-
10、 Vue中input框自动聚焦