碼上快樂

相關內容    簡體    繁體

Spring里PropertyPlaceholderConfigurer類的使用

本文轉載自   查看原文   2016-07-15 15:16   20343    Spring/ properties

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&amp;characterEncoding=UTF-8&amp;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大大的方便了我們數據庫的配置。

 

[html]  view plain  copy
 
  1. 只需要在spring的配置文件里添加一句：<context:property-placeholder?location="classpath:jdbc.properties"/>?即可，這里location值為參數配置文件的位置，參數配置文件通常放在src目錄下，而參數配置文件的格式跟java通用的參數配置文件相同，即鍵值對的形式，例如：  
  2.   
  3. #jdbc配置  
  4.   
  5. test.jdbc.driverClassName=com.mysql.jdbc.Driver  
  6. test.jdbc.url=jdbc:mysql://localhost:3306/test  
  7. test.jdbc.username=root  
  8. 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配置文件如下:

[html]  view plain  copy
 
  1. <?xml version="1.0" encoding="UTF-8" ?>  
  2. <beans xmlns="http://www.springframework.org/schema/beans"  
  3.        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
  4.        xmlns:context="http://www.springframework.org/schema/context"  
  5.        xmlns:p="http://www.springframework.org/schema/p"  
  6.        xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.2.xsd  
  7.        http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.2.xsd">  
  8.    <context:property-placeholder location="classpath*:conf/conf_a.properties"/>  
  9.    <bean class="com.xxx.aaa.Bean1"  
  10.           p:driverClassName="${modulea.jdbc.driverClassName}"  
  11.           p:url="${modulea.jdbc.url}"  
  12.           p:username="${modulea.jdbc.username}"  
  13.           p:password="${modulea.jdbc.password}"/>  
  14. </beans>  
conf/conf_a.properties：
[html]  view plain  copy
 
  1. modulea.jdbc.driverClassName=com.mysql.jdbc.Driver  
  2. modulea.jdbc.username=cartan  
  3. modulea.jdbc.password=superman  
  4. modulea.jdbc.url=jdbc:mysql://127.0.0.1:3306/modulea?useUnicode=true&characterEncoding=utf8  


B模塊的Spring配置文件如下:
[html]  view plain  copy
 
  1. <?xml version="1.0" encoding="UTF-8" ?>    
  2. <beans xmlns="http://www.springframework.org/schema/beans"    
  3.        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"    
  4.        xmlns:context="http://www.springframework.org/schema/context"    
  5.        xmlns:p="http://www.springframework.org/schema/p"    
  6.        xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.2.xsd    
  7.        http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.2.xsd">    
  8.    <context:property-placeholder location="classpath*:conf/conf_b.properties"/>    
  9.    <bean class="com.xxx.bbb.Bean1"    
  10.           p:driverClassName="${moduleb.jdbc.driverClassName}"    
  11.           p:url="${moduleb.jdbc.url}"    
  12.           p:username="${moduleb.jdbc.username}"    
  13.           p:password="${moduleb.jdbc.password}"/>    
  14. </beans>    
conf/conf_b.properties：
[html]  view plain  copy
 
  1. moduleb.jdbc.driverClassName=com.mysql.jdbc.Driver  
  2. moduleb.jdbc.username=cartan  
  3. moduleb.jdbc.password=superman  
  4. 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模塊去掉

[html]  view plain  copy
 
  1. <context:property-placeholder location="classpath*:conf/conf_b.properties"/>   

 

然后重新寫個xml：

 

[html]  view plain  copy
 
  1. <?xml version="1.0" encoding="UTF-8" ?>  
  2. <beans xmlns="http://www.springframework.org/schema/beans"  
  3.        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
  4.        xmlns:context="http://www.springframework.org/schema/context"  
  5.        xmlns:p="http://www.springframework.org/schema/p"  
  6.        xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.2.xsd  
  7.        http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.2.xsd">  
  8.    <context:property-placeholder location="classpath*:conf/conf*.properties"/>  
  9.    <import resource="a.xml"/>  
  10.    <import resource="b.xml"/>  
  11. </beans>  

 


免責聲明！

本站轉載的文章為個人學習借鑒使用，本站對版權不負任何法律責任。如果侵犯了您的隱私權益，請聯系本站郵箱yoyou2525@163.com刪除。



猜您在找 spring讀取配置文件PropertyPlaceholderConfigurer類的使用 使用Spring中的PropertyPlaceholderConfigurer讀取文件 Spring 后置處理器 PropertyPlaceholderConfigurer 類（引用外部文件） 使用 Spring Boot 快速構建 Spring 框架應用,PropertyPlaceholderConfigurer Spring的PropertyPlaceholderConfigurer應用 在普通Java類里使用spring里注入的service、dao等 Spring的PropertyPlaceholderConfigurer強制使用默認值的坑 spring中propertyplaceholderconfigurer簡介 Spring的PropertyPlaceholderConfigurer應用 spring源碼分析系列 (5) spring BeanFactoryPostProcessor拓展類PropertyPlaceholderConfigurer、PropertySourcesPlaceholderConfigurer解析
 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM