Spring（14）——PropertyOverrideConfigurer

14 PropertyOverrideConfigurer

14.1 简介

打个比方我们在bean容器中定义了一个beanA，其中有一个属性propB，对应值为valueB，但是我又希望在不更改bean定义的情况下希望Spring在实例化beanA时将对应的属性propB的值改为valueC，那么这个时候我们就可以使用PropertyOverrideConfigurer来实现这个效果了。PropertyOverrideConfigurer实现了BeanFactoryPostProcessor接口，其将在Spring加载完对应容器中所有的bean定义之后根据定义的属性来覆盖bean定义中既有属性的值。

来看一个示例，假设我们有如下定义的一个类Hello，其拥有一个int型的属性maxVal。

public class Hello {
	
	private int maxVal;

	public int getMaxVal() {
		return maxVal;
	}

	public void setMaxVal(int maxVal) {
		this.maxVal = maxVal;
	}
	
}

在我们的bean定义中定义了一个Hello类型的bean，并指定了其属性maxVal的值为1。

	<bean id="hello" class="com.app.Hello" p:maxVal="1"/>

那么这个时候我们在当前bean容器中定义一个PropertyOverrideConfigurer类型的bean，形式如下。

	<bean class="org.springframework.beans.factory.config.PropertyOverrideConfigurer">
		<property name="location" value="classpath:overrideConfig.properties"/>
	</bean>

我们可以看到，其通过setLocation()方法注入了一个Resource，对应类路径下的overrideConfig.properties。接着来看一下该文件的内容。

hello.maxVal=10

该文件就简单的定义了一行，即一个属性。PropertyOverrideConfigurer在拿到了该属性后将在容器中所有的bean定义加载完成后，在容器中寻找id或name为hello的bean，然后将其属性maxVal的值置为10。对应的值将在实例化该bean时通过setMaxVal()方法进行赋值。这就是PropertyOverrideConfigurer干的事。其所使用的属性文件中属性名的定义形式是“beanName.prop1[.prop2[…]]”，即属性名称至少由两部分组成，第一部分是目标bean的名称，第二部分是目标bean的属性，或属性的属性，它们之间以点进行连接。如“beanA.prop1.prop2=5”即表示设置beanA的prop1的prop2为5，对应语义为beanA.getProp1().setProp2(5)。

PropertyOverrideConfigurer只能用来替换文本类型的属性，像需要覆盖一个bean所关联的另一个bean这种需求就是不行，如果真有这种需求则推荐将其定义为一个属性变量，然后通过PropertyPlaceholderConfigurer进行替换。

14.2 加载属性的方式

PropertyOverrideConfigurer能够用来作为属性值覆盖的属性定义可以有多种形式，可以使用外部定义的属性文件，也可以使用PropertyOverrideConfigurer内部持有的属性定义。

14.2.1 外部文件

我们可以通过PropertyOverrideConfigurer的setLocation()方法和setLocations()方法来指定当前PropertyOverrideConfigurer需要使用的外部属性文件定义。其中setLocation()方法将用来指定单个文件，而setLocations()方法则可以用来指定一到多个文件。

	<bean class="org.springframework.beans.factory.config.PropertyOverrideConfigurer">
		<!-- 通过setLocations()方法指定需要使用的外部属性文件定义 -->
		<property name="locations">
			<array>
				<value>classpath:overrideConfig.properties</value>
				<value>classpath:overrideConfig2.properties</value>
			</array>
		</property>
	</bean>

14.2.2 内部定义

通过PropertyOverrideConfigurer的setProperties()和setPropertiesArray()方法我们可以定义其使用的内部属性定义。其中setProperties()方法接收单个Properties对象，而setPropertiesArray()方法接收一到多个Properties对象。

	<bean class="org.springframework.beans.factory.config.PropertyOverrideConfigurer">
		<!-- 定义内部localProperties定义 -->
		<property name="propertiesArray">
			<array>
				<ref bean="overrideConfig1"/>
			</array>
		</property>
	</bean>
	<!-- 定义Properties类型的bean -->
	<bean id="overrideConfig1" class="java.util.Properties">
		<constructor-arg>
			<props>
				<prop key="hello.maxVal">10</prop>
			</props>
		</constructor-arg>
	</bean>

14.2.3 优先级

当一个PropertyOverrideConfigurer既指定了外部属性文件定义，又指定了内部属性定义时，如果某一个属性在外部属性文件和内部属性定义中同时存在，默认情况下外部属性文件定义的属性将覆盖内部属性定义。即如果外部属性文件定义指定了beanA.propB=1，而内部属性定义指定了beanA.propB=2，则最终使用的属性定义将是外部属性文件定义的beanA.propB=1。如果希望最终使用的是内部属性定义，即beanA.propB=2，则我们可以通过PropertyOverrideConfigurer的setLocalOverride()方法指定localOverride的值为true，即存在相同属性定义时内部属性定义将覆盖外部属性文件的定义。

	<bean class="org.springframework.beans.factory.config.PropertyOverrideConfigurer">
		<!-- 通过setLocation()方法指定需要使用的外部属性文件定义 -->
		<property name="location" value="classpath:overrideConfig.properties"/>
		<!-- 定义内部properties定义 -->
		<property name="properties">
			<props>
				<prop key="hello.maxVal">50</prop>
			</props>
		</property>
		<!-- 指定内部属性定义将覆盖外部属性文件定义的相同属性 -->
		<property name="localOverride" value="true"/>
	</bean>

