Spring类PropertyPlaceholderConfigurer的作用（较全）

最新推荐文章于 2023-03-19 23:23:05 发布
最新推荐文章于 2023-03-19 23:23:05 发布
阅读量509 收藏
点赞数

一、PropertyPlaceholderConfigurer作用

要了解这个类首先要弄清楚一个概念：bean factory post-processor
官方解释是这样的：
A bean factory post-processor is a Java class which implements the
org.springframework.beans.factory.config.BeanFactoryPostProcessor interface. It is executed manually  (in the case of the BeanFactory) or automatically (in the case of the ApplicationContext) to apply changes of some sort to an entire BeanFactory, after it has been constructed.
我理解的意思是这样的:
1.首先bean factory post-processor实现了org.springframework.beans.factory.config.BeanFactoryPostProcessor接口。
2.在BeanFactory的情况下它被手动的执行。
3.在ApplicationContext的条件下它会自动的执行。
4.最关键的一点是，是在一个类的实例被构造出来之后，对整个BeanFactory进行修改。
     那么PropertyPlaceholderConfigurer类就是bean factory post-processor的一种，它的作用是一个资源属性的配置器，能够将BeanFactory的里定义的内容放在一个以.propertis后缀的文件中。PropertyPlaceholderConfigurer是个bean工厂后置处理器的实现，也就是 BeanFactoryPostProcessor接口的一个实现。PropertyPlaceholderConfigurer可以将上下文（配置文 件）中的属性值放在另一个单独的标准Java Properties文件中去。在XML文件中用${key}替换指定的properties文件中的值。这样的话，只需要对properties文件进 行修改，而不用对xml配置文件进行修改。

二、PropertyPlaceholderConfigurer配置

例如使用如下：
<bean id="dataSource"
  class="org.logicalcobwebs.proxool.ProxoolDataSource"
  destroy-method="close">
  <property name="driver">
   <value>${jdbc.driver}</value>
  </property>
  <property name="driverUrl">
   <value>${jdbc.driverUrl}</value>
  </property>

  <property name="user">
   <value>${jdbc.username}</value>
  </property>
  <property name="password">
   <value>${jdbc.password}</value>
  </property>

  <property name="alias">
   <value>${proxool.alias}</value>
  </property>
  <property name="prototypeCount">
   <value>${proxool.prototypeCount}</value>
  </property>
  <property name="maximumConnectionCount">
   <value>${proxool.maximumConnectionCount}</value>
  </property>
  <property name="minimumConnectionCount">
   <value>${proxool.minimumConnectionCount}</value>
  </property>
  <property name="simultaneousBuildThrottle">
   <value>${proxool.simultaneousBuildThrottle}</value>
  </property>
  <property name="trace">
   <value>${proxool.trace}</value>
  </property>
  <property name="verbose">
   <value>${proxool.verbose}</value>
  </property>
  <property name="houseKeepingTestSql">
   <value>${proxool.houseKeepingTestSql}</value>
  </property>
 </bean>

而实际的jdbc.propertis文件是
#jdbc settings
jdbc.url=jdbc:Oracle:thin:@localhost:1521:orcl10g
jdbc.username=user
jdbc.password=name
jdbc.driver=oracle.jdbc.driver.OracleDriver

#hibernate settings
hibernate.show_sql=false
#hibernate.format_sql=false
#hibernate.ehcache_config_file=/ehcache/ehcache-hibernate-local.xml

#pool parameters
initialPoolSize=2
maxPoolSize=10
#maxIdleTime=10
#idleConnectionTestPeriod=5
autoCommitOnClose=true
而jdbc.propertis是怎样引用的呢：
－－－applicationContext.xml－－－－
<bean
  class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
  <property name="systemPropertiesModeName"
   value="SYSTEM_PROPERTIES_MODE_OVERRIDE" />
  <property name="ignoreResourceNotFound" value="true" />
  <property name="locations">
   <list>
    <value>classpath*:/jdbc.properties</value>
   </list>
  </property>
 </bean>
