-
Notifications
You must be signed in to change notification settings - Fork 40.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Short circuit already covered property sources
Add an alternative `PropertySourcesPropertyResolver` that can short circuit resolution of properties that are already covered by the `ConfigurationPropertySourcesPropertySource`. Prior to this commit, calling `getProperty` or `containsProperty` on an `Environment` that has `ConfigurationPropertySources` attached could result in two identical calls to the underlying source. The first call would be via the adapted source, and the second would be direct. Since we can now plug-in a custom `PropertySourcesPropertyResolver` to the `Environment`, we can optimize resolution so that calls happen only once. Closes gh-17400
- Loading branch information
Showing
9 changed files
with
347 additions
and
4 deletions.
There are no files selected for viewing
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
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
128 changes: 128 additions & 0 deletions
128
...ramework/boot/context/properties/source/ConfigurationPropertySourcesPropertyResolver.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,128 @@ | ||
/* | ||
* Copyright 2012-2021 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.source; | ||
|
||
import org.springframework.core.env.AbstractPropertyResolver; | ||
import org.springframework.core.env.MutablePropertySources; | ||
import org.springframework.core.env.PropertySources; | ||
import org.springframework.core.env.PropertySourcesPropertyResolver; | ||
|
||
/** | ||
* Alternative {@link PropertySourcesPropertyResolver} implementation that recognizes | ||
* {@link ConfigurationPropertySourcesPropertySource} and saves duplicate calls to the | ||
* underlying sources if the name is a value {@link ConfigurationPropertyName}. | ||
* | ||
* @author Phillip Webb | ||
*/ | ||
class ConfigurationPropertySourcesPropertyResolver extends AbstractPropertyResolver { | ||
|
||
private final MutablePropertySources propertySources; | ||
|
||
private final DefaultResolver defaultResolver; | ||
|
||
ConfigurationPropertySourcesPropertyResolver(MutablePropertySources propertySources) { | ||
this.propertySources = propertySources; | ||
this.defaultResolver = new DefaultResolver(propertySources); | ||
} | ||
|
||
@Override | ||
public boolean containsProperty(String key) { | ||
ConfigurationPropertySourcesPropertySource attached = getAttached(); | ||
if (attached != null) { | ||
ConfigurationPropertyName name = ConfigurationPropertyName.of(key, true); | ||
if (name != null) { | ||
try { | ||
return attached.findConfigurationProperty(name) != null; | ||
} | ||
catch (Exception ex) { | ||
} | ||
} | ||
} | ||
return this.defaultResolver.containsProperty(key); | ||
} | ||
|
||
@Override | ||
public String getProperty(String key) { | ||
return getProperty(key, String.class, true); | ||
} | ||
|
||
@Override | ||
public <T> T getProperty(String key, Class<T> targetValueType) { | ||
return getProperty(key, targetValueType, true); | ||
} | ||
|
||
@Override | ||
protected String getPropertyAsRawString(String key) { | ||
return getProperty(key, String.class, false); | ||
} | ||
|
||
private <T> T getProperty(String key, Class<T> targetValueType, boolean resolveNestedPlaceholders) { | ||
Object value = findPropertyValue(key, targetValueType); | ||
if (value == null) { | ||
return null; | ||
} | ||
if (resolveNestedPlaceholders && value instanceof String) { | ||
value = resolveNestedPlaceholders((String) value); | ||
} | ||
return convertValueIfNecessary(value, targetValueType); | ||
} | ||
|
||
private Object findPropertyValue(String key, Class<?> targetValueType) { | ||
ConfigurationPropertySourcesPropertySource attached = getAttached(); | ||
if (attached != null) { | ||
ConfigurationPropertyName name = ConfigurationPropertyName.of(key, true); | ||
if (name != null) { | ||
try { | ||
ConfigurationProperty configurationProperty = attached.findConfigurationProperty(name); | ||
return (configurationProperty != null) ? configurationProperty.getValue() : null; | ||
} | ||
catch (Exception ex) { | ||
} | ||
} | ||
} | ||
return this.defaultResolver.getProperty(key, targetValueType, false); | ||
} | ||
|
||
private ConfigurationPropertySourcesPropertySource getAttached() { | ||
ConfigurationPropertySourcesPropertySource attached = (ConfigurationPropertySourcesPropertySource) ConfigurationPropertySources | ||
.getAttached(this.propertySources); | ||
Iterable<ConfigurationPropertySource> attachedSource = (attached != null) ? attached.getSource() : null; | ||
if ((attachedSource instanceof SpringConfigurationPropertySources) | ||
&& ((SpringConfigurationPropertySources) attachedSource).isUsingSources(this.propertySources)) { | ||
return attached; | ||
} | ||
return null; | ||
} | ||
|
||
/** | ||
* Default {@link PropertySourcesPropertyResolver} used if | ||
* {@link ConfigurationPropertySources} is not attached. | ||
*/ | ||
static class DefaultResolver extends PropertySourcesPropertyResolver { | ||
|
||
DefaultResolver(PropertySources propertySources) { | ||
super(propertySources); | ||
} | ||
|
||
@Override | ||
public <T> T getProperty(String key, Class<T> targetValueType, boolean resolveNestedPlaceholders) { | ||
return super.getProperty(key, targetValueType, resolveNestedPlaceholders); | ||
} | ||
|
||
} | ||
|
||
} |
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
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
Oops, something went wrong.