Java 對 Properties 文件的操作

【說明】本博文爲作者個人原創，轉載請聲明文章來源

簡介

在 Java 中，我們常用 java.util.Properties.Properties 類來解析 Properties 文件，Properties 格式文件是 Java 常用的配置文件，它用來在文件中存儲鍵-值對，其中鍵和值用等號分隔，格式如下：

name=shawearn

Properties 類是 java.util.Hashtable<Object, Object> 的子類，用於鍵和值之間的映射。

在對 Properties 格式文件的操作中，我們常使用 Properties 類的一下方法：

Properties()：用於創建一個無任何屬性值 Properties 對象；

• void load(InputStream inStream)：從輸入流中加載屬性列表；
• void store(OutputStream out, String comments)：根據輸出流將屬性列表保存到文件中； 
• String  getProperty(String key)：獲取指定鍵的值；
• void setProperty(String key, String value)：設置指定鍵的值，若指定鍵已經在原屬性值列表中存在，則覆蓋；若指定鍵在原屬性值列表中不存在，則新增；

寫入 Properties 文件：

// 創建一個 Properties 實例；
Properties p = new Properties();
// 爲 Properties 設置屬性及屬性值；
p.setProperty("name", "shawearn");
p.setProperty("address", "XX 省 XX 市");
// 保存 Properties 到 shawearn.properties 文件中；
FileOutputStream out = new FileOutputStream("shawearn.properties");
p.store(out, "Create by Shawearn!");
out.close();

讀取 Properties 文件：

// 創建一個 Properties 實例；
Properties p = new Properties();
// 讀取配置文件；
FileInputStream in = new FileInputStream("shawearn.properties");
// 加載配置文件到 Properties 實例中；
p.load(in);
in.close();

最後附上測試代碼：

package com.shawearn.test;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.util.Properties;
import java.util.Set;
/**
 * @author Shawearn
 * 
 */
public class TestProperties {
	/**
	 * @param args
	 * @throws IOException
	 */
	public static void main(String[] args) throws IOException {
		TestProperties t = new TestProperties();
		// 測試寫入；
		t.testWrite();
		// 測試讀取；
		t.testRead();
	}
	/*
	 * 測試對 Properties 文件的寫入操作；
	 */
	private void testWrite() throws IOException {
		// 創建一個 Properties 實例；
		Properties p = new Properties();
		// 爲 Properties 設置屬性及屬性值；
		p.setProperty("name", "shawearn");
		p.setProperty("address", "XX 省 XX 市");
		// 保存 Properties 到 shawearn.properties 文件中；
		FileOutputStream out = new FileOutputStream("shawearn.properties");
		p.store(out, "Create by Shawearn!");
		out.close();
		System.out.println("寫入成功！");
	}
	/*
	 * 測試對 Properties 文件的讀取操作；
	 */
	private void testRead() throws IOException {
		// 創建一個 Properties 實例；
		Properties p = new Properties();
		// 讀取配置文件；
		FileInputStream in = new FileInputStream("shawearn.properties");
		// 加載配置文件到 Properties 實例中；
		p.load(in);
		in.close();
		// 獲取 Properties 文件中所有的 key；
		Set<String> keys = p.stringPropertyNames();
		// 遍歷所有的 key；
		for (String key : keys) {
			// 獲取 Properties 文件中 key 所對應的 value；
			Object value = p.get(key);
			// 輸入 key 和對應的 value；
			System.out.println(key + " => " + value);
		}
	}
}

控制檯輸出結果：

address => XX 省 XX 市
name => shawearn

shawearn.properties 文件內容：

#Create by Shawearn!
#Thu Nov 19 12:43:41 CST 2015
name=shawearn
address=XX \u7701 XX \u5E02