程序包 cn.taketoday.context.support

类 PropertySourcesPlaceholderConfigurer

java.lang.Object

cn.taketoday.core.io.PropertiesLoaderSupport

cn.taketoday.beans.factory.config.PropertyResourceConfigurer

cn.taketoday.beans.factory.config.PlaceholderConfigurerSupport

cn.taketoday.context.support.PropertySourcesPlaceholderConfigurer

所有已实现的接口:

Aware, BeanFactoryAware, BeanNameAware, BeanFactoryPostProcessor, EnvironmentAware, cn.taketoday.core.Ordered, cn.taketoday.core.PriorityOrdered

public class PropertySourcesPlaceholderConfigurer
extends PlaceholderConfigurerSupport
implements EnvironmentAware

Specialization of PlaceholderConfigurerSupport that resolves ${...} placeholders within bean definition property values and @Value annotations against the current Framework Environment and its set of PropertySources.

Any local properties (e.g. those added via PropertiesLoaderSupport.setProperties(java.util.Properties), PropertiesLoaderSupport.setLocations(cn.taketoday.core.io.Resource...) et al.) are added as a PropertySource. Search precedence of local properties is based on the value of the localOverride property, which is by default false meaning that local properties are to be searched last, after all environment property sources.

See ConfigurableEnvironment and related javadocs for details on manipulating environment property sources.

从以下版本开始:

4.0 2021/12/12 14:39

作者:

Chris Beams, Juergen Hoeller, Harry Yang

另请参阅:

• ConfigurableEnvironment
• PlaceholderConfigurerSupport

字段概要

字段

修饰符和类型	字段	说明
static final String	ENVIRONMENT_PROPERTIES_PROPERTY_SOURCE_NAME	"environmentProperties" is the name given to the PropertySource that wraps the environment supplied to this configurer.
static final String	LOCAL_PROPERTIES_PROPERTY_SOURCE_NAME	"localProperties" is the name given to the PropertySource for the set of merged properties supplied to this configurer.

从类继承的字段 cn.taketoday.beans.factory.config.PlaceholderConfigurerSupport

DEFAULT_PLACEHOLDER_PREFIX, DEFAULT_PLACEHOLDER_SUFFIX, DEFAULT_VALUE_SEPARATOR, ignoreUnresolvablePlaceholders, nullValue, placeholderPrefix, placeholderSuffix, trimValues, valueSeparator

从类继承的字段 cn.taketoday.core.io.PropertiesLoaderSupport

localOverride, localProperties, logger

从接口继承的字段 cn.taketoday.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

构造器概要

构造器

构造器	说明
PropertySourcesPlaceholderConfigurer()

方法概要

修饰符和类型	方法	说明
cn.taketoday.core.env.PropertySources	getAppliedPropertySources()	Return the property sources that were actually applied during post-processing.
void	postProcessBeanFactory(ConfigurableBeanFactory beanFactory)	Processing occurs by replacing ${...} placeholders in bean definitions by resolving each against this configurer's set of PropertySources, which includes: all environment property sources, if an Environment is present merged local properties, if any have been specified any property sources set by calling setPropertySources(cn.taketoday.core.env.PropertySources)
protected void	processProperties(ConfigurableBeanFactory beanFactoryToProcess, cn.taketoday.core.env.ConfigurablePropertyResolver propertyResolver)	Visit each bean definition in the given bean factory and attempt to replace ${...} property placeholders with values from the given properties.
protected void	processProperties(ConfigurableBeanFactory beanFactory, Properties props)	Implemented for compatibility with PlaceholderConfigurerSupport.
void	setEnvironment(cn.taketoday.core.env.Environment environment)	PropertySources from the given Environment will be searched when replacing ${...} placeholders.
void	setPropertySources(cn.taketoday.core.env.PropertySources propertySources)	Customize the set of PropertySources to be used by this configurer.

从类继承的方法 cn.taketoday.beans.factory.config.PlaceholderConfigurerSupport

