Spring容器扩展--PropertyPlaceholderConfigurer

最新推荐文章于 2025-12-12 15:33:17 发布

转载最新推荐文章于 2025-12-12 15:33:17 发布 · 818 阅读

文章标签：

#spring #扩展 #properties #string #bean #class

struts2+spring+ibatis 专栏收录该内容

2 篇文章

订阅专栏

本文详细介绍了如何使用Spring框架中的PropertyPlaceholderConfigurer类动态地从配置文件读取属性并注入到bean中，特别关注了对于经常变动属性的管理方式，提供了实践示例以帮助理解其工作原理。

要了解这个类首先要弄清楚一个概念：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工厂后置处理器的实现，也就是BeanFactoryPostProcessor接口的一个实现。关于BeanFactoryPostProcessor和BeanPostProcessor类似。

PropertyPlaceholderConfigurer可以将上下文（配置文件）中的属性值放在另一个单独的标准java Properties文件中去。这样的话，我只需要对properties文件进行修改，而不用对xml配置文件进行修改。

作用是什么呢？

有一些属性值不需要经常变更，但是有一些属性值可能随时改变，把经常会改动的属性值放在另一个文件中的话，程序使用起来也更方便。

下面将通过一个例子来理解PropertyPlaceholderConfigurer。
首先是配置文件，代码如下：

<?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:util="http://www.springframework.org/schema/util"
xsi:schemaLocation="
  http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.0.xsd
  http://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util-2.0.xsd">

<bean class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
      <property name="location" value="propertyPlaceHolder.properties"/>
    </bean>
    <bean id ="student" class="co.jp.beanFactoryPost.Student">
     <property name="name">
      <value>${name}</value>
     </property>
     <property name="age">
      <value>${age}</value>
     </property>
     <property name="birth">
      <value>${birth}</value>
     </property>
    </bean>
</beans>

在这个配置文件中最重要的就是下面这段代码，

<bean class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
      <property name="location" value="propertyPlaceHolder.properties"/>
</bean>

PropertyPlaceholderConfigurer会读取location所设定的属性文件，并将properties文件中的值，设定给${name}，${age}，${birth}从而完成依赖注入。

相应的properties文件的定义如下：

name=xiaohailin
age=27
birth=19820123

这里用到的student bean,的class的代码如下：

比较简单，主要是一个get,set方法

package co.jp.beanFactoryPost;

public class Student {
    private String name;
    private String age;
    private String birth;
    public void setName(String name)
    {
        this.name = name;
    }
    public void setAge(String age)
    {
        this.age = age;
    }
    public void setBirth(String birth)
    {
        this.birth = birth;
    }
    public String getName()
    {
        return this.name;
    }
    public String getAge()
    {
        return this.age;
    }
    public String getBirth()
    {
        return this.birth;
    }
}

接着，写一个测试的主类，代码如下：

public class PropertyHolderPlaceDemo {


    public static void main(String[] args) {

        ApplicationContext ctx = new ClassPathXmlApplicationContext("propertyPlaceHolder.xml");

        Student student = (Student) ctx.getBean("student");
        System.out.println(student.getAge());
        System.out.println(student.getBirth());
        System.out.println(student.getName());
    }
}

配置参数参考：

通常使用PropertyPlaceholderConfigurer 定位一个properties文件读取一些配置变量的值来配置其他的beans。
如果properties放在classpath下，可以通过这样访问：

<bean id="propertyConfigurer" class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
        <property name="locations">
            <list>
                <value>classpath*:jdbc.properties</value>
            </list>
        </property>
</bean>

如果是一个文件，value可以是file:c:/jdbc.properties

还有其他的参考spring参考手册4.4节

‍