【開發筆記】- Java讀取properties文件的五種方式

原文地址：https://www.cnblogs.com/hafiz/p/5876243.html

---

1、背景

　　最近，在項目開發的過程當中，遇到須要在properties文件中定義一些自定義的變量，以供java程序動態的讀取，修改變量，再也不須要修改代碼的問題。就藉此機會把Spring+SpringMVC+Mybatis整合開發的項目中經過java程序讀取properties文件內容的方式進行了梳理和分析，現和你們共享。

2、項目環境介紹

    Spring 4.2.6.RELEASE

    SpringMvc 4.2.6.RELEASE

    Mybatis 3.2.8

    Maven 3.3.9

    Jdk 1.7

    Idea 15.04

3、五種實現方式

方式1.經過context:property-placeholder加載配置文件jdbc.properties中的內容

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

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

1 <bean id="propertyConfigurer" class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
2    <property name="ignoreUnresolvablePlaceholders" value="true"/>
3    <property name="locations">
4       <list>
5          <value>classpath:jdbc.properties</value>
6       </list>
7     </property>
8 </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); } }

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

4、注意事項及建議

　　以上五種方式，前三種方式比較死板，並且若是你想在帶有@Controller註解的Bean中使用，你須要在SpringMVC的配置文件spring-mvc.xml中進行聲明，若是你想在帶有@Service、@Respository等非@Controller註解的Bean中進行使用，你須要在Spring的配置文件中spring.xml中進行聲明。緣由請參見另外一篇博客：Spring和SpringMVC父子容器關係初窺

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

5、測試驗證是否可用

1.首先咱們建立PropertiesService

package com.hafiz.www.service; /** * Desc:java程序獲取properties文件內容的service * Created by hafiz.zhang on 2016/9/16. */
public interface PropertiesService { /** * 第一種實現方式獲取properties文件中指定key的value * * @return
     */ String getProperyByFirstWay(); /** * 第二種實現方式獲取properties文件中指定key的value * * @return
     */ String getProperyBySecondWay(); /** * 第三種實現方式獲取properties文件中指定key的value * * @return
     */ String getProperyByThirdWay(); /** * 第四種實現方式獲取properties文件中指定key的value * * @param key * * @return
     */ String getProperyByFourthWay(String key); /** * 第四種實現方式獲取properties文件中指定key的value * * @param key * * @param defaultValue * * @return
     */ String getProperyByFourthWay(String key, String defaultValue); /** * 第五種實現方式獲取properties文件中指定key的value * * @param key * * @return
     */ String getProperyByFifthWay(String key); /** * 第五種實現方式獲取properties文件中指定key的value * * @param key * * @param defaultValue * * @return
     */ String getProperyByFifthWay(String key, String defaultValue); }

2.建立實現類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文件內容的service的實現類 * 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.項目結果圖

　　

6.項目GitHub地址

　　https://github.com/hafizzhang/SSM/branches 頁面下的propertiesConfigurer分支。

7.測試結果

　　第一種方式

　　

　　第二種方式

　　

　　第三種方式

　　

　　第四種方式

　　

　　第五種方式

　　

6、總結

　　經過本次的梳理和測試，咱們理解了Spring和SpringMVC的父子容器關係以及context:component-scan標籤包掃描時最容易忽略的use-default-filters屬性的做用以及原理。可以更好地定位和快速解決再遇到的問題。