詳解五種方式讓你在java中讀取properties文件內(nèi)容不再是難題

更新時間：2016年12月26日 17:03:31 作者：程序猿到攻城獅之旅

這篇文章主要介紹了詳解五種方式讓你在java中讀取properties文件內(nèi)容不再是難題 ,非常具有實用價值，需要的朋友可以參考下。

一、背景

最近，在項目開發(fā)的過程中，遇到需要在properties文件中定義一些自定義的變量，以供java程序動態(tài)的讀取，修改變量，不再需要修改代碼的問題。就借此機會把Spring+SpringMVC+Mybatis整合開發(fā)的項目中通過java程序讀取properties文件內(nèi)容的方式進行了梳理和分析，先和大家共享。

二、項目環(huán)境介紹

Spring 4.2.6.RELEASE
SpringMvc 4.2.6.RELEASE
Mybatis 3.2.8
Maven 3.3.9
Jdk 1.7
Idea 15.04

三、五種實現(xiàn)方式

方式1.通過context:property-placeholder加載配置文件jdbc.properties中的內(nèi)容

<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文件中有如下配置，則一定不能缺少下面的紅色部分，關(guān)于它的作用以及原理.

<!-- 配置組件掃描，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文件中相應(yīng)的value值

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

方式3.使用util:properties標(biāo)簽進行暴露properties文件中的內(nèi)容

<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結(jié)果

  @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靜態(tài)代碼塊中讀取properties文件內(nèi)容保存在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文件內(nèi)容.......");
    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("出現(xiàn)IOException");
    } finally {
      try {
        if(null != in) {
          in.close();
        }
      } catch (IOException e) {
        logger.error("jdbc.properties文件流關(guān)閉出現(xiàn)異常");
      }
    }
    logger.info("加載properties文件內(nèi)容完成...........");
    logger.info("properties文件內(nèi)容：" + 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);
  }
}

說明：這樣的話，在該類被加載的時候，它就會自動讀取指定位置的配置文件內(nèi)容并保存到靜態(tài)屬性中，高效且方便，一次加載，可多次使用。

四、注意事項及建議

以上五種方式，前三種方式比較死板，而且如果你想在帶有@Controller注解的Bean中使用，你需要在SpringMVC的配置文件spring-mvc.xml中進行聲明，如果你想在帶有@Service、@Respository等非@Controller注解的Bean中進行使用，你需要在Spring的配置文件中spring.xml中進行聲明。

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

五、測試驗證是否可用

1.首先我們創(chuàng)建PropertiesService

package com.hafiz.www.service;

/**
 * Desc:java程序獲取properties文件內(nèi)容的service
 * Created by hafiz.zhang on 2016/9/16.
 */
public interface PropertiesService {

  /**
   * 第一種實現(xiàn)方式獲取properties文件中指定key的value
   *
   * @return
   */
  String getProperyByFirstWay();

  /**
   * 第二種實現(xiàn)方式獲取properties文件中指定key的value
   *
   * @return
   */
  String getProperyBySecondWay();

  /**
   * 第三種實現(xiàn)方式獲取properties文件中指定key的value
   *
   * @return
   */
  String getProperyByThirdWay();

  /**
   * 第四種實現(xiàn)方式獲取properties文件中指定key的value
   *
   * @param key
   *
   * @return
   */
  String getProperyByFourthWay(String key);

  /**
   * 第四種實現(xiàn)方式獲取properties文件中指定key的value
   *
   * @param key
   *
   * @param defaultValue
   *
   * @return
   */
  String getProperyByFourthWay(String key, String defaultValue);

  /**
   * 第五種實現(xiàn)方式獲取properties文件中指定key的value
   *
   * @param key
   *
   * @return
   */
  String getProperyByFifthWay(String key);

  /**
   * 第五種實現(xiàn)方式獲取properties文件中指定key的value
   *
   * @param key
   *
   * @param defaultValue
   *
   * @return
   */
  String getProperyByFifthWay(String key, String defaultValue);
}

