Spring（13）——PropertyPlaceholderConfigurer

痛定思痛。 2022-06-11 02:25 192阅读 0赞

# 13 PropertyPlaceholderConfigurer #

PropertyPlaceholderConfigurer是对BeanFactoryPostProcessor接口的一种实现，其允许我们在定义bean的时候将bean的某些属性定义为变量形式，然后由PropertyPlaceholderConfigurer在这些bean被实例化之前利用外部定义的属性文件或者其内部定义的属性等将这些变量替换成对应的属性值。

我们可能经常会见到或者用到这样的定义，context:property-placeholder是Spring context命名空间内置的一个标签，针对该标签Spring内部会建立一个PropertyPlaceholderConfigurer对应的bean，其中location属性表示需要加载的外部属性文件对应的路径。

<context:property-placeholder location="/WEB-INF/config/jdbc.properties" />
    
    <bean id="dataSource" class="org.apache.commons.dbcp2.BasicDataSource"
    	destroy-method="close">
    	<property name="driverClassName" value="${jdbc.driverClassName}" />
    	<property name="url" value="${jdbc.url}" />
    	<property name="username" value="${jdbc.username}" />
    	<property name="password" value="${jdbc.password}" />
    </bean>

我们可以看到在上述配置中，id为dataSource的bean对应的属性值我们都是用的变量表示的。我们定义的PropertyPlaceholderConfigurer将在所有bean初始化前利用我们定义的外部属性文件jdbc.properties来对这些变量进行替换，所以对应的值我们可以直接定义在jdbc.properties文件中。

jdbc.driverClassName=oracle.jdbc.driver.OracleDriver
    jdbc.url=jdbc:oracle:thin:@localhost:1521:orcl
    jdbc.username=crm
    jdbc.password=crm

我们可以在bean容器中直接定义一个PropertyPlaceholderConfigurer类型的bean，用以在所有的bean定义加载完成后利用其可用的属性替换bean定义中使用的变量。PropertyPlaceholderConfigurer和PropertySourcesPlaceholderConfigurer均是继承自抽象类PlaceholderConfigurerSurpport的，它们使用的变量替换的主逻辑均来自PlaceholderConfigurerSurpport。

## 13.1 可用来作为替换变量的属性 ##

### 13.1.1 外部属性文件 ###

PropertyPlaceholderConfigurer常用来替换变量的属性通常是来自外部属性文件定义，通过其setLocation()方法或者是setLocations()方法进行注入，其中setLocation()方法用来注入一个外部属性文件，而setLocations()则是用来注入一个或多个外部属性文件，在注入的时候它们都将会被作为一个Resource进行注入。

通过setLocation()注入单个属性文件。

通过setLocations()注入一个或多个属性文件。

<bean class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
    		
    		<property name="locations">
    			<array>
    				<value>classpath:t1.properties</value>
    				<value>classpath:t2.properties</value>
    			</array>
    		</property>
    	</bean>

### 13.1.2 内部属性 ###

内部属性是通过setProperties()或setPropertiesArray()方法进行定义的，其中前者接收一个Properties对象，而后者则是接收一个Properties数组。

### 13.1.3环境变量、系统变量 ###

环境变量、系统变量是可以直接被PropertyPlaceholderConfigurer用来作为属性源对bean定义中使用的变量进行替换的。如JAVA\_HOME、user.dir等。环境变量即通过System.getenv(name)可获取到的，而系统变量则表示指定的JVM参数，即通过System.getProperty(name)可获取到的。

### 13.1.4 属性来源优先级 ###

既然我们可以用来替换变量的属性来源有多种不同的方式，那么当其中两者存在冲突时将采取怎样的策略呢？  
外部属性文件定义和内部属性定义算是一类，这里我们把它定义为A类，环境变量和系统变量定义为B类。在A类里面当外部属性文件中的定义与内部属性的定义存在冲突，即存在相同的属性时，默认情况下是外部属性文件定义的属性值将覆盖内部properties定义的。如果需要设置内部属性定义将覆盖外部属性文件定义的属性，则可以通过setLocalOverride()方法指定对应的localOverride为true来达到设置内部属性定义覆盖外部属性文件定义的属性的目的。

