-
Notifications
You must be signed in to change notification settings - Fork 40.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Short circuit @Value injection when using a source already covered by ConfigurationPropertySourcesPropertySource #34900
Open
terminux
wants to merge
1
commit into
spring-projects:main
Choose a base branch
from
terminux:gh-28687
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+120
−6
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
37 changes: 37 additions & 0 deletions
37
...amework/boot/autoconfigure/context/ConfigurationPropertySourcesPlaceholderConfigurer.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,37 @@ | ||
/* | ||
* Copyright 2012-2023 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.autoconfigure.context; | ||
|
||
import org.springframework.boot.context.properties.source.ConfigurationPropertySources; | ||
import org.springframework.context.support.PropertySourcesPlaceholderConfigurer; | ||
import org.springframework.core.env.ConfigurablePropertyResolver; | ||
import org.springframework.core.env.MutablePropertySources; | ||
|
||
/** | ||
* Placeholder configurer that resolves using the optimized | ||
* {@link ConfigurablePropertyResolver}. | ||
* | ||
* @author Guirong Hu | ||
*/ | ||
class ConfigurationPropertySourcesPlaceholderConfigurer extends PropertySourcesPlaceholderConfigurer { | ||
|
||
@Override | ||
protected ConfigurablePropertyResolver createPropertyResolver(MutablePropertySources propertySources) { | ||
return ConfigurationPropertySources.createPropertyResolver(propertySources); | ||
} | ||
|
||
} |
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
76 changes: 76 additions & 0 deletions
76
...rk/boot/autoconfigure/context/ConfigurationPropertySourcesPlaceholderConfigurerTests.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,76 @@ | ||
/* | ||
* Copyright 2012-2023 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.autoconfigure.context; | ||
|
||
import org.junit.jupiter.api.Test; | ||
import org.springframework.beans.BeansException; | ||
import org.springframework.beans.factory.config.ConfigurableListableBeanFactory; | ||
import org.springframework.boot.context.properties.source.ConfigurationPropertySources; | ||
import org.springframework.boot.test.context.runner.ApplicationContextRunner; | ||
import org.springframework.context.annotation.Bean; | ||
import org.springframework.context.annotation.Configuration; | ||
import org.springframework.core.env.ConfigurablePropertyResolver; | ||
import org.springframework.core.env.MutablePropertySources; | ||
|
||
import static org.assertj.core.api.Assertions.assertThat; | ||
|
||
/** | ||
* Tests for {@link ConfigurationPropertySourcesPlaceholderConfigurer}. | ||
* | ||
* @author Guirong Hu | ||
*/ | ||
class ConfigurationPropertySourcesPlaceholderConfigurerTests { | ||
|
||
@Test | ||
void propertyResolverIsOptimizedForPropertyPlaceholder() { | ||
ConfigurablePropertyResolver expected = ConfigurationPropertySources | ||
.createPropertyResolver(new MutablePropertySources()); | ||
|
||
new ApplicationContextRunner().withUserConfiguration(GetPropertyResolverPlaceholderConfigurerConfig.class) | ||
.run((context) -> assertThat( | ||
context.getBean(GetPropertyResolverPlaceholderConfigurer.class).getPropertyResolver()) | ||
.hasSameClassAs(expected)); | ||
} | ||
|
||
@Configuration(proxyBeanMethods = false) | ||
static class GetPropertyResolverPlaceholderConfigurerConfig { | ||
|
||
@Bean | ||
static GetPropertyResolverPlaceholderConfigurer getPropertyResolverPlaceholderConfigurer() { | ||
return new GetPropertyResolverPlaceholderConfigurer(); | ||
} | ||
|
||
} | ||
|
||
static class GetPropertyResolverPlaceholderConfigurer extends ConfigurationPropertySourcesPlaceholderConfigurer { | ||
|
||
private ConfigurablePropertyResolver propertyResolver; | ||
|
||
@Override | ||
protected void processProperties(ConfigurableListableBeanFactory beanFactoryToProcess, | ||
ConfigurablePropertyResolver propertyResolver) throws BeansException { | ||
this.propertyResolver = propertyResolver; | ||
super.processProperties(beanFactoryToProcess, propertyResolver); | ||
} | ||
|
||
public ConfigurablePropertyResolver getPropertyResolver() { | ||
return this.propertyResolver; | ||
} | ||
|
||
} | ||
|
||
} |
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.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The current
logging
package does not allow the content of thecontext
package to be imported, I am not sure if I need to modify the rules or use other methods to create property resolver.spring-boot/src/checkstyle/import-control.xml
Line 80 in 2b5bd71
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That restriction was introduced in #8611. I'm not sure if we should relax it or not. I wonder if we can get away with using the
Environment
directly since it's already aPropertyResolver
.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for your reply! If you use
Environment
directly, we may need to set itsignoreUnresolvableNestedPlaceholders
property totrue
to ensure that it is consistent with the original behavior. Since theEnvironment
is modified, this will also affect the external use of it. Maybe we should make a copy ofEnvironment
?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good point. I need to think about this one for a bit.