2.創(chuàng)建實現(xiàn)類PropertiesServiceImpl

package com.hafiz.www.service.impl;

import com.hafiz.www.service.PropertiesService;
import com.hafiz.www.util.PropertyConfigurer;
import com.hafiz.www.util.PropertyUtil;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Service;

/**
 * Desc:java程序獲取properties文件內(nèi)容的service的實現(xiàn)類
 * Created by hafiz.zhang on 2016/9/16.
 */
@Service
public class PropertiesServiceImpl implements PropertiesService {

  @Value("${test}")
  private String testDataByFirst;

  @Value("#{prop.test}")
  private String testDataBySecond;

  @Value("#{propertiesReader[test]}")
  private String testDataByThird;

  @Autowired
  private PropertyConfigurer pc;

  @Override
  public String getProperyByFirstWay() {
    return testDataByFirst;
  }

  @Override
  public String getProperyBySecondWay() {
    return testDataBySecond;
  }

  @Override
  public String getProperyByThirdWay() {
    return testDataByThird;
  }

  @Override
  public String getProperyByFourthWay(String key) {
    return pc.getProperty(key);
  }

  @Override
  public String getProperyByFourthWay(String key, String defaultValue) {
    return pc.getProperty(key, defaultValue);
  }

  @Override
  public String getProperyByFifthWay(String key) {
    return PropertyUtil.getPropery(key);
  }

  @Override
  public String getProperyByFifthWay(String key, String defaultValue) {
    return PropertyUtil.getProperty(key, defaultValue);
  }
}

3.控制器類PropertyController

package com.hafiz.www.controller;

import com.hafiz.www.service.PropertiesService;
import com.hafiz.www.util.PropertyUtil;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.ResponseBody;

/**
 * Desc:properties測試控制器
 * Created by hafiz.zhang on 2016/9/16.
 */
@Controller
@RequestMapping("/prop")
public class PropertyController {
  @Autowired
  private PropertiesService ps;

  @RequestMapping(value = "/way/first", method = RequestMethod.GET)
  @ResponseBody
  public String getPropertyByFirstWay(){
    return ps.getProperyByFirstWay();
  }

  @RequestMapping(value = "/way/second", method = RequestMethod.GET)
  @ResponseBody
  public String getPropertyBySecondWay(){
    return ps.getProperyBySecondWay();
  }

  @RequestMapping(value = "/way/third", method = RequestMethod.GET)
  @ResponseBody
  public String getPropertyByThirdWay(){
    return ps.getProperyByThirdWay();
  }

  @RequestMapping(value = "/way/fourth/{key}", method = RequestMethod.GET)
  @ResponseBody
  public String getPropertyByFourthWay(@PathVariable("key") String key){
    return ps.getProperyByFourthWay(key, "defaultValue");
  }

  @RequestMapping(value = "/way/fifth/{key}", method = RequestMethod.GET)
  @ResponseBody
  public String getPropertyByFifthWay(@PathVariable("key") String key){
    return PropertyUtil.getProperty(key, "defaultValue");
  }
}

4.jdbc.properties文件

jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://192.168.1.196:3306/dev?useUnicode=true&characterEncoding=UTF-8
jdbc.username=root
jdbc.password=123456
jdbc.maxActive=200
jdbc.minIdle=5
jdbc.initialSize=1
jdbc.maxWait=60000
jdbc.timeBetweenEvictionRunsMillis=60000
jdbc.minEvictableIdleTimeMillis=300000
jdbc.validationQuery=select 1 from t_user
jdbc.testWhileIdle=true
jdbc.testOnReturn=false
jdbc.poolPreparedStatements=true
jdbc.maxPoolPreparedStatementPerConnectionSize=20
jdbc.filters=stat
#test data
test=com.hafiz.www

5.項目結(jié)果圖