使用JAVA讀寫Properties屬性文件

Properties屬性文件在JAVA應用程序中是常常能夠看得見的，也是特別重要的一類文件。它用來配置應用程序的一些信息，不過這些信息通常都是比較少的數據，沒有必要使用數據庫文件來保存，而使用通常的文本文件來保存，若是是經過File直接保存的話，可能在存儲和讀取上都不是很方便，但若是保存爲Properties文件就不同了，屬性文件都有鍵值對應的，在JAVA的包中，有提供專門的操做屬性文件的類。這個類就是 java.uitl.Properties類，因爲Properties類是一個集合類，因此，Properties會將屬性以集合的方式讀寫。

注意：下面的代碼中對於拋出的異常都未採起捕獲的方式，本身在編寫程序的時候必定要注意捕獲異常，推薦將捕獲的異常處理掉。

Properties類繼承字Hashtable類，採用鍵值對應的存儲方式，在使用Properties類管理屬性文件時有什麼方便的呢？Properties類有專門的讀寫方法來讀寫Properties屬性文件，不用擔憂讀寫的格式問題，只要爲Properties類提供一個讀寫流便可。Properties用於讀寫屬性文件的方法分別是：
  

//讀取屬性文件流的方法
   public void load(InputStream inStream) throws IOException {}
   //寫屬性文件流的方法
   public void store(OutputStream out, String comments) throws IOException {}

//讀取屬性文件流的方法 
   public void load(InputStream inStream) throws IOException {} 
   //寫屬性文件流的方法 
   public void store(OutputStream out, String comments) throws IOException {} 

首先，咱們來看看如何從一個屬性文件中讀取屬性。

假定咱們已經新建了一個屬性文件，名爲prop.properties，內容以下：

  

sitename=abcjava
   siteurl=www.abcjava.com

sitename=abcjava 
   siteurl=www.abcjava.com 

咱們要作的第一步就是要將文件讀取到Properties類對象中，因爲load有一個參數是InputStream，因此咱們能夠用 InputStream的子類FileInputStream將屬性文件讀取到Properties對象中，知道prop.properties的路徑，咱們就用FileInputStream(String name)構造函數：

  

Properties prop = new Properties();//屬性集合對象
   FileInputStream fis = new FileInputStream("prop.properties");//屬性文件流
   prop.load(fis);//將屬性文件流裝載到Properties對象中

Properties prop = new Properties();//屬性集合對象 
   FileInputStream fis = new FileInputStream("prop.properties");//屬性文件流 
   prop.load(fis);//將屬性文件流裝載到Properties對象中 

接下來咱們將作的事情就是若是讀取一個屬性，由於屬性文件中的每一行都是一個鍵值對應，因此每一行都表明了一個屬性對象，每一行都將以鍵和值的關係存儲到Properties中，Properties類提供了getProperty(String key)方法用來經過鍵名讀取鍵值，當key在屬性集合中找不到時又想爲key在程序中賦予一個值時可使用public String getProperty(String key, String defaultValue)方法，這個方法的意思就是用指定的鍵在屬性列表中搜索屬性。若是在屬性列表中未找到該鍵，則接着遞歸檢查默認屬性列表及其默認值。若是未找到屬性，則此方法返回默認值變量：

  

//獲取屬性值，sitename已在文件中定義
   System.out.println("獲取屬性值：sitename=" + prop.getProperty("sitename"));
   //獲取屬性值，country未在文件中定義，將在此程序中返回一個默認值，但並不修改屬性文件
   System.out.println("獲取屬性值：country=" + prop.getProperty("country", "中國"));

//獲取屬性值，sitename已在文件中定義 
   System.out.println("獲取屬性值：sitename=" + prop.getProperty("sitename")); 
   //獲取屬性值，country未在文件中定義，將在此程序中返回一個默認值，但並不修改屬性文件 
   System.out.println("獲取屬性值：country=" + prop.getProperty("country", "中國")); 

在知道怎麼讀取屬性文件以後咱們還有一個很重要的事情就是要修改和添加新的屬性到屬性文件，這裏就是使用public void store(OutputStream out, String comments)方法，這個方法是將屬性集合寫到一個OutputStream流中，同InputStream流同樣，這裏一樣是使用其子類 FileOutputStream(String name)，這裏就很少說了。

