Spring裏PropertyPlaceholderConfigurer類的使用

1. PropertyPlaceholderConfigurer是個bean工廠後置處理器的實現，也就是 BeanFactoryPostProcessor接口的一個實現。PropertyPlaceholderConfigurer能夠將上下文（配置文 件）中的屬性值放在另外一個單獨的標準java Properties文件中去。在XML文件中用${key}替換指定的properties文件中的值。這樣的話，只須要對properties文件進 行修改，而不用對xml配置文件進行修改。

2.在Spring中，使用PropertyPlaceholderConfigurer能夠在XML配置文件中加入外部屬性文件，固然也能夠指定外部文件的編碼，如：

<bean id="propertyConfigurer"class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">

   <property name="location">

     <value>conf/sqlmap/jdbc.properties</value>

   </property>

    <property name="fileEncoding">

      <value>UTF-8</value>

    </property>

</bean>

 

固然也能夠引入多個屬性文件，如：

<bean id="propertyConfigurer"class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">

  <property name="locations">

   <list>

    <value>/WEB-INF/mail.properties</value>  

    <value>classpath: conf/sqlmap/jdbc.properties</value>//注意這兩種value值的寫法

   </list>

  </property>

</bean>

 

3.譬如，jdbc.properties的內容爲：

jdbc.driverClassName=com.mysql.jdbc.Driver

jdbc.url=jdbc:mysql://localhost/mysqldb?useUnicode=true&characterEncoding=UTF-8&zeroDateTimeBehavior=round;

jdbc.username=root

jdbc.password=123456

 

4.那麼在spring配置文件中，咱們就能夠這樣寫：

<bean id="propertyConfigurer"class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">

  <property name="locations">

   <list>

    <value>classpath: conf/sqlmap/jdbc.properties </value>

   </list>

  </property>

</bean>

<bean id="dataSource"class="org.apache.commons.dbcp.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>

 

5.這樣，一個簡單的數據源就設置完畢了。能夠看出：PropertyPlaceholderConfigurer起的做用就是將佔位符指向的數據庫配置信息放在bean中定義的工具。

6.查看源代碼，能夠發現，locations屬性定義在PropertyPlaceholderConfigurer的祖父類 PropertiesLoaderSupport中，而location只有 setter方法。相似於這樣的配置，在spring的源程序中很常見的。

PropertyPlaceholderConfigurer若是在指定的Properties文件中找不到你想使用的屬性，它還會在Java的System類屬性中查找。

咱們能夠經過System.setProperty(key, value)或者java中經過-Dnamevalue來給Spring配置文件傳遞參數。

 

爲簡化PropertyPlaceholderConfigurer的使用，Spring提供了<context:property-placeholder/>元素。下面給出了配置示例，啓用它後，開發者便不用配置PropertyPlaceholderConfigurer對象了。

1. <context:property-placeholder location="userinfo.properties"/> 

　　PropertyPlaceholderConfigurer內置的功能很是豐富，若是它未找到${xxx}中定義的xxx鍵，它還會去JVM系統屬性（System.getProperty()）和環境變量　　（System.getenv()）中尋找。經過啓用systemPropertiesMode和searchSystemEnvironment屬性，開發者可以控制這一行爲。

這個在spring中配置文件中是很是經常使用的。

context:property-placeholder大大的方便了咱們數據庫的配置。

 

只須要在spring的配置文件裏添加一句：<context:property-placeholder?location="classpath:jdbc.properties"/>?便可，這裏location值爲參數配置文件的位置，參數配置文件一般放在src目錄下，而參數配置文件的格式跟java通用的參數配置文件相同，即鍵值對的形式，例如：

#jdbc配置

test.jdbc.driverClassName=com.mysql.jdbc.Driver
test.jdbc.url=jdbc:mysql://localhost:3306/test
test.jdbc.username=root
test.jdbc.password=root

這樣一來就能夠爲spring配置的bean的屬性設置值了，好比spring有一個jdbc數據源的類DriverManagerDataSource

 

在配置文件裏這麼定義bean：

<bean id="testDataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource">
<property name="driverClassName" value="${test.jdbc.driverClassName}"/>
<property name="url" value="${test.jdbc.url}"/>
<property name="username" value="${test.jdbc.username}"/>
<property name="password" value="${test.jdbc.password}"/>
</bean>

這樣修改起來也方便，也統一的這個規範。

 

另外須要注意的是，若是遇到下面着着這種問題：

A模塊和B模塊都分別擁有本身的Spring XML配置，並分別擁有本身的配置文件：

A模塊的Spring配置文件以下:

<?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:context="http://www.springframework.org/schema/context"
       xmlns:p="http://www.springframework.org/schema/p"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.2.xsd
       http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.2.xsd">
   <context:property-placeholder location="classpath*:conf/conf_a.properties"/>
   <bean class="com.xxx.aaa.Bean1"
          p:driverClassName="${modulea.jdbc.driverClassName}"
          p:url="${modulea.jdbc.url}"
          p:username="${modulea.jdbc.username}"
          p:password="${modulea.jdbc.password}"/>
</beans>

conf/conf_a.properties：

modulea.jdbc.driverClassName=com.mysql.jdbc.Driver
modulea.jdbc.username=cartan
modulea.jdbc.password=superman
modulea.jdbc.url=jdbc:mysql://127.0.0.1:3306/modulea?useUnicode=true&characterEncoding=utf8

B模塊的Spring配置文件以下:

<?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:context="http://www.springframework.org/schema/context"
       xmlns:p="http://www.springframework.org/schema/p"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.2.xsd
       http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.2.xsd">
   <context:property-placeholder location="classpath*:conf/conf_b.properties"/>
   <bean class="com.xxx.bbb.Bean1"
          p:driverClassName="${moduleb.jdbc.driverClassName}"
          p:url="${moduleb.jdbc.url}"
          p:username="${moduleb.jdbc.username}"
          p:password="${moduleb.jdbc.password}"/>
</beans>

conf/conf_b.properties：

moduleb.jdbc.driverClassName=com.mysql.jdbc.Driver
moduleb.jdbc.username=cartan
moduleb.jdbc.password=superman
moduleb.jdbc.url=jdbc:mysql://127.0.0.1:3306/modulea?useUnicode=true&characterEncoding=utf8

單獨運行A模塊，或單獨運行B模塊都是正常的，但將A和B兩個模塊集成後運行，Spring容器就啓動不了了：
Could not resolve placeholder 'moduleb.jdbc.driverClassName' in string value "${moduleb.jdbc.driverClassName}"
緣由：Spring容器採用反射掃描的發現機制，在探測到Spring容器中有一個org.springframework.beans.factory.config.PropertyPlaceholderConfigurer的Bean就會中止對剩餘PropertyPlaceholderConfigurer的掃描

spring容器中最多隻能定義一個context:property-placeholder，否則就出現那種個錯誤，那如何來解決上面的問題呢？

 

A和B模塊去掉

<context:property-placeholder location="classpath*:conf/conf_b.properties"/>

 

而後從新寫個xml：

 

<?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:context="http://www.springframework.org/schema/context"
       xmlns:p="http://www.springframework.org/schema/p"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.2.xsd
       http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.2.xsd">
   <context:property-placeholder location="classpath*:conf/conf*.properties"/>
   <import resource="a.xml"/>
   <import resource="b.xml"/>
</beans>