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

迷南。 2022-06-16 20:27 172阅读 0赞

1.      http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd">  
2.        
3.      **  **
4.      <bean id="propertyResources" class="java.util.ArrayList">  
5.          <constructor-arg>  
6.              <list>  
7.                **  **
8.                <value>classpath:/opt/demo/config/demo-db.properties</value>  
9.                **  **
10.               <value>file:/opt/demo/config/demo-mq.properties</value>  
11.               <value>file:/opt/demo/config/demo-remote.properties</value>  
12.             </list>  
13.         </constructor-arg>  
14.     </bean>  
15.       
16.     **  **
17.     <bean id="propertyConfigurer" class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">  
18.         <property name="locations" ref="propertyResources" />  
19.     </bean>  
20.       
21.     **  **
22.     <bean id="MQJndiTemplate" class="org.springframework.jndi.JndiTemplate">  
23.         <property name="environment">  
24.             <props>  
25.                 <prop key="java.naming.factory.initial">$\{mq.java.naming.factory.initial\}</prop>  
26.                 <prop key="java.naming.provider.url">$\{mq.java.naming.provider.url\}</prop>  
27.                 <prop key="java.naming.security.principal">$\{mq.java.naming.security.principal\}</prop>  
28.                 <prop key="java.naming.security.credentials">$\{mq.java.naming.security.credentials\}</prop>  
29.                 <prop key="userName">$\{mq.java.naming.security.principal\}</prop>  
30.                 <prop key="password">$\{mq.java.naming.security.credentials\}</prop>  
31.             </props>  
32.         </property>  
33.     </bean>  
34. </beans>

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

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

配置如下：

1.  <?xml version="1.0" encoding="UTF-8"?>  
2.  <beans xmlns="http://www.springframework.org/schema/beans"  
3.      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
4.      xmlns:p="http://www.springframework.org/schema/p"  
5.      xsi:schemaLocation="  
6.      http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd">  
7.        
8.      **  **
9.      <bean id="dbResources" class="java.util.ArrayList">  
10.         <constructor-arg>  
11.         <list>  
12.             <value>file:/opt/demo/config/demo-db.properties</value>  
13.         </list>  
14.         </constructor-arg>  
15.     </bean>  
16.   
17.     **  **
18.     <bean id="mqResources" class="java.util.ArrayList">  
19.         <constructor-arg>  
20.         <list>  
21.             <value>file:/opt/demo/config/demo-mq.properties</value>  
22.         </list>  
23.         </constructor-arg>  
24.     </bean>  
25.       
26.     **  **
27.     <bean id="dbPropertyConfigurer" class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">  
28.         <property name="order" value="1" />  
29.         <property name="ignoreUnresolvablePlaceholders" value="true" />   
30.         <property name="locations" ref="dbResources" />  
31.     </bean>  
32.       
33.     **  **
34.     <bean id="mqPropertyConfigurer" class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">  
35.         <property name="order" value="2" />  
36.         <property name="ignoreUnresolvablePlaceholders" value="true" />   
37.         <property name="locations" ref="mqResources" />  
38.     </bean>  
39.       
40.     **  **
41.     <bean id="rmsDataSource" class="org.apache.commons.dbcp.BasicDataSource" destroy-method="close"   
42.         p:driverClassName="$\{demo.db.driver\}" p:url="$\{demo.db.url\}" p:username="$\{demo.db.username\}"   
43.         p:password="$\{demo.db.password\}" pp:maxActive="$\{demo.db.maxactive\}"p:maxWait="$\{demo.db.maxwait\}"   
44.         p:poolPreparedStatements="true" p:defaultAutoCommit="false">  
45.     </bean>  
46.       
47.     **  **
48.     <bean id="MQJndiTemplate" class="org.springframework.jndi.JndiTemplate">  
49.         <property name="environment">  
50.             <props>  
51.                 <prop key="java.naming.factory.initial">$\{mq.java.naming.factory.initial\}</prop>  
52.                 <prop key="java.naming.provider.url">$\{mq.java.naming.provider.url\}</prop>  
53.                 <prop key="java.naming.security.principal">$\{mq.java.naming.security.principal\}</prop>  
54.                 <prop key="java.naming.security.credentials">$\{mq.java.naming.security.credentials\}</prop>  
55.                 <prop key="userName">$\{mq.java.naming.security.principal\}</prop>  
56.                 <prop key="password">$\{mq.java.naming.security.credentials\}</prop>  
57.             </props>  
58.         </property>  
59.     </bean>  
60. </beans>

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

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

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