14.3 指定beanName与属性之间的分隔符

beanName与属性之间的分隔符默认是点“.”。用户可以通过PropertyOverrideConfigurer的setBeanNameSeparator()方法来指定新的分隔符。

	<bean class="org.springframework.beans.factory.config.PropertyOverrideConfigurer">
		<!-- 定义内部properties定义 -->
		<property name="properties">
			<props>
				<prop key="hello$maxVal">50</prop>
				<prop key="hello$world.id">100</prop>
			</props>
		</property>
		<!-- 指定beanName与属性之间的分隔符为$ -->
		<property name="beanNameSeparator" value="$"/>
	</bean>

如上所示，我们指定了beanName和属性之间的分隔符为“$”，所以当我们需要覆盖beanName为hello的maxVal的值时应该定义hello$maxVal=50。但是属性的属性之间还是以点进行分隔，如上述示例中的hello$world.id=100。

14.4 忽略文件未找到

默认情况下我们定义的外部属性文件不存在时将会抛出异常信息，如果用户不希望抛出异常信息，则可以通过setIgnoreResourceNotFound(true)方法设置忽略文件未找到的情况。

	<bean class="org.springframework.beans.factory.config.PropertyOverrideConfigurer">
		<!-- 忽略外部属性文件不存在的异常信息 -->
		<property name="ignoreResourceNotFound" value="true"/>
		<!-- 该文件不存在，但是由于ignoreResourceNotFound设置为true将不会抛出异常 -->
		<property name="location" value="afsf"/>
	</bean>

14.5 忽略不存在的属性

默认情况下PropertyOverrideConfigurer使用的所有外部属性文件或内部属性定义的属性都将用来寻找对应的bean和属性进行属性值的覆盖。当存在非beanName.property形式的属性定义或定义的bean或属性不存在时将抛出异常。如果用户不希望此种情况抛出异常，则可以通过setIgnoreInvalidKeys()方法设置ignoreInvalidKeys属性值为true，已达到忽略不存在的属性的效果。

	<bean class="org.springframework.beans.factory.config.PropertyOverrideConfigurer">
		<!-- 忽略无效的属性定义，包括不存在的bean或属性等 -->
		<property name="ignoreInvalidKeys" value="false"/>
		<property name="properties">
			<props>
				<prop key="abc">1</prop>
				<prop key="abc.adcdf">2</prop>
			</props>
		</property>
	</bean>

14.6 指定加载顺序

我们可以在一个bean容器中同时定义多个PropertyOverrideConfigurer，这时候可以通过其setOrder()方法指定当前PropertyOverrideConfigurer的处理顺序，对应值越小的越先处理。当多个PropertyOverrideConfigurer需要覆盖同一个bean的同一个属性时将取最后进行覆盖的那个PropertyOverrideConfigurer覆盖的值。

	<bean class="org.springframework.beans.factory.config.PropertyOverrideConfigurer">
		<!-- 指定处理顺序 -->
		<property name="order" value="1"/>
	</bean>
	<bean class="org.springframework.beans.factory.config.PropertyOverrideConfigurer">
		<!-- 指定处理顺序 -->
		<property name="order" value="2"/>
	</bean>

14.7 使用命名空间进行定义

PropertyOverrideConfigurer也支持在Spring的配置文件中通过引入对应的命名空间后使用对应的标签进行定义。如果需要使用命名空间定义，我们首先需要在Spring配置文件中引入context对应的命名空间，然后在其中定义一个property-override标签，这样Spring将自动创建一个PropertyOverrideConfigurer类型的bean定义。

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:p="http://www.springframework.org/schema/p"
	xmlns:context="http://www.springframework.org/schema/context"
	xsi:schemaLocation="http://www.springframework.org/schema/beans
		http://www.springframework.org/schema/beans/spring-beans.xsd
		http://www.springframework.org/schema/context
        http://www.springframework.org/schema/context/spring-context.xsd">

	<context:property-override/>

</beans>

然后我们可以通过property-override标签的属性来指定对应的参数。主要的可选参数如下。

• location：用于指定需要使用的外部资源文件的路径。多个文件路径之间使用逗号进行分隔。
• properties-ref：用于指定需要使用的内部属性定义对应的bean的名称。
• ignore-unresolvable：用于指定是否忽略不能解析的属性，默认为false。
• ignore-resource-not-found：用于指定是否忽略location指定路径的文件不存在的情况，默认为false。
• order：用于在定义当前PropertyOverrideConfigurer的处理顺序。

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