将上边一段配置注册在web.xml中就可以了
<context-param>
  <param-name>contextConfigLocation</param-name>
  <param-value>
   classpath*:configs/**/applicationContext-*.xml,classpath*:com/**/applicationContext-*.xml
  </param-value>
 </context-param>
当然，不要忘了spring的监听器注册
<listener>
<listener-class>
org.springframework.web.context.ContextLoaderListener
</listener-class>
</listener>
这样，一个简单的数据源就设置完毕了。实际上，PropertyPlaceholderConfigurer起的作用就是将占位符指向的数据库配置信息放在bean中定义的工具。

三、PropertyPlaceholderConfigurer的高级属性

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配置文件传递参数。


四、spring属性占位符

在bean定义时设置bean属性的值时，除了设置固定的值，还可以通过EL表达式和占位符来设置，容器在解析bean定义时会对EL表达式和占位符进行解析求值。本篇来学习一下通过占位符定义属性的用法。

占位符的取值范围有三个：系统变量（System.getProperty）、坏境变量（System.getEnv）、自定义的Properties文件。

Spring提供了三种方式来配置加载自定义的properties：

1、PropertyPlaceholderConfigurer

一个BFPP，通过location属性把properties文件的路径传入，并且可以设置系统变量加载模式，有三种：0、不检查系统属性；1、优先加载自定义属性，加载不到时加载系统属性；2、优先加载系统属性，加载不到时再加载自定义属性。通过systemPropertiesMode设置加载模式。占位符的前后缀默认是${和}，但是可以通过设置placeholderPrefix和placeholderSuffix来修改前后缀。PropertyPlaceholderConfigurer的用法如下：

bean定义xml：

[java]  view plain  copy
  1. <bean  
  2.     class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">  
  3.     <property name="location">  
  4.         <value>classpath:spring/beans/placeholder/attr.properties</value>  
  5.     </property>  
  6.     <property name="placeholderPrefix" value="${"></property>  
  7.     <property name="placeholderSuffix" value="}"></property>  
  8. </bean>  
  9. <bean id="placeHolderBean" class="spring.beans.placeholder.PlaceHolderBean">  
  10.     <property name="id" value="${placeholder.id}"></property>  
  11.     <property name="name" value="${placeholder.name}"></property>  
  12.     <property name="refBean" ref="${placeholder.ref}"></property>  
  13. </bean>  
  14. <bean id="refedBean" class="spring.beans.placeholder.RefedBean"></bean>  
[java]  view plain  copy
  在CODE上查看代码片 派生到我的代码片
  1. <bean  
  2.     class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">  
  3.     <property name="location">  
  4.         <value>classpath:spring/beans/placeholder/attr.properties</value>  
  5.     </property>  
  6.     <property name="placeholderPrefix" value="${"></property>  
  7.     <property name="placeholderSuffix" value="}"></property>  
  8. </bean>  
  9. <bean id="placeHolderBean" class="spring.beans.placeholder.PlaceHolderBean">  
  10.     <property name="id" value="${placeholder.id}"></property>  
  11.     <property name="name" value="${placeholder.name}"></property>  
  12.     <property name="refBean" ref="${placeholder.ref}"></property>  
  13. </bean>  
  14. <bean id="refedBean" class="spring.beans.placeholder.RefedBean"></bean>  

自定义属性文件attr.properties：

[java]  view plain  copy
  1. placeholder.id = 123  
  2. placeholder.name = cyy  
  3. placeholder.ref = refedBean  
[java]  view plain  copy
  在CODE上查看代码片 派生到我的代码片
  1. placeholder.id = 123  
  2. placeholder.name = cyy  
  3. placeholder.ref = refedBean  

2、PropertySourcesPlaceholderConfigurer

和PropertyPlaceholderConfigurer类似，但是它不能设置系统属性加载模式，而是通过localOverride属性来决定是否用自定义的属性来覆盖系统属性。

3、context:property-placeholder标签

