1. 程式人生 > 程式設計 >Java讀取.properties配置檔案的幾種方式

Java讀取.properties配置檔案的幾種方式

Java 開發中,需要將一些易變的配置引數放置再 XML 配置檔案或者 properties 配置檔案中。然而 XML 配置檔案需要通過 DOM 或 SAX 方式解析,而讀取 properties 配置檔案就比較容易。

介紹幾種讀取方式:

1、基於ClassLoder讀取配置檔案

注意:該方式只能讀取類路徑下的配置檔案,有侷限但是如果配置檔案在類路徑下比較方便。

Properties properties = new Properties();
  // 使用ClassLoader載入properties配置檔案生成對應的輸入流
  InputStream in = PropertiesMain.class.getClassLoader().getResourceAsStream("config/config.properties");
  // 使用properties物件載入輸入流
  properties.load(in);
  //獲取key對應的value值
  properties.getProperty(String key);

2、基於 InputStream 讀取配置檔案

注意:該方式的優點在於可以讀取任意路徑下的配置檔案

Properties properties = new Properties();
  // 使用InPutStream流讀取properties檔案
  BufferedReader bufferedReader = new BufferedReader(new FileReader("E:/config.properties"));
  properties.load(bufferedReader);
  // 獲取key對應的value值
  properties.getProperty(String key);

3、通過 java.util.ResourceBundle 類來讀取,這種方式比使用 Properties 要方便一些

1>通過 ResourceBundle.getBundle() 靜態方法來獲取(ResourceBundle是一個抽象類),這種方式來獲取properties屬性檔案不需要加.properties字尾名,只需要檔名即可

    properties.getProperty(String key);
   //config為屬性檔名,放在包com.test.config下,如果是放在src下,直接用config即可 
   ResourceBundle resource = ResourceBundle.getBundle("com/test/config/config");
   String key = resource.getString("keyWord"); 

2>從 InputStream 中讀取,獲取 InputStream 的方法和上面一樣,不再贅述

ResourceBundle resource = new PropertyResourceBundle(inStream);

注意:在使用中遇到的最大的問題可能是配置檔案的路徑問題,如果配置檔案入在當前類所在的包下,那麼需要使用包名限定,如:config.properties入在com.test.config包下,則要使用com/test/config/config.properties(通過Properties來獲取)或com/test/config/config(通過ResourceBundle來獲取);屬性檔案在src根目錄下,則直接使用config.properties或config即可。

下面附上幾種方式的測試程式碼,僅供參考:

package com.test.properties;

import java.io.BufferedInputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.Enumeration;
import java.util.Properties;

import org.springframework.core.io.support.PropertiesLoaderUtils;

/**
 *
 * @ClassName: TestProperties
 * @Description: 獲取配置檔案資訊
 * @date: 2017年11月25日 上午10:56:00
 * @version: 1.0.0
 */
public class TestProperties {


  /**
   *
   * @Title: printAllProperty
   * @Description: 輸出所有配置資訊
   * @param props
   * @return void
   * @throws
   */
  private static void printAllProperty(Properties props)
  {
    @SuppressWarnings("rawtypes")
    Enumeration en = props.propertyNames();
    while (en.hasMoreElements())
    {
      String key = (String) en.nextElement();
      String value = props.getProperty(key);
      System.out.println(key + " : " + value);
    }
  }

  /**
   * 根據key讀取value
   *
   * @Title: getProperties_1
   * @Description: 第一種方式:根據檔名使用spring中的工具類進行解析
   *         filePath是相對路勁,檔案需在classpath目錄下
   *          比如:config.properties在包com.test.config下,
   *        路徑就是com/test/config/config.properties
   *
   * @param filePath
   * @param keyWord
   * @return
   * @return String
   * @throws
   */
  public static String getProperties_1(String filePath,String keyWord){
    Properties prop = null;
    String value = null;
    try {
      // 通過Spring中的PropertiesLoaderUtils工具類進行獲取
      prop = PropertiesLoaderUtils.loadAllProperties(filePath);
      // 根據關鍵字查詢相應的值
      value = prop.getProperty(keyWord);
    } catch (IOException e) {
      e.printStackTrace();
    }
    return value;
  }