在保存屬性集合到文件以前，咱們還有一件事情就是如何修改和添加新的屬性到屬性集合，這裏使用了一個方法就是setProperty(String key, String value)，這個方法就是當屬性集合中存在指定的key時，就修改這個key的值，若是不存在，就新建一個key，一樣是經過鍵值關係保存的，但值得注意的是，Properties類繼承自Hashtable，因此也能夠用Hashtable的put和putAll方法保存，但強烈反對使用這兩個方法，由於它們容許調用方插入其鍵或值不是 Strings 的項。相反，應該使用 setProperty 方法。若是在「有危險」的 Properties 對象（即包含非 String 的鍵或值）上調用 store 或 save 方法，則該調用將失敗。那好，下面咱們就來看看修改、添加和保存屬性的程序：

//修改sitename的屬性值
prop.setProperty("sitename", "Boxcode");
//添加一個新的屬性studio
prop.setProperty("studio", "Boxcode Studio");
//文件輸出流
FileOutputStream fos = new FileOutputStream("prop.properties");
//將Properties集合保存到流中
prop.store(fos, "Copyright (c) Boxcode Studio");
fos.close();//關閉流



接下就是整個程序的源代碼：

 

import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.util.Properties;

public class PropertyEditor {
    public static void main(String[] args) throws Exception {
        Properties prop = new Properties();// 屬性集合對象
        FileInputStream fis = new FileInputStream("prop.properties");// 屬性文件輸入流
        prop.load(fis);// 將屬性文件流裝載到Properties對象中
        fis.close();// 關閉流

        // 獲取屬性值，sitename已在文件中定義
        System.out.println("獲取屬性值：sitename=" + prop.getProperty("sitename"));
        // 獲取屬性值，country未在文件中定義，將在此程序中返回一個默認值，但並不修改屬性文件
        System.out.println("獲取屬性值：country=" + prop.getProperty("country", "中國"));

        // 修改sitename的屬性值
        prop.setProperty("sitename", "Boxcode");
        // 添加一個新的屬性studio
        prop.setProperty("studio", "Boxcode Studio");
        // 文件輸出流
        FileOutputStream fos = new FileOutputStream("prop.properties");
        // 將Properties集合保存到流中
        prop.store(fos, "Copyright (c) Boxcode Studio");
        fos.close();// 關閉流
    }
}

import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.util.Properties;

public class PropertyEditor {
	public static void main(String[] args) throws Exception {
		Properties prop = new Properties();// 屬性集合對象
		FileInputStream fis = new FileInputStream("prop.properties");// 屬性文件輸入流
		prop.load(fis);// 將屬性文件流裝載到Properties對象中
		fis.close();// 關閉流

		// 獲取屬性值，sitename已在文件中定義
		System.out.println("獲取屬性值：sitename=" + prop.getProperty("sitename"));
		// 獲取屬性值，country未在文件中定義，將在此程序中返回一個默認值，但並不修改屬性文件
		System.out.println("獲取屬性值：country=" + prop.getProperty("country", "中國"));

		// 修改sitename的屬性值
		prop.setProperty("sitename", "Boxcode");
		// 添加一個新的屬性studio
		prop.setProperty("studio", "Boxcode Studio");
		// 文件輸出流
		FileOutputStream fos = new FileOutputStream("prop.properties");
		// 將Properties集合保存到流中
		prop.store(fos, "Copyright (c) Boxcode Studio");
		fos.close();// 關閉流
	}
}

在咱們知道如何讀寫一個屬性文件以後，咱們仍然還有不少須要注意的問題，由於load和store方法都是按照ISO-8859-1的編碼方式讀寫屬性流文件的，而ILatin1 的字符和某些特殊字符，而對於非Latin1 的字符和某些特殊字符，則要使用與字符和字符串字面值所用的相似轉義序列，以值和元素的形式來表示它們。因此當咱們在處理中文時，不能夠在直接修改屬性文件時，將中文的值賦予給屬性，而是要在JAVA程序中經過setProperty方法給屬性賦予中文的值，由於這樣store會將中文轉換成 unicode碼，在讀取時系統會將讀取到的unicode碼按系統的編碼打印出來，對於中文系統，一般是GBK碼，這樣中文才可以正常顯示。