Spring中配置和读取多个Properties文件

来源：互联网发布：传智48期php就业班编辑：程序博客网时间：2024/05/17 09:20

public class PropertiesFactoryBeanextends PropertiesLoaderSupportimplements FactoryBean, InitializingBean

Allows for making a properties file from a classpath location available as Properties instance in a bean factory. Can be used to populate any bean property of type Properties via a bean reference.

Supports loading from a properties file and/or setting local properties on this FactoryBean. The created Properties instance will be merged from loaded and local values. If neither a location nor local properties are set, an exception will be thrown on initialization.

Can create a singleton or a new object on each request. Default is a singleton.

一个系统中通常会存在如下一些以Properties形式存在的配置文件

1.数据库配置文件demo-db.properties：

Properties代码

database.url=jdbc:mysql://localhost/smaple
database.driver=com.mysql.jdbc.Driver
database.user=root
database.password=123

2.消息服务配置文件demo-mq.properties:

Properties代码

#congfig of ActiveMQ
mq.java.naming.factory.initial=org.apache.activemq.jndi.ActiveMQInitialContextFactory
mq.java.naming.provider.url=failover:(tcp://localhost:61616?soTimeout=30000&connectionTimeout=30000)?jms.useAsyncSend=true&timeout=30000
mq.java.naming.security.principal=
mq.java.naming.security.credentials=
jms.MailNotifyQueue.consumer=5

3.远程调用的配置文件demo-remote.properties：

Properties代码

remote.ip=localhost
remote.port=16800
remote.serviceName=test

一、系统中需要加载多个Properties配置文件

应用场景：Properties配置文件不止一个，需要在系统启动时同时加载多个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"
xsi:schemaLocation="
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd">
<bean id="propertyConfigurer" class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
<property name="locations">
<list>
<value>classpath:/opt/demo/config/demo-db.properties</value>
<value>file:/opt/demo/config/demo-mq.properties</value>
<value>file:/opt/demo/config/demo-remote.properties</value>
</list>
</property>
</bean>
<bean id="MQJndiTemplate" class="org.springframework.jndi.JndiTemplate">
<property name="environment">
<props>
<prop key="java.naming.factory.initial">${mq.java.naming.factory.initial}</prop>
<prop key="java.naming.provider.url">${mq.java.naming.provider.url}</prop>
<prop key="java.naming.security.principal">${mq.java.naming.security.principal}</prop>
<prop key="java.naming.security.credentials">${mq.java.naming.security.credentials}</prop>
<prop key="userName">${mq.java.naming.security.principal}</prop>
<prop key="password">${mq.java.naming.security.credentials}</prop>
</props>
</property>
</bean>
</beans>

我们也可以将配置中的List抽取出来:

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"
xsi:schemaLocation="
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd">
<bean id="propertyResources" class="java.util.ArrayList">
<constructor-arg>
<list>
<value>classpath:/opt/demo/config/demo-db.properties</value>
<value>file:/opt/demo/config/demo-mq.properties</value>
<value>file:/opt/demo/config/demo-remote.properties</value>
</list>
</constructor-arg>
</bean>
<bean id="propertyConfigurer" class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
<property name="locations" ref="propertyResources" />
</bean>
<bean id="MQJndiTemplate" class="org.springframework.jndi.JndiTemplate">
<property name="environment">
<props>
<prop key="java.naming.factory.initial">${mq.java.naming.factory.initial}</prop>
<prop key="java.naming.provider.url">${mq.java.naming.provider.url}</prop>
<prop key="java.naming.security.principal">${mq.java.naming.security.principal}</prop>
<prop key="java.naming.security.credentials">${mq.java.naming.security.credentials}</prop>
<prop key="userName">${mq.java.naming.security.principal}</prop>
<prop key="password">${mq.java.naming.security.credentials}</prop>
</props>
</property>
</bean>
</beans>

二、整合多工程下的多个分散的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:p="http://www.springframework.org/schema/p"
xsi:schemaLocation="
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd">
<bean id="dbResources" class="java.util.ArrayList">
<constructor-arg>
<list>
<value>file:/opt/demo/config/demo-db.properties</value>
</list>
</constructor-arg>
</bean>
<bean id="mqResources" class="java.util.ArrayList">
<constructor-arg>
<list>
<value>file:/opt/demo/config/demo-mq.properties</value>
</list>
</constructor-arg>
</bean>
<bean id="dbPropertyConfigurer" class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
<property name="order" value="1" />
<property name="ignoreUnresolvablePlaceholders" value="true" />
<property name="locations" ref="dbResources" />
</bean>
<bean id="mqPropertyConfigurer" class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
<property name="order" value="2" />
<property name="ignoreUnresolvablePlaceholders" value="true" />
<property name="locations" ref="mqResources" />
</bean>
<bean id="rmsDataSource" class="org.apache.commons.dbcp.BasicDataSource" destroy-method="close"
p:driverClassName="${demo.db.driver}" p:url="${demo.db.url}" p:username="${demo.db.username}"
p:password="${demo.db.password}" pp:maxActive="${demo.db.maxactive}"p:maxWait="${demo.db.maxwait}"
p:poolPreparedStatements="true" p:defaultAutoCommit="false">
</bean>
<bean id="MQJndiTemplate" class="org.springframework.jndi.JndiTemplate">
<property name="environment">
<props>
<prop key="java.naming.factory.initial">${mq.java.naming.factory.initial}</prop>
<prop key="java.naming.provider.url">${mq.java.naming.provider.url}</prop>
<prop key="java.naming.security.principal">${mq.java.naming.security.principal}</prop>
<prop key="java.naming.security.credentials">${mq.java.naming.security.credentials}</prop>
<prop key="userName">${mq.java.naming.security.principal}</prop>
<prop key="password">${mq.java.naming.security.credentials}</prop>
</props>
</property>
</bean>
</beans>

注意：其中order属性代表其加载顺序，而ignoreUnresolvablePlaceholders为是否忽略不可解析的 Placeholder，如配置了多个PropertyPlaceholderConfigurer，则需设置为true。这里一定需要按照这种方式设置这两个参数。

三、Bean中直接注入Properties配置文件中的值

应用场景：Bean中需要直接注入Properties配置文件中的值。例如下面的代码中需要获取上述demo-remote.properties中的值：

Java代码

public class Client() {
private String ip;
private String port;
private String service;
}

配置如下：

Xml代码

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="<a href="http://www.springframework.org/schema/beans">http://www.springframework.org/schema/beans</a>"
xmlns:xsi="<a href="http://www.w3.org/2001/XMLSchema-instance">http://www.w3.org/2001/XMLSchema-instance</a>"
xmlns:util="<a href="http://www.springframework.org/schema/util">http://www.springframework.org/schema/util</a>"
xsi:schemaLocation="
<a href="http://www.springframework.org/schema/beans">http://www.springframework.org/schema/beans</a> <a href="http://www.springframework.org/schema/beans/spring-beans-3.0.xsd">http://www.springframework.org/schema/beans/spring-beans-3.0.xsd</a>
<a href="http://www.springframework.org/schema/util">http://www.springframework.org/schema/util</a> <a href="http://www.springframework.org/schema/util/spring-util-3.0.xsd">http://www.springframework.org/schema/util/spring-util-3.0.xsd</a>">
<!-- 这种加载方式可以在代码中通过@Value注解进行注入,
可以将配置整体赋给Properties类型的类变量，也可以取出其中的一项赋值给String类型的类变量 -->
<util:properties id="remoteSettings" location="file:/opt/demo/config/demo-remote.properties" />
<!-- <util:properties/> 标签的实现类是PropertiesFactoryBean，
直接使用该类的bean配置，设置其locations属性可以达到一个和上面一样加载多个配置文件的目的 -->
<bean id="settings"
class="org.springframework.beans.factory.config.PropertiesFactoryBean">
<property name="locations">
<list>
<value>file:/opt/rms/config/rms-mq.properties</value>
<value>file:/opt/rms/config/rms-env.properties</value>
</list>
</property>
</bean>
</beans>

Client类中使用Annotation如下：

Java代码

import org.springframework.beans.factory.annotation.Value;
public class Client() {
@Value("#{remoteSettings['remote.ip']}")
private String ip;
@Value("#{remoteSettings['remote.port']}")
private String port;
@Value("#{remoteSettings['remote.serviceName']}")
private String service;
}

四、Bean中存在Properties类型的类变量

应用场景：当Bean中存在Properties类型的类变量需要以注入的方式初始化

1. 配置方式：我们可以用（三）中的配置方式，只是代码中注解修改如下

Java代码

import org.springframework.beans.factory.annotation.Value;
import org.springframework.beans.factory.annotation.Autowired;
public class Client() {
@Value("#{remoteSettings}")
private Properties remoteSettings;
}

2. 配置方式：也可以使用xml中声明Bean并且注入

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"
xsi:schemaLocation="
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd">
<bean id="remoteConfigs" class="org.springframework.beans.factory.config.PropertiesFactoryBean">
<property name="locations">
<list>
<value>file:/opt/demo/config/demo-remote.properties</value>
</list>
</property>
</bean>
<bean id="client" class="com.demo.remote.Client">
<property name="properties" ref="remoteConfigs" />
</bean>
</beans>

代码如下：

Java代码

import org.springframework.beans.factory.annotation.Autowired;
public class Client() {
//@Autowired也可以使用
private Properties remoteSettings;
//getter setter
}

上述的各个场景在项目群中特别有用，需要灵活的使用上述各种配置方式。

原文：http://kingxss.iteye.com/blog/1880681

补充：

The Spring Framework PropertiesFactoryBeanTests.java source code

/* * Copyright 2002-2006 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * *      http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */package org.springframework.beans.factory.config;import java.util.Properties;import junit.framework.TestCase;import org.springframework.core.JdkVersion;import org.springframework.core.io.ClassPathResource;/** * @author Juergen Hoeller * @since 01.11.2003 */public class PropertiesFactoryBeanTests extends TestCase {    public void testWithPropertiesFile() throws Exception {        PropertiesFactoryBean pfb = new PropertiesFactoryBean();        pfb.setLocation(new ClassPathResource("/org/springframework/beans/factory/config/test.properties"));        pfb.afterPropertiesSet();        Properties props = (Properties) pfb.getObject();        assertEquals("99", props.getProperty("tb.array[0].age"));    }    public void testWithPropertiesXmlFile() throws Exception {        // ignore for JDK < 1.5        if (JdkVersion.getMajorJavaVersion() < JdkVersion.JAVA_15) {            return;        }        PropertiesFactoryBean pfb = new PropertiesFactoryBean();        pfb.setLocation(new ClassPathResource("/org/springframework/beans/factory/config/test-properties.xml"));        pfb.afterPropertiesSet();        Properties props = (Properties) pfb.getObject();        assertEquals("99", props.getProperty("tb.array[0].age"));    }    public void testWithLocalProperties() throws Exception {        PropertiesFactoryBean pfb = new PropertiesFactoryBean();        Properties localProps = new Properties();        localProps.setProperty("key2", "value2");        pfb.setProperties(localProps);        pfb.afterPropertiesSet();        Properties props = (Properties) pfb.getObject();        assertEquals("value2", props.getProperty("key2"));    }    public void testWithPropertiesFileAndLocalProperties() throws Exception {        PropertiesFactoryBean pfb = new PropertiesFactoryBean();        pfb.setLocation(new ClassPathResource("/org/springframework/beans/factory/config/test.properties"));        Properties localProps = new Properties();        localProps.setProperty("key2", "value2");        localProps.setProperty("tb.array[0].age", "0");        pfb.setProperties(localProps);        pfb.afterPropertiesSet();        Properties props = (Properties) pfb.getObject();        assertEquals("99", props.getProperty("tb.array[0].age"));        assertEquals("value2", props.getProperty("key2"));    }    public void testWithPropertiesFileAndMultipleLocalProperties() throws Exception {        PropertiesFactoryBean pfb = new PropertiesFactoryBean();        pfb.setLocation(new ClassPathResource("/org/springframework/beans/factory/config/test.properties"));        Properties props1 = new Properties();        props1.setProperty("key2", "value2");        props1.setProperty("tb.array[0].age", "0");        Properties props2 = new Properties();        props2.setProperty("spring", "framework");        props2.setProperty("Don", "Mattingly");        Properties props3 = new Properties();        props3.setProperty("spider", "man");        props3.setProperty("bat", "man");        pfb.setPropertiesArray(new Properties[] {props1, props2, props3});        pfb.afterPropertiesSet();        Properties props = (Properties) pfb.getObject();        assertEquals("99", props.getProperty("tb.array[0].age"));        assertEquals("value2", props.getProperty("key2"));        assertEquals("framework", props.getProperty("spring"));        assertEquals("Mattingly", props.getProperty("Don"));        assertEquals("man", props.getProperty("spider"));        assertEquals("man", props.getProperty("bat"));    }    public void testWithPropertiesFileAndLocalPropertiesAndLocalOverride() throws Exception {        PropertiesFactoryBean pfb = new PropertiesFactoryBean();        pfb.setLocation(new ClassPathResource("/org/springframework/beans/factory/config/test.properties"));        Properties localProps = new Properties();        localProps.setProperty("key2", "value2");        localProps.setProperty("tb.array[0].age", "0");        pfb.setProperties(localProps);        pfb.setLocalOverride(true);        pfb.afterPropertiesSet();        Properties props = (Properties) pfb.getObject();        assertEquals("0", props.getProperty("tb.array[0].age"));        assertEquals("value2", props.getProperty("key2"));    }    public void testWithPrototype() throws Exception {        PropertiesFactoryBean pfb = new PropertiesFactoryBean();        pfb.setSingleton(false);        pfb.setLocation(new ClassPathResource("/org/springframework/beans/factory/config/test.properties"));        Properties localProps = new Properties();        localProps.setProperty("key2", "value2");        pfb.setProperties(localProps);        pfb.afterPropertiesSet();        Properties props = (Properties) pfb.getObject();        assertEquals("99", props.getProperty("tb.array[0].age"));        assertEquals("value2", props.getProperty("key2"));        Properties newProps = (Properties) pfb.getObject();        assertTrue(props != newProps);        assertEquals("99", newProps.getProperty("tb.array[0].age"));        assertEquals("value2", newProps.getProperty("key2"));    }}

0 0