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

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

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

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

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

#congfigofActiveMQ
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：

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

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

应用场景：Properties配置文件不止一个，需要在系统启动时同时加载多个Properties文件。

配置方式：

<?xmlversion="1.0"encoding="UTF-8"?>
<beansxmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="
http://www.springframework.org/schema/beanshttp://www.springframework.org/schema/beans/spring-beans-3.0.xsd">

<!--将多个配置文件读取到容器中，交给Spring管理-->
<beanid="propertyConfigurer"class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
<propertyname="locations">
<list>
<!--这里支持多种寻址方式：classpath和file-->
<value>classpath:/opt/demo/config/demo-db.properties</value>
<!--推荐使用file的方式引入，这样可以将配置和代码分离-->
<value>file:/opt/demo/config/demo-mq.properties</value>
<value>file:/opt/demo/config/demo-remote.properties</value>
</list>
</property>
</bean>

<!--使用MQ中的配置-->
<beanid="MQJndiTemplate"class="org.springframework.jndi.JndiTemplate">
<propertyname="environment">
<props>
<propkey="java.naming.factory.initial">${mq.java.naming.factory.initial}</prop>
<propkey="java.naming.provider.url">${mq.java.naming.provider.url}</prop>
<propkey="java.naming.security.principal">${mq.java.naming.security.principal}</prop>
<propkey="java.naming.security.credentials">${mq.java.naming.security.credentials}</prop>
<propkey="userName">${mq.java.naming.security.principal}</prop>
<propkey="password">${mq.java.naming.security.credentials}</prop>
</props>
</property>
</bean>
</beans>

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

<?xmlversion="1.0"encoding="UTF-8"?>
<beansxmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="
http://www.springframework.org/schema/beanshttp://www.springframework.org/schema/beans/spring-beans-3.0.xsd">

<!--将多个配置文件位置放到列表中-->
<beanid="propertyResources"class="java.util.ArrayList">
<constructor-arg>
<list>
<!--这里支持多种寻址方式：classpath和file-->
<value>classpath:/opt/demo/config/demo-db.properties</value>
<!--推荐使用file的方式引入，这样可以将配置和代码分离-->
<value>file:/opt/demo/config/demo-mq.properties</value>
<value>file:/opt/demo/config/demo-remote.properties</value>
</list>
</constructor-arg>
</bean>

<!--将配置文件读取到容器中，交给Spring管理-->
<beanid="propertyConfigurer"class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
<propertyname="locations"ref="propertyResources"/>
</bean>

<!--使用MQ中的配置-->
<beanid="MQJndiTemplate"class="org.springframework.jndi.JndiTemplate">
<propertyname="environment">
<props>
<propkey="java.naming.factory.initial">${mq.java.naming.factory.initial}</prop>
<propkey="java.naming.provider.url">${mq.java.naming.provider.url}</prop>
<propkey="java.naming.security.principal">${mq.java.naming.security.principal}</prop>
<propkey="java.naming.security.credentials">${mq.java.naming.security.credentials}</prop>
<propkey="userName">${mq.java.naming.security.principal}</prop>
<propkey="password">${mq.java.naming.security.credentials}</prop>
</props>
</property>
</bean>
</beans>

二、整合多工程下的多个分散的Properties

应用场景：工程组中有多个配置文件，但是这些配置文件在多个地方使用，所以需要分别加载。

配置如下：

<?xmlversion="1.0"encoding="UTF-8"?>
<beansxmlns="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/beanshttp://www.springframework.org/schema/beans/spring-beans-3.0.xsd">

<!--将DB属性配置文件位置放到列表中-->
<beanid="dbResources"class="java.util.ArrayList">
<constructor-arg>
<list>
<value>file:/opt/demo/config/demo-db.properties</value>
</list>
</constructor-arg>
</bean>

<!--将MQ属性配置文件位置放到列表中-->
<beanid="mqResources"class="java.util.ArrayList">
<constructor-arg>
<list>
<value>file:/opt/demo/config/demo-mq.properties</value>
</list>
</constructor-arg>
</bean>