doProcessProperties, setBeanFactory, setBeanName, setIgnoreUnresolvablePlaceholders, setNullValue, setPlaceholderPrefix, setPlaceholderSuffix, setTrimValues, setValueSeparator

从类继承的方法 cn.taketoday.beans.factory.config.PropertyResourceConfigurer

convertProperties, convertProperty, convertPropertyValue, getOrder, setOrder

从类继承的方法 cn.taketoday.core.io.PropertiesLoaderSupport

loadProperties, mergeProperties, setFileEncoding, setIgnoreResourceNotFound, setLocalOverride, setLocation, setLocations, setProperties, setPropertiesArray, setPropertiesPersister

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

LOCAL_PROPERTIES_PROPERTY_SOURCE_NAME

public static final String LOCAL_PROPERTIES_PROPERTY_SOURCE_NAME

"localProperties" is the name given to the PropertySource for the set of merged properties supplied to this configurer.

另请参阅:

• 常量字段值

ENVIRONMENT_PROPERTIES_PROPERTY_SOURCE_NAME

public static final String ENVIRONMENT_PROPERTIES_PROPERTY_SOURCE_NAME

"environmentProperties" is the name given to the PropertySource that wraps the environment supplied to this configurer.

另请参阅:

• 常量字段值

构造器详细资料

PropertySourcesPlaceholderConfigurer

public PropertySourcesPlaceholderConfigurer()

方法详细资料

setPropertySources

public void setPropertySources(cn.taketoday.core.env.PropertySources propertySources)

Customize the set of PropertySources to be used by this configurer.

Setting this property indicates that environment property sources and local properties should be ignored.

另请参阅:

• postProcessBeanFactory(cn.taketoday.beans.factory.config.ConfigurableBeanFactory)

setEnvironment

public void setEnvironment(@Nullable
 cn.taketoday.core.env.Environment environment)

PropertySources from the given Environment will be searched when replacing ${...} placeholders.

指定者:

setEnvironment 在接口中 EnvironmentAware

另请参阅:

• setPropertySources(cn.taketoday.core.env.PropertySources)
• postProcessBeanFactory(cn.taketoday.beans.factory.config.ConfigurableBeanFactory)

postProcessBeanFactory

public void postProcessBeanFactory(ConfigurableBeanFactory beanFactory)
                            throws BeansException

Processing occurs by replacing ${...} placeholders in bean definitions by resolving each against this configurer's set of PropertySources, which includes:

• all environment property sources, if an Environment is present
• merged local properties, if any have been specified
• any property sources set by calling setPropertySources(cn.taketoday.core.env.PropertySources)

If setPropertySources(cn.taketoday.core.env.PropertySources) is called, environment and local properties will be ignored. This method is designed to give the user fine-grained control over property sources, and once set, the configurer makes no assumptions about adding additional sources.

指定者:

postProcessBeanFactory 在接口中 BeanFactoryPostProcessor

覆盖:

postProcessBeanFactory 在类中 PropertyResourceConfigurer

抛出:

BeansException

processProperties

protected void processProperties(ConfigurableBeanFactory beanFactoryToProcess,
 cn.taketoday.core.env.ConfigurablePropertyResolver propertyResolver)
                          throws BeansException

Visit each bean definition in the given bean factory and attempt to replace ${...} property placeholders with values from the given properties.

抛出:

BeansException

processProperties

protected void processProperties(ConfigurableBeanFactory beanFactory,
 Properties props)

Implemented for compatibility with PlaceholderConfigurerSupport.

指定者:

processProperties 在类中 PropertyResourceConfigurer

抛出:

UnsupportedOperationException - in this implementation use processProperties(ConfigurableBeanFactory, ConfigurablePropertyResolver)

getAppliedPropertySources

public cn.taketoday.core.env.PropertySources getAppliedPropertySources()
                                                                throws IllegalStateException

Return the property sources that were actually applied during post-processing.

返回:

the property sources that were applied

抛出:

IllegalStateException - if the property sources have not yet been applied