spring配置中context:property-placeholder的使用说明

本文介绍Spring框架中如何使用<context:property-placeholder>和PropertyPlaceholderConfigurer进行外部属性文件配置,实现不同环境下的参数配置切换,并展示了如何在Java类中通过@Value注解自动注入属性。
1,有些参数在某些阶段中是常量。

在开发阶段我们连接数据库时的url,username,password等信息
分布式应用中client端的server地址,端口等
2,这些参数在不同阶段之间又住住需要改变

期望:有一种方案可以方便我们在一个阶段内不需要频繁写一个参数的值,而在不同阶段间又可以方便的切换参数的配置信息 
解决:spring3中提供了一种简便的方式就是 <content:property-placeholder>元素 
只需要在spring配置文件中添加一句:

<context:property-placeholder location="classpath:jdbc.properties"/>
1
或者

<bean id="propertyPlaceholderConfigurer" class="org.springframework,beans.factory.config.PropertyPlaceholderConfigurer">
    <property name="locations">
        <list>
            <value>jdbc.properties<value/>
        </list>
    </property>
</bean>


即可,这里的location值为参数配置文件的位置,配置文件通常放到src目录下,参数配置文件的格式即键值对的形式,

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

行内#号后面部分为注释

这样一来就可以为spring配置的bean的属性设置值了,比如spring有一个数据源的类

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

甚至可以将 ${} 这种形式的变量用在spring提供的注解当中,为注解的属性提供值(下面会讲到)

Spring容器采用反射扫描的发现机制,在探测到Spring容器中有一个 org.springframework.beans.config.PropertyPlaceholderConfigurer的Bean就会停止对剩余PropertyPlaceholderConfigurer的扫描,

换句话说,即Spring容器仅允许最多定义一个PropertyPlaceholderConfigurer 或 <content:property-placeholder>其余的会被Spring忽略

由于Spring容器只能有一个PropertyPlaceholderConfigurer,如果有多个属性文件,这时就看谁先谁后了,先的保留 ,后的忽略。

还有一种情况,是Spring 自动注入 properties文件中的配置:要自动注入properties文件中的配置,需要在Spring配置文件中添加 org.springframework.beans.factory.config.PropertiesFactoryBean和org.springframework.beans.factory.config.PreferencesPlaceholderConfigurer的实例配置

<bean id="configProperties" class="org.springframework.beans.factory.config.PropertiesFactoryBean">
    <property name="locations">
        <list>
            <value> classpath*:application.properties</value>
        </list>
    </property>
</bean>
<bean id="propertyConfigurer" class="org.springframework.beans.factory.config.PreferencesPlaceholderConfigurer">
    <property name="properties" ref="configProperties" />
</bean>

在这个配置文件中我们配置了注解扫描,和configProperties实例和propertyConfigurer实例,这样我们就可以在java类中自动注入配置了

@Component
public class Test{
    @Value("#{configProperties['userName']}")
    private String userName;

    public String getUserName(){
        return userName;
    }

}

自动注入需要使用 @Value 这个注解,这个注解的格式 #{configProperties['userName']}其中configProperties是我们在配置文件中配置的bean的 id, userName 是在配置文件中配置的项

util:properties和context:property-placeholder标签都可以用来获取外部配置文件中的内容 
util:properties 
它是以声明bean方式来使用,创建了一个bean,下面使用的时候通过SpEL表达式#{}获取bean的属性。
1.自动注入
<!-- 加载应用属性实例,可通过  @Value("#{config['jdbc.driver']}") String jdbcDriver 方式引用 -->
2.
<util:properties id="config" location="classpath:db.properties" />
<!-- 配置连接池 -->
<bean id="ds" class="org.apache.commons.dbcp.BasicDataSource" destroy-method="close">
<property name="driverClassName" value="#{config.driver}" />
<property name="url" value="#{config.url}" />
<property name="username" value="#{config.username}" />
<property name="password" value="#{config.password}" />
</bean>

原文

https://blog.youkuaiyun.com/liuxin191863128/article/details/53406747

