java中讀取.properties配置檔案

注：本文轉自http://www.cnblogs.com/fsjohnhuang/p/3995386.html

一、前言　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　

Java工程中想log4j、資料庫連線等配置資訊一般都寫在.properties檔案中，那麼如何讀取這些配置資訊呢？下面把相關方法記錄下來供以後查閱。

二、.properties檔案　　　　　　　　　　　　　　　　　　　　　　　　

配置檔案的一種，內容以鍵值對的形式存在，且每個鍵值對獨佔一行。#號作為行註釋的起始標誌，中文註釋會自動進行unicode編碼。示例：

# ip and port of server socket
ip=127.0.0.1
port=9999
# error message
msg=I'm sorry, bye bye!

假設上述內容儲存在config.properties檔案下，且bin目錄結果如下：

  bin

    |-- main

        |-- Demo.class

    |-- config.properties

後續章節的示例將以上述內容作為目標物件來操作。

三、通過 Properties物件 操作　　　　　　　　　　　　　　　　　　　

讀取屬性，示例：

public class Demo{
  public static void main(String[] args){
    Properties props = new Properties();

    InputStream in = Demo.class.getResourceAsStream("../config.properties");

    // 或使用檔案輸入流(不推薦)，假設當前工作目錄為bin
    //InputStream in = new FileInputStream("./config.properties");

    props.load(in);
    in.close();

    // 讀取特定屬性
    String key = "ip";
    String ip = props.getProperty(key);

    // 遍歷所有屬性，方式一
    Set keys = props.keySet();
    for (Interator it = keys.iterator(); it.hasNext();){
        String k = it.next();
        System.out.println(k + ":" + props.getProperty(k));
    }
     // 遍歷所有屬性，方式二
    Enumeration en = props.propertyNames();
    while (en.hasMoreElements()){
        String k = en.nextElement();
        System.out.println(k + ":" + props.getProperty(k));
    }
  }
}

1. 通過 Demo.class.getResourceAsStream(“../config.properties”); 讀取配置檔案，配置檔案的相對路徑以類檔案所在目錄作為當前目錄。

2. 通過 new FileInputStream(“./config.properties”); 讀取配置檔案，配置檔案的相對路徑以工作目錄(可以通過 System.getProperty(“user.dir”) 獲取工作目錄)作為當前目錄。

   注意：上述兩種方式獲取的配置檔案均沒有被快取。每次都要重新載入配置檔案。

   寫屬性，示例：

Properties props = new Properties();
InputStream in = getClass().getResouceAsStream("properties檔案相對於當前類載入路徑的檔案目錄");
props.load(in);

OutputStream output = new FileOutputStream("properties檔案路徑");
props.setProperty("ip", "10.248.112.123"); // 修改或新增屬性鍵值對
props.store(output, "modify ip value"); // store(OutputStream output, String comment)將修改結果寫入輸出流
output.close()

四、通過 ResourceBundle物件 操作　　　　　　　　　　　　　　　　　　　　

通過該方式僅能讀取配置檔案而已，不能進行寫操作。示例：

// ResourceBundle rb = ResourceBundle.getBundle("配置檔案相對工程根目錄的相對路徑（不含副檔名）");
ResourceBundle rb = ResourceBundle.getBundle("config");
try{
    String name = rb.getString("name");
}
catch(MissingResourceException ex){

注意：上述方式會快取配置檔案資訊，後續讀取時均是讀取快取中的內容，若在此期間修改了配置內容是無法實時同步的

ResourceBundle有兩個子類ListResourceBundle和PropertyResourceBundle，在讀取properties檔案時實際上是使用PropertyResourceBundle來處理。

題外話：

ResourceBundle主要用於解決國際化和本地化問題。通過資源命名定義各語言和方言的資訊，然乎程式在執行時獲取當前本地化資訊，並根據本地化資訊載入相應的資源完成本地化。

資源命名規範：
複製程式碼

// 僅含家族名
MyResource

// 含家族名和語言
MyResource_en

// 含家族名、語言和國家
MyResource_en_US

對應的Java程式碼：

// ResourceBundle首先會根據語言和國家的本地化資訊去查詢資源（假設現在要查詢MyResource_zh_CN），當找不到時就會找MyResource_zh，再找不到就用MyResource。
ResourceBundle rb = ResourceBundle.getBundle("MyResource", Locale.getDefault())

參考：
http://www.cnblogs.com/panjun-Donet/archive/2009/07/17/1525597.html