spring设计了context:property-placeholder标签来简化配置，它的原理跟上面两种方式是一样的，通过location属性设置属性文件路径，如有多个用逗号分隔。容器通过PropertyPlaceholderBeanDefinitionParser解析该标签，在解析时会把这个标签解析成PropertyPlaceholderConfigurer或PropertySourcesPlaceholderConfigurer，当system-properties-mode设置为ENVIRONMENT系统变量优先时使用PropertySourcesPlaceholderConfigurer，否则使用PropertyPlaceholderConfigurer，下面是这个标签的用法：

[java]  view plain  copy
  1. <context:property-placeholder  
  2.     location="classpath:spring/beans/placeholder/attr.properties" />  
  3. <bean id="placeHolderBean" class="spring.beans.placeholder.PlaceHolderBean">  
  4.     <property name="id" value="${placeholder.id}"></property>  
  5.     <property name="name" value="${placeholder.name}"></property>  
  6.     <property name="refBean" ref="${placeholder.ref}"></property>  
  7. </bean>  
  8. <bean id="refedBean" class="spring.beans.placeholder.RefedBean"></bean>  
[java]  view plain  copy
  在CODE上查看代码片 派生到我的代码片
  1. <context:property-placeholder  
  2.     location="classpath:spring/beans/placeholder/attr.properties" />  
  3. <bean id="placeHolderBean" class="spring.beans.placeholder.PlaceHolderBean">  
  4.     <property name="id" value="${placeholder.id}"></property>  
  5.     <property name="name" value="${placeholder.name}"></property>  
  6.     <property name="refBean" ref="${placeholder.ref}"></property>  
  7. </bean>  
  8. <bean id="refedBean" class="spring.beans.placeholder.RefedBean"></bean>  

属性配置器在加载完自定义属性之后会创建一个字符值处理器StringValueResolver，并且把加载到的属性设置到这个处理器中，遍历当前容器中所有的bean定义，使用这个处理来处理属性中未处理的占位符以及别名中的占位符，并且把该处理添加到容器中，为后面的bean解析提供占位符处理，见PlaceholderConfigurerSupport类中doProcessProperties方法的代码：

[java]  view plain  copy
  1. protected void doProcessProperties(ConfigurableListableBeanFactory beanFactoryToProcess,  
  2.         StringValueResolver valueResolver) {  
  3.   
  4.     BeanDefinitionVisitor visitor = new BeanDefinitionVisitor(valueResolver);  
  5.   
  6.     String[] beanNames = beanFactoryToProcess.getBeanDefinitionNames();  
  7.     for (String curName : beanNames) {  
  8.         // Check that we're not parsing our own bean definition,  
  9.         // to avoid failing on unresolvable placeholders in properties file locations.  
  10.         if (!(curName.equals(this.beanName) && beanFactoryToProcess.equals(this.beanFactory))) {  
  11.             BeanDefinition bd = beanFactoryToProcess.getBeanDefinition(curName);  
  12.             try {  
  13.                 visitor.visitBeanDefinition(bd);  
  14.             }  
  15.             catch (Exception ex) {  
  16.                 throw new BeanDefinitionStoreException(bd.getResourceDescription(), curName, ex.getMessage(), ex);  
  17.             }  
  18.         }  
  19.     }  
  20.   
  21.     // New in Spring 2.5: resolve placeholders in alias target names and aliases as well.  
  22.     beanFactoryToProcess.resolveAliases(valueResolver);  
  23.   
  24.     // New in Spring 3.0: resolve placeholders in embedded values such as annotation attributes.  
  25.     beanFactoryToProcess.addEmbeddedValueResolver(valueResolver);  
  26. }  
