java中讀取properties檔案內容的五種方式

一、背景

　　最近，在項目開發的過程中，遇到需要在properties檔案中定義一些自訂的變數，以供java程式動態讀取，修改變數，不再需要修改代碼的問題。就藉此機會把Spring+SpringMVC+Mybatis整合開發的項目中通過java程式讀取properties檔案內容的方式進行了梳理和分析，現和大家共用。 二、項目環境介紹

    Spring 4.2.6.RELEASE

    SpringMvc 4.2.6.RELEASE

    Mybatis 3.2.8

    Maven 3.3.9

    Jdk 1.7

    Idea 15.04 三、五種實現方式

方式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屬性中以供別的程式使用