<bean
    		class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer"
    		p:localOverride="true">
    		
    	</bean>

对于B类存在与A类相同的属性定义时，将采取何种策略也是根据一个参数来确定的。通过setSystemPropertiesMode()方法可以指定对应的值，也可以通过setSystemPropertiesModeName()来指定对应的策略名称。其中可选值和可选名称如下：

*  SYSTEM\_PROPERTIES\_MODE\_NEVER：对应值为0。表示不使用系统属性进行替换。
 *  SYSTEM\_PROPERTIES\_MODE\_FALLBACK：对应的值为1，这是默认选项。表示只有在A类属性中没有找到变量对应的属性时才会尝试使用系统属性来进行替换。
 *  SYSTEM\_PROPERTIES\_MODE\_OVERRIDE：对应的值为2。表示当系统属性存在变量对应的属性时将使用系统属性的值。

<bean
    		class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer"
    		p:systemPropertiesMode="2">
    		<property name="properties">
    			<props>
    				<prop key="java.tempdir">abc</prop>
    			</props>
    		</property>
    	</bean>

## 13.2 变量的定义 ##

变量默认是使用“$\{varName\}”的形式进行定义的，即以“$\{”开始，以“\}”结束，中间对应变量名，PropertyPlaceholderConfigurer默认会将这种形式的定义当做是需要进行替换的变量定义，中间对应的是变量名。基本上除了id和name以外，bean定义的其它内容都可以使用变量进行定义，如class、parent等。

<bean id="hello" class="com.app.Hello" p:userDir="${user.dir}"/>

以上就是一个将属性userDir定义为变量user.dir的示例，在bean该bean被实例化之前将会由定义的PropertyPlaceholderConfigurer将其中的变量$\{user.dir\}进行替换。如果我们不想变量定义为“$\{varName\}”的形式我们也可以通过setPlaceholderPrefix()方法来指定变量对应的前缀，默认是“$\{”，然后通过setPlaceholderSuffix()方法来指定对应的后缀，默认是“\}”。所以如果我们希望我们的变量定义为“@\{varName\}”的形式，我们可以如下定义：

<bean
    		class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer"
    		p:placeholderPrefix="@{
        " p:placeholderSuffix="}" />

那么对应的变量就可以定义成如下这样：

<bean id="hello" class="com.app.Hello" p:userDir="@{user.dir}" />
    </beans>

## 13.3 指定默认值 ##

我们还可以在定义属性变量时指定对应的默认值。如果指定了属性变量的默认值，则在未找到可用于替换当前属性变量的属性时将使用定义好的默认值来替换当前属性变量。我们在定义属性变量时在变量名后面紧接着就可以指定默认值，默认值与变量名之间以分号隔开，形式如：$\{varName:defValue\}，其中varName表示变量名，defValue表示默认值。

<bean id="hello" class="com.app.Hello" p:maxVal="${maxVal:100}" />

属性变量名与默认值之间的分隔符默认是分号“:”，如果有需要用户也可以通过PropertyPlaceholderConfigurer的setValueSeparator()方法进行修改。

## 13.4 忽略文件未找到 ##

默认情况下我们在通过setLocation()或setLocations()方法指定外部属性文件时，如果对应的文件不存在将抛出异常信息。通过setIgnoreResourceNotFound()方法我们可以设置是否忽略文件未找到的情况，默认为false，即抛出异常信息。如果用户希望忽略对应的错误，则可以设置对应的值为null。

## 13.5 忽略变量不能解析 ##

默认情况下PropertyPlaceholderConfigurer会把bean定义中所有$\{varName\}形式的定义都当做是一个属性变量定义进行替换。当bean定义中存在形式为$\{varName\}的变量定义但是又不能被PropertyPlaceholderConfigurer利用定义的外部属性文件包含的属性或内部属性定义的属性或环境变量进行替换时，其会抛出异常信息。如果希望在对应的属性变量不能被解析时不抛出异常信息，则可以通过setIgnoreUnresolvablePlaceholders()方法指定ignoreUnresolvablePlaceholders的值为true，这样就将忽略变量不能被解析的情况。

（注：本文是基于Spring4.1.0所写）