[java]  view plain  copy
  在CODE上查看代码片 派生到我的代码片
  1. protected void doProcessProperties(ConfigurableListableBeanFactory beanFactoryToProcess,  
  2.         StringValueResolver valueResolver) {  
  3.   
  4.     BeanDefinitionVisitor visitor = new BeanDefinitionVisitor(valueResolver);  
  5.   
  6.     String[] beanNames = beanFactoryToProcess.getBeanDefinitionNames();  
  7.     for (String curName : beanNames) {  
  8.         // Check that we're not parsing our own bean definition,  
  9.         // to avoid failing on unresolvable placeholders in properties file locations.  
  10.         if (!(curName.equals(this.beanName) && beanFactoryToProcess.equals(this.beanFactory))) {  
  11.             BeanDefinition bd = beanFactoryToProcess.getBeanDefinition(curName);  
  12.             try {  
  13.                 visitor.visitBeanDefinition(bd);  
  14.             }  
  15.             catch (Exception ex) {  
  16.                 throw new BeanDefinitionStoreException(bd.getResourceDescription(), curName, ex.getMessage(), ex);  
  17.             }  
  18.         }  
  19.     }  
  20.   
  21.     // New in Spring 2.5: resolve placeholders in alias target names and aliases as well.  
  22.     beanFactoryToProcess.resolveAliases(valueResolver);  
  23.   
  24.     // New in Spring 3.0: resolve placeholders in embedded values such as annotation attributes.  
  25.     beanFactoryToProcess.addEmbeddedValueResolver(valueResolver);  
  26. }  