<!--用Spring加载和管理DB属性配置文件-->
<beanid="dbPropertyConfigurer"class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
<propertyname="order"value="1"/>
<propertyname="ignoreUnresolvablePlaceholders"value="true"/>
<propertyname="locations"ref="dbResources"/>
</bean>

<!--用Spring加载和管理MQ属性配置文件-->
<beanid="mqPropertyConfigurer"class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
<propertyname="order"value="2"/>
<propertyname="ignoreUnresolvablePlaceholders"value="true"/>
<propertyname="locations"ref="mqResources"/>
</bean>

<!--使用DB中的配置属性-->
<beanid="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>

<!--使用MQ中的配置-->
<beanid="MQJndiTemplate"class="org.springframework.jndi.JndiTemplate">
<propertyname="environment">
<props>
<propkey="java.naming.factory.initial">${mq.java.naming.factory.initial}</prop>
<propkey="java.naming.provider.url">${mq.java.naming.provider.url}</prop>
<propkey="java.naming.security.principal">${mq.java.naming.security.principal}</prop>
<propkey="java.naming.security.credentials">${mq.java.naming.security.credentials}</prop>
<propkey="userName">${mq.java.naming.security.principal}</prop>
<propkey="password">${mq.java.naming.security.credentials}</prop>
</props>
</property>
</bean>
</beans>

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

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

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

publicclassClient(){
privateStringip;
privateStringport;
privateStringservice;
}

配置如下：

<?xmlversion="1.0"encoding="UTF-8"?>
<beansxmlns="<ahref="http://www.springframework.org/schema/beans">http://www.springframework.org/schema/beans</a>"
xmlns:xsi="<ahref="http://www.w3.org/2001/XMLSchema-instance">http://www.w3.org/2001/XMLSchema-instance</a>"
xmlns:util="<ahref="http://www.springframework.org/schema/util">http://www.springframework.org/schema/util</a>"
xsi:schemaLocation="
<ahref="http://www.springframework.org/schema/beans">http://www.springframework.org/schema/beans</a><ahref="http://www.springframework.org/schema/beans/spring-beans-3.0.xsd">http://www.springframework.org/schema/beans/spring-beans-3.0.xsd</a>
<ahref="http://www.springframework.org/schema/util">http://www.springframework.org/schema/util</a><ahref="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/>标签只能加载一个文件，当多个属性文件需要被加载的时候，可以使用多个该标签-->
<util:propertiesid="remoteSettings"location="file:/opt/demo/config/demo-remote.properties"/>

<!--<util:properties/>标签的实现类是PropertiesFactoryBean，
直接使用该类的bean配置，设置其locations属性可以达到一个和上面一样加载多个配置文件的目的-->
<beanid="settings"
class="org.springframework.beans.factory.config.PropertiesFactoryBean">
<propertyname="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如下：

importorg.springframework.beans.factory.annotation.Value;

publicclassClient(){
@Value("#{remoteSettings['remote.ip']}")
privateStringip;
@Value("#{remoteSettings['remote.port']}")
privateStringport;
@Value("#{remoteSettings['remote.serviceName']}")
privateStringservice;
}

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

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

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

importorg.springframework.beans.factory.annotation.Value;
importorg.springframework.beans.factory.annotation.Autowired;

publicclassClient(){
@Value("#{remoteSettings}")
privatePropertiesremoteSettings;
}

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

<?xmlversion="1.0"encoding="UTF-8"?>
<beansxmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="
http://www.springframework.org/schema/beanshttp://www.springframework.org/schema/beans/spring-beans-3.0.xsd">

<!--可以使用如下的方式声明Properties类型的FactoryBean来加载配置文件，这种方式就只能当做Properties属性注入，而不能获其中具体的值-->
<beanid="remoteConfigs"class="org.springframework.beans.factory.config.PropertiesFactoryBean">
<propertyname="locations">
<list>
<value>file:/opt/demo/config/demo-remote.properties</value>
</list>
</property>
</bean>

<!--远端调用客户端类-->
<beanid="client"class="com.demo.remote.Client">
<propertyname="properties"ref="remoteConfigs"/>
</bean>
</beans>

代码如下：

importorg.springframework.beans.factory.annotation.Autowired;

publicclassClient(){
//@Autowired也可以使用
privatePropertiesremoteSettings;

//gettersetter
}

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