spring- properties 讀取的五種方式

隨風而逝,只是飄零發表於2016-12-15
Spring

轉至：http://www.cnblogs.com/hafiz/p/5876243.html

方式1.通過context:property-placeholder載入配置檔案jdbc.properties中的內容

<context:property-placeholder location="classpath:jdbc.properties" ignore-unresolvable="true"/>

　　上面的配置和下面配置等價，是對下面配置的簡化

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

注意：這種方式下，如果你在spring-mvc.xml檔案中有如下配置，則一定不能缺少下面的紅色部分，關於它的作用以及原理，參見另一篇部落格：context:component-scan標籤的use-default-filters屬性的作用以及原理分析

<!-- 配置元件掃描，springmvc容器中只掃描Controller註解 -->
<context:component-scan base-package="com.hafiz.www" use-default-filters="false">
    <context:include-filter type="annotation" expression="org.springframework.stereotype.Controller"/>
</context:component-scan>

　　方式2.使用註解的方式注入，主要用在java程式碼中使用註解注入properties檔案中相應的value值

<bean id="prop" class="org.springframework.beans.factory.config.PropertiesFactoryBean">
   <!-- 這裡是PropertiesFactoryBean類，它也有個locations屬性，也是接收一個陣列，跟上面一樣 -->
   <property name="locations">
       <array>
          <value>classpath:jdbc.properties</value>
       </array>
   </property>
</bean>

　　方式3.使用util:properties標籤進行暴露properties檔案中的內容

<util:properties id="propertiesReader" location="classpath:jdbc.properties"/>

注意：使用上面這行配置，需要在spring-dao.xml檔案的頭部宣告以下紅色的部分

<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:util="http://www.springframework.org/schema/util"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans-3.2.xsd
        http://www.springframework.org/schema/context 
        http://www.springframework.org/schema/context/spring-context-3.2.xsd
        http://www.springframework.org/schema/util 
　　　　 http://www.springframework.org/schema/util/spring-util.xsd">

　　方式4.通過PropertyPlaceholderConfigurer在載入上下文的時候暴露properties到自定義子類的屬性中以供程式中使用

<bean id="propertyConfigurer" class="com.hafiz.www.util.PropertyConfigurer">
   <property name="ignoreUnresolvablePlaceholders" value="true"/>
   <property name="ignoreResourceNotFound" value="true"/>
   <property name="locations">
       <list>
          <value>classpath:jdbc.properties</value>
       </list>
   </property>
</bean>

自定義類PropertyConfigurer的宣告如下:

package com.hafiz.www.util;

import org.springframework.beans.BeansException;
import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
import org.springframework.beans.factory.config.PropertyPlaceholderConfigurer;

import java.util.Properties;

/**
 * Desc:properties配置檔案讀取類
 * Created by hafiz.zhang on 2016/9/14.
 */
public class PropertyConfigurer extends PropertyPlaceholderConfigurer {

    private Properties props;       // 存取properties配置檔案key-value結果

    @Override
    protected void processProperties(ConfigurableListableBeanFactory beanFactoryToProcess, Properties props)
                            throws BeansException {
        super.processProperties(beanFactoryToProcess, props);
        this.props = props;
    }

    public String getProperty(String key){
        return this.props.getProperty(key);
    }

    public String getProperty(String key, String defaultValue) {
        return this.props.getProperty(key, defaultValue);
    }

    public Object setProperty(String key, String value) {
        return this.props.setProperty(key, value);
    }
}

使用方式：在需要使用的類中使用@Autowired註解注入即可。

　　方式5.自定義工具類PropertyUtil，並在該類的static靜態程式碼塊中讀取properties檔案內容儲存在static屬性中以供別的程式使用

package com.hafiz.www.util;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.*;
import java.util.Properties;

/**
 * Desc:properties檔案獲取工具類
 * Created by hafiz.zhang on 2016/9/15.
 */
public class PropertyUtil {
    private static final Logger logger = LoggerFactory.getLogger(PropertyUtil.class);
    private static Properties props;
    static{
        loadProps();
    }

    synchronized static private void loadProps(){
        logger.info("開始載入properties檔案內容.......");
        props = new Properties();
        InputStream in = null;
        try {
　　　　　　　<!--第一種，通過類載入器進行獲取properties檔案流-->
            in = PropertyUtil.class.getClassLoader().getResourceAsStream("jdbc.properties");
　　　　　　  <!--第二種，通過類進行獲取properties檔案流-->
            //in = PropertyUtil.class.getResourceAsStream("/jdbc.properties");
            props.load(in);
        } catch (FileNotFoundException e) {
            logger.error("jdbc.properties檔案未找到");
        } catch (IOException e) {
            logger.error("出現IOException");
        } finally {
            try {
                if(null != in) {
                    in.close();
                }
            } catch (IOException e) {
                logger.error("jdbc.properties檔案流關閉出現異常");
            }
        }
        logger.info("載入properties檔案內容完成...........");
        logger.info("properties檔案內容：" + props);
    }

    public static String getProperty(String key){
        if(null == props) {
            loadProps();
        }
        return props.getProperty(key);
    }

    public static String getProperty(String key, String defaultValue) {
        if(null == props) {
            loadProps();
        }
        return props.getProperty(key, defaultValue);
    }
}

說明：這樣的話，在該類被載入的時候，它就會自動讀取指定位置的配置檔案內容並儲存到靜態屬性中，高效且方便，一次載入，可多次使用。

四、注意事項及建議

　　以上五種方式，前三種方式比較死板，而且如果你想在帶有@Controller註解的Bean中使用，你需要在SpringMVC的配置檔案spring-mvc.xml中進行宣告，如果你想在帶有@Service、@Respository等非@Controller註解的Bean中進行使用，你需要在Spring的配置檔案中spring.xml中進行宣告。原因請參見另一篇部落格：Spring和SpringMVC父子容器關係初窺

　　我個人比較建議第四種和第五種配置方式，第五種為最好，它連工具類物件都不需要注入，直接呼叫靜態方法進行獲取，而且只一次載入，效率也高。而且前三種方式都不是很靈活，需要修改@Value的鍵值。

相關文章