转载请注明出处http://blog.csdn.net/honghailiang888
MauveDragon
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Spring如何使用PropertyPlaceholderConfigurer读取文件
08-25
主要介绍了Spring如何使用PropertyPlaceholderConfigurer读取文件,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
Spring类PropertyPlaceholderConfigurer的作用
honghailiang的专栏
07-11 1万+
一、PropertyPlaceholderConfigurer作用 要了解这个类首先要弄清楚一个概念：bean factory post-processor 官方解释是这样的： A bean factory post-processor is a java class which implements the org.springframework.beans.factory.co
Spring PropertyPlaceholderConfigurer 用法
MayMatrix 的博客
04-10 1178
PropertyPlaceholderConfigurer 用法一、PropertyPlaceholderConfigurer 的继承体系二、PropertyPlaceholderConfigurer 的基本概念三、PropertyPlaceholderConfigurer 的基本使用PropertyPlaceholderConfigurer 引入外部属性文件PropertyPlaceholder...
Spring 工具类 : PropertySourcesPlaceholderConfigurer
Details Inside Spring
06-18 9943
概述 介绍 PropertySourcesPlaceholderConfigurer是PlaceholderConfigurerSupport的特殊化实现。它用于解析bean定义中的属性值，以及注解@Value的值，使用的属性来源是当前的Spring Environment对象，以及设置给自己的PropertySources对象。 在Spring Context 3.1 XSD或者更高版本中，缺省...
PropertyPlaceholderConfigurer 基本用法
qq_32907491的博客
03-19 535
自定义一个SubPropertyPlaceholderConfigurer 继承自PropertyPlaceholderConfigurer@Override// 调用父类PropertyPlaceholderConfigurer 的构造器// 遍历配置文件的key，Properties 对象就是导入的配置文件需要引入这个自定义的SubPropertyPlaceholderConfigurer如何启动呢？
PropertyPlaceholderConfigurer类的使用注意
836811384
09-10 105
如果你在spring的applicationcontext.xml中需要使用属性配置文件，那PropertyPlaceholderConfigurer这个类就是必须的。 &lt;bean class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer"&gt;&lt;property name="loca...
Spring中PropertyPlaceholderConfigurer的使用
10-15
Spring中PropertyPlaceholderConfigurer的使用
Spring属性占位符PropertyPlaceholderConfigurer的使用
08-07
Spring属性占位符PropertyPlaceholderConfigurer的使用,自己写的一个demo
Spring PropertyPlaceholderConfigurer配置文件加载器集成ZooKeeper来实现远程配置读取
08-10
NULL 博文链接：https://wokeke.iteye.com/blog/2214113
spring.net中文手册在线版
11-28
4.9.1.PropertyPlaceholderConfigurer类 4.9.1.1.使用环境变量进行替换 4.9.2.PropertyOverrideConfigurer类 4.10.使用alias节点为对象添加别名 4.11.IApplicationContext简介 4.12.配置应用程序上下文 4.12.1.注册...
Spring加载properties配置文件使用PropertyPlaceholderConfigurer还是使用PropertySourcesPlaceholderConfigurer
p7+的博客
04-17 4105
多模块的项目中，不建议直接在@Value中初始化默认值，各个模块的properties配置文件建议使用PropertyPlaceholderConfigurer加载，或者在主模块中定义一个PropertySourcesPlaceholderConfigurer，加载你需要的所有模块中的properties属性。 使用PropertyPlaceholderConfigurer配置： 主模块引入先...
Spring PropertySourcesPlaceholderConfigurer工作原理
weixin_34275734的博客
01-06 273
2019独角兽企业重金招聘Python工程师标准>>> ...
Spring里PropertyPlaceholderConfigurer类的使用
孤云博客
07-13 1362
随时随地阅读更多技术实战干货，获取项目源码、学习资料，请关注源代码社区公众号(ydmsq666)、博主微信（guyun297890152）、QQ技术交流群(183198395)。 from：https://www.cnblogs.com/huqianliang/p/5673701.html 1. PropertyPlaceholderConfigurer是个bean工厂后置处理器的实现，也...
PropertyPlaceholderConfigurer读取属性文件使用详解
热门推荐
王如霜
12-03 3万+
是什么 PropertyPlaceholderConfigurer是个bean工厂后置处理器的实现，也就是 BeanFactoryPostProcessor接口的一个实现。 作用 在Spring中，使用PropertyPlaceholderConfigurer可以在XML配置文件中加入外部属性文件，当然也可以指定外部文件的编码 PropertyPlaceholderConfigurer可以将上下文...
自定义PropertyPlaceholderConfigurer不起作用
我惠依旧的博客
07-24 3050
本着配置文件中能看到明文的用户名和密码，于是百度了一下： 加密jdbc配置文件中的用户名密码 前面配置基本一致，直接跳到自定义PropertyPlaceholderConfigurer即可，在xml中加入了一下： &lt;bean class="com.utils.jdbc.ConvertPwdPropertyConfigurer"&gt; &lt;property nam...
spring+mybatis使用MapperScannerConfigurer引起的PropertyPlaceholderConfigurer无效问题
xiaobao5214的博客
08-05 3490
spring里使用org.mybatis.spring.mapper.MapperScannerConfigurer 进行自动扫描的时候，设置了sqlSessionFactory 的话，可能会导致PropertyPlaceholderConfigurer失效，也就是用${jdbc.username}这样之类的表达式，将无法获取到properties文件里的内容。 导致这一原因是因为，MapperS
spring的PropertyPlaceholderConfigurer不生效的问题
weixin_30485799的博客
03-09 1236
经常出现这种问题，每次都debug知道原因，但每次都会忘记，所以记录一下。 原因：maven项目中使用了非maven管理的jar包（通过systemPath引用），这些jar包没有放在${project.basedir}/src/main/webapp/WEB-INF/lib下，所以打war包时没有把本地jar包挪到/WEB-INF/lib中，缺少这些jar就会导致PropertyPla...
PropertyPlaceholderConfigurer 无效的问题
weixin_34337265的博客
12-08 2523
2019独角兽企业重金招聘Python工程师标准>>> ...
PropertyPlaceholderConfigurer读取配置改造SpringBoot集成apollo, 读取不到配置
m0_37772518的博客
09-12 6299
问题描述: Maven多模块开发, SSM框架改造成SpringBoot框架, 集成apollo时,读取不到apollo的配置. 因为是自己封装了PropertyPlaceholderConfigurer进行配置文件的读取: /** *获取到当前架包中资源文件夹下的Properties配置文件 */ public class PropertyConfigurer extends Prop...
spring boot PropertyPlaceholderConfigurer 获取配置项
最新发布
05-31
在Spring Boot中，可以通过@Value注解来获取配置项的值。@Value注解可以将属性值注入到Spring的Bean中，从而在代码中使用。例如，假设我们有一个名为"my.property"的配置项，可以在Spring Boot的配置类中按照以下方式使用@Value注解来获取其值： ```java @Value("${my.property}") private String myProperty; ``` 在这个例子中，${my.property}是属性占位符，它将被PropertyPlaceholderConfigurer自动替换为实际的值。@Value注解将这个值注入到myProperty字段中，从而可以在代码中使用它。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值