1.  **public class Client() \{  **
2.      **private String ip;  **
3.      **private String port;  **
4.      **private String service;  **
5.  \}

配置如下：

1.  <?xml version="1.0" encoding="UTF-8"?>  
2.  <beans xmlns="<a href="http://www.springframework.org/schema/beans">http://www.springframework.org/schema/beans</a>"  
3.   xmlns:xsi="<a href="http://www.w3.org/2001/XMLSchema-instance">http://www.w3.org/2001/XMLSchema-instance</a>"  
4.   xmlns:util="<a href="http://www.springframework.org/schema/util">http://www.springframework.org/schema/util</a>"  
5.   xsi:schemaLocation="  
6.   <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>  
7.   <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>">  
8.     
9.     
11.  **  **
12.  <util:properties id="remoteSettings" location="file:/opt/demo/config/demo-remote.properties" />   
13.    
14.    
16.  <bean id="settings"   
17.    class="org.springframework.beans.factory.config.PropertiesFactoryBean">  
18.    <property name="locations">  
19.   <list>  
20.     <value>file:/opt/rms/config/rms-mq.properties</value>  
21.     <value>file:/opt/rms/config/rms-env.properties</value>  
22.   </list>  
23.    </property>  
24.  </bean>  
25. </beans>

Client类中使用Annotation如下：

1.  **import org.springframework.beans.factory.annotation.Value;  **
2.    
3.  **public class Client() \{  **
4.      @Value("\#\{remoteSettings\['remote.ip'\]\}")  
5.      **private String ip;  **
6.      @Value("\#\{remoteSettings\['remote.port'\]\}")  
7.      **private String port;  **
8.      @Value("\#\{remoteSettings\['remote.serviceName'\]\}")  
9.      **private String service;  **
10. \}

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

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

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

1.  **import org.springframework.beans.factory.annotation.Value;  **
2.  **import org.springframework.beans.factory.annotation.Autowired;  **
3.    
4.  **public class Client() \{  **
5.      @Value("\#\{remoteSettings\}")  
6.      **private Properties remoteSettings;  **
7.  \}

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

1.  <?xml version="1.0" encoding="UTF-8"?>  
2.  <beans xmlns="http://www.springframework.org/schema/beans"  
3.      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
4.      xsi:schemaLocation="  
5.      http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd">  
6.        
7.      **  **
8.      <bean id="remoteConfigs" class="org.springframework.beans.factory.config.PropertiesFactoryBean">  
9.          <property name="locations">  
10.             <list>  
11.                 <value>file:/opt/demo/config/demo-remote.properties</value>  
12.             </list>  
13.         </property>  
14.     </bean>  
15.       
16.     **  **
17.     <bean id="client" class="com.demo.remote.Client">  
18.         <property name="properties" ref="remoteConfigs" />  
19.     </bean>  
20. </beans>

代码如下：

1.  **import org.springframework.beans.factory.annotation.Autowired;  **
2.    
3.  **public class Client() \{  **
4.      //@Autowired也可以使用  
5.      **private Properties remoteSettings;  **
6.        
7.      //getter setter  
8.  \}

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

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

补充：

## The Spring Framework PropertiesFactoryBeanTests.java source code ##

![复制代码][copycode.gif]

/*
     * 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"));
        }
    
    }

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

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

配置如下：

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

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

1.  **public class Client() \{  **
2.      **private String ip;  **
3.      **private String port;  **
4.      **private String service;  **
5.  \}

配置如下：

Client类中使用Annotation如下：

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

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

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

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

1.  <?xml version="1.0" encoding="UTF-8"?>  
2.  <beans xmlns="http://www.springframework.org/schema/beans"  
3.      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
4.      xsi:schemaLocation="  
5.      http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd">  
6.        
7.      **  **
8.      <bean id="remoteConfigs" class="org.springframework.beans.factory.config.PropertiesFactoryBean">  
9.          <property name="locations">  
10.             <list>  
11.                 <value>file:/opt/demo/config/demo-remote.properties</value>  
12.             </list>  
13.         </property>  
14.     </bean>  
15.       
16.     **  **
17.     <bean id="client" class="com.demo.remote.Client">  
18.         <property name="properties" ref="remoteConfigs" />  
19.     </bean>  
20. </beans>

代码如下：

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

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

补充：

## The Spring Framework *PropertiesFactoryBeanTests.java* source code ##

![复制代码][copycode.gif]

[copycode.gif]: /images/20220617/b02c0a06f3204a9091239408ceee45ff.png