  /**
   * 讀取配置檔案所有資訊
   *
   * @Title: getProperties_1
   * @Description: 第一種方式:根據檔名使用Spring中的工具類進行解析
   *         filePath是相對路勁,檔案需在classpath目錄下
   *          比如:config.properties在包com.test.config下,
   *        路徑就是com/test/config/config.properties
   *
   * @param filePath
   * @return void
   * @throws
   */
  public static void getProperties_1(String filePath){
    Properties prop = null;
    try {
      // 通過Spring中的PropertiesLoaderUtils工具類進行獲取
      prop = PropertiesLoaderUtils.loadAllProperties(filePath);
      printAllProperty(prop);
    } catch (IOException e) {
      e.printStackTrace();
    }
  }

  /**
   * 根據key讀取value
   *
   * @Title: getProperties_2
   * @Description: 第二種方式:使用緩衝輸入流讀取配置檔案,然後將其載入,再按需操作
   *          絕對路徑或相對路徑, 如果是相對路徑,則從當前專案下的目錄開始計算,
   *         如:當前專案路徑/config/config.properties,*         相對路徑就是config/config.properties
   *
   * @param filePath
   * @param keyWord
   * @return
   * @return String
   * @throws
   */
  public static String getProperties_2(String filePath,String keyWord){
    Properties prop = new Properties();
    String value = null;
    try {
      // 通過輸入緩衝流進行讀取配置檔案
      InputStream InputStream = new BufferedInputStream(new FileInputStream(new File(filePath)));
      // 載入輸入流
      prop.load(InputStream);
      // 根據關鍵字獲取value值
      value = prop.getProperty(keyWord);
    } catch (Exception e) {
      e.printStackTrace();
    }
    return value;
  }

  /**
   * 讀取配置檔案所有資訊
   *
   * @Title: getProperties_2
   * @Description: 第二種方式:使用緩衝輸入流讀取配置檔案,然後將其載入,再按需操作
   *          絕對路徑或相對路徑, 如果是相對路徑,則從當前專案下的目錄開始計算,
   *         如:當前專案路徑/config/config.properties,*         相對路徑就是config/config.properties
   *
   * @param filePath
   * @return void
   * @throws
   */
  public static void getProperties_2(String filePath){
    Properties prop = new Properties();
    try {
      // 通過輸入緩衝流進行讀取配置檔案
      InputStream InputStream = new BufferedInputStream(new FileInputStream(new File(filePath)));
      // 載入輸入流
      prop.load(InputStream);
      printAllProperty(prop);
    } catch (Exception e) {
      e.printStackTrace();
    }
  }

  /**
   * 根據key讀取value
   *
   * @Title: getProperties_3
   * @Description: 第三種方式:
   *          相對路徑, properties檔案需在classpath目錄下,
   *         比如:config.properties在包com.test.config下,
   *         路徑就是/com/test/config/config.properties
   * @param filePath
   * @param keyWord
   * @return
   * @return String
   * @throws
   */
  public static String getProperties_3(String filePath,String keyWord){
    Properties prop = new Properties();
    String value = null;
    try {
      InputStream inputStream = TestProperties.class.getResourceAsStream(filePath);
      prop.load(inputStream);
      value = prop.getProperty(keyWord);
    } catch (IOException e) {
      e.printStackTrace();
    }
    return value;
  }

  /**
   * 讀取配置檔案所有資訊
   *
   * @Title: getProperties_3
   * @Description: 第三種方式:
   *          相對路徑, properties檔案需在classpath目錄下,
   *         比如:config.properties在包com.test.config下,
   *         路徑就是/com/test/config/config.properties
   * @param filePath
   * @return
   * @throws
   */
  public static void getProperties_3(String filePath){
    Properties prop = new Properties();
    try {
      InputStream inputStream = TestProperties.class.getResourceAsStream(filePath);
      prop.load(inputStream);
      printAllProperty(prop);
    } catch (IOException e) {
      e.printStackTrace();
    }
  }


  public static void main(String[] args) {
    // 注意路徑問題
    String properties_1 = getProperties_1("com/test/config/config.properties","wechat_appid");
    System.out.println("wechat_appid = " + properties_1);
    getProperties_1("com/test/config/config.properties");
    System.out.println("*********************************************");
    // 注意路徑問題
    String properties_2 = getProperties_2("configure/configure.properties","jdbc.url");
    System.out.println("jdbc.url = " + properties_2);
    getProperties_2("configure/configure.properties");
    System.out.println("*********************************************");
    // 注意路徑問題
    String properties_3 = getProperties_3("/com/test/config/config.properties","wechat_appid");
    System.out.println("wechat_appid = " + properties_3);
    getProperties_3("/com/test/config/config.properties");
  }
}

到此這篇關於Java讀取.properties配置檔案的幾種方式的文章就介紹到這了,更多相關Java 讀取properties 配置內容請搜尋我們以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援我們!