2. 程式人生 > >java中讀取properties文件

java中讀取properties文件

阿新 • • 發佈：2017-10-02
idea 背景 inter jdbc between ssi .get ret 理解

五種方式讓你在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屬性中以供別的程序使用

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的鍵值。

五、測試驗證是否可用

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.測試結果

　　第一種方式

　　技術分享

　　第二種方式

　　技術分享

　　第三種方式

　　技術分享

　　第四種方式

　　技術分享

　　第五種方式

　　技術分享

六、總結

　　通過本次的梳理和測試，我們理解了Spring和SpringMVC的父子容器關系以及context:component-scan標簽包掃描時最容易忽略的use-default-filters屬性的作用以及原理。能夠更好地定位和快速解決再遇到的問題。總之，棒棒噠~~~

------------------------------------------------------------------------------------------------------------------------------------------------

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

java中讀取properties文件

相關推薦

java中讀取properties文件

idea 背景 inter jdbc between ssi .get ret 理解 五種方式讓你在java中讀取properties文件 一、背景 　　最近，在項目開發的過程中，遇到需要在properties文件中定義一些自定義的變量，以供java程序動態的讀取，修改

五種方式讓你在java中讀取properties文件內容不再是難題

toolbar ota oca vat include tor 代碼塊 location interface 一、背景 　　最近，在項目開發的過程中，遇到需要在properties文件中定義一些自定義的變量，以供java程序動態的讀取，修改變量，不再需要修改代碼的問題。就借

java中讀取配置文件

eclips current base ips extc eas lac true ava 若是Java web項目，項目運行於tomcat或其他容器時，可以使用下面方式來獲取文件的輸入流 1、當屬性文件放在src下面時 InputStream is = Thread.c

java中讀取配置文件的方法

oid board t對象 open set itl 方法 getclass count 轉自：http://blog.csdn.net/stypace/article/details/38414871 一、使用org.apache.commons.configuratio

java中讀取txt文件的三種方式

1.   package com.readfile;   2.      3.   import java.io.BufferedReader;   4.   import java.io.File

java後臺讀取配置文件中key與value -----demo

undle ltm string 文件名 logs 配置 rip conf 返回值 public class ResourcesUtils { /* * @description:根據屬性獲取文件名 * * @param:propertyName文件的

java加載properties文件的六中基本方式實現

alt user 通過 put main import port pac 技術 java加載properties文件的方式主要分為兩大類：一種是通過import java.util.Properties類中的load(InputStream in)方法加載； 另一種是通過

idea中spark項目Scala語言讀取properties文件

module 技術分享 clas 點擊 ade file asstream -1 str 1.將文件放入resources目錄下面，將文件設置成resources file->Project Structure->Modules 選擇文件，然後點擊resourc

Java讀取properties文件(非泛濫)

eas st2 cati brush loader object package bsp base 根據spring配置文件的 PropertiesFactoryBean和 PropertyPlaceholderConfigurer可以選擇不同的加載方式，我是使用Syste

Java中IO流文件讀取、寫入和復制

復制 循環 int files catch class close brush system //構造文件File類 File f=new File(fileName); //判斷是否為目錄 f.isDirectory(); //獲取目錄下的文件名 String[] fil

Java讀取Properties文件的六種方法

java讀取properties文件的方法Java讀取Properties文件有以下六種方法：1。使用java.util.Properties類的load()方法 String fileName="E:/system.properties"; InputStream in = ne

註解形式讀取properties文件中的屬性

ati ssp location fig ext class per ring control 1、spring.xml中加入（多個properties 用逗號隔開） <context:property-placeholder location="classpath

java讀取properties文件

java文件名為db.properties 第一種： 通過ResourceBundle獲取ResourceBundle bunble = ResourceBundle.getBundle("db");driver = bunble.getString("driver")

Java程序中讀取外部文件時的路徑問題

pre 因此 AI light class類 ade 但是 sys public 轉自：https://www.cnblogs.com/wt20/p/8320346.html 項目經常會讀取一些配置文件, 因此getResource方法便能夠起到重要作用 使用時主要是兩種

說說Java中的資源文件的讀取

star .com ken context conf 不能 thread set ctu 最近在看spring的資源獲取時發現JDK裏存在幾種不同方式的資源獲取，因比較混亂特地總結起來幫助和我一樣混亂的人理解。下面是我項目的類結構圖，在 src/main/java 下有

java讀取properties文件總結

finally etc eno res fig 問題 imp tle input 一、java讀取properties文件總結 在java項目中，操作properties文件是經常要做的，因為很多的配置信息都會寫在properties文件中，這裏主要是總結使用getReso

Java讀取properties文件工具類並解決控制臺中文亂碼

font cin efault 工具類 接口 工具 ati 博客 圖片 1、建立properts文件（error.message.properties） HTTP201= 請求成功並且服務器創建了新的資源 　 2、在spring-mvc.xml文件（app

JSP中獲取properties文件屬性

util port char rip text request taglib test 文件屬性 <%@ page contentType="text/html;charset=UTF-8" import="java.util.ResourceBundle"%>

Java中獲取資源文件的方法總結

tco doget 技術 resource images 磁盤 response linux exception 這裏總結3中方法獲取資源文件的 ServletContext Class ClassLoader 文件的位置 1. ServletC

ResourceUtils讀取properties文件

audit 系統 n) for 通過 語言 ise sys perfect 註意: 　　properties文件要放在classPath下面，也就是與src下。 path.properties perfectMaterial=fileLibrary/complet