<think>我们正在处理一个关于Spring框架中`<context:property-placeholder>`的用法和配置问题。根据用户需求,我们需要提供清晰的结构化回答,并确保使用正确的中文和LaTeX格式。首先,回顾引用内容:-引用[1]提到SpringBoot默认配置了`PropertySourcesPlaceholderConfigurer`,从`application.properties`和`application.yml`获取属性。-引用[2]提到Spring提供了一个默认的宽松嵌入式值解析器,如果无法解析则注入属性名;要严格控制不存在的值,需要声明`PropertySourcesPlaceholderConfigurer`。-引用[3]展示了`resolvePlaceholders()`方法如何通过`propertyResolver`解析占位符。用户的问题是关于SpringXML配置中的`<context:property-placeholder>`,它用于在XML配置文件中解析属性占位符(如`${property.name}`)。###回答结构1.**介绍**:解释`<context:property-placeholder>`的作用。2.**基本配置**:展示基本用法和常用属性。3.**属性详解**:解释关键属性(如`location`、`ignore-resource-not-found`等)。4.**注意事项**:包括与SpringBoot的自动配置的对比以及多个配置的处理。5.**示例**:给出一个完整的配置示例。###生成相关问题根据主题,生成3个相关问题。###开始回答</think>### Spring context:property-placeholder 用法与配置 `<context:property-placeholder>` 是 Spring 框架中用于外部化配置的核心 XML 元素,它通过 `PropertySourcesPlaceholderConfigurer` 实现属性占位符解析(如 `${db.url}`)。以下是详细说明: #### 1. **核心作用** - **占位符解析**:在 XML 或注解配置中解析 `${...}` 格式的属性值,例如: ```xml <bean class="com.example.DataSource"> <property name="url" value="${db.url}"/> </bean> ``` - **外部化配置**:将属性值从代码分离到外部文件(如 `.properties`),便于环境切换[^1]。 #### 2. **基础配置** ```xml <context:property-placeholder location="classpath:db.properties,file:/etc/app/config.properties" ignore-resource-not-found="true" ignore-unresolvable="true" system-properties-mode="OVERRIDE" /> ``` - **`location`**:属性文件路径,支持多个文件(逗号分隔)和通配符(`classpath*:/config/*.properties`)。 - **`ignore-resource-not-found`**:是否忽略缺失文件(默认 `false`,缺失时报错)。 - **`ignore-unresolvable``**:是否忽略无法解析的占位符(默认 `false`,未匹配时报错)。 - **`system-properties-mode`**:系统属性优先级(`ENVIRONMENT`/`OVERRIDE`/`NEVER`)。 #### 3. **关键机制** - **解析顺序**:按 `location` 顺序加载属性,后加载的值覆盖先加载的值。 - **宽松模式**:默认行为下,未解析的占位符(如 `${unknown}`)会直接注入原始字符串。需显式设置 `ignore-unresolvable="false"` 强制严格校验[^2]。 - **与 Spring Boot 区别**:Spring Boot 自动配置 `PropertySourcesPlaceholderConfigurer`,优先从 `application.properties` 加载[^1]。XML 配置需手动声明。 #### 4. **高级配置** 若需完全控制解析行为,可显式定义 `PropertySourcesPlaceholderConfigurer` bean: ```xml <bean class="org.springframework.context.support.PropertySourcesPlaceholderConfigurer"> <property name="locations"> <list> <value>classpath:default.properties</value> <value>file:${CONF_DIR}/override.properties</value> </list> </property> <property name="ignoreUnresolvablePlaceholders" value="true"/> <property name="valueSeparator" value=":"/> <!-- 修改占位符分隔符为 ${key:default} --> </bean> ``` - **自定义占位符**:通过 `setPlaceholderPrefix`/`setPlaceholderSuffix` 修改 `${` 和 `}` 符号。 - **默认值支持**:使用 `:` 指定默认值,如 `${db.port:3306}`[^1]。 #### 5. **注意事项** - **避免重复声明**:多个 `<context:property-placeholder>` 会导致解析冲突,应合并配置- **Profile 支持**:结合 Spring Profiles 可环境差异化加载属性: ```xml <context:property-placeholder location="classpath:config-${spring.profiles.active}.properties"/> ``` - **加密属性**:需集成工具(如 Jasypt)解密 `${cipher:ENCRYPTED_VALUE}` 格式的值。 > **示例属性文件** (`db.properties`): > ``` > db.url=jdbc:mysql://localhost:3306/mydb > db.user=admin > db.password=secret > ```
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值