Properties屬性文件在JAVA應用程序中是經常可以看得見的,也是特別重要的一類文件。它用來配置應用程序的一些信息,不過這些信息一般都是比較少的數據,沒有必要使用數據庫文件來
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 {}
首先,我們來看看如何從一個屬性文件中讀取屬性。
假定我們已經新建了一個屬性文件,名爲prop.properties,內容如下:
- 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中,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", "中國"));
在知道怎麼讀取屬性文件之後我們還有一個很重要的事情就是要修改和添加新的屬性到屬性文件,這裏就是使用public void
store(OutputStream out, String
comments)方法,這個方法是將屬性集合寫到一個OutputStream流中,同InputStream流一樣,這裏同樣是使用其子類
FileOutputStream(String name),這裏就不多說了。
在保存屬性集合到文件之前,我們還有一件事情就是如何修改和添加新的屬性到屬性集合,這裏使用了一個方法就是setProperty(String key, String value),這個方
在保存屬性集合到文件之前,我們還有一件事情就是如何修改和添加新的屬性到屬性集合,這裏使用了一個方法就是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();//關閉流
- }
- }
在我們知道如何讀寫一個屬性文件之後,我們仍然還有很多需要注意的問題,因爲load和store方法都是按照ISO-8859-1的編碼方式讀寫
屬性流文件的,而ILatin1 的字符和某些特殊字符,而對於非Latin1
的字符和某些特殊字符,則要使用與字符和字符串字面值所用的類似轉義序列,以值和元素的形式來表示它們。所以當我們在處理中文時,不可以在直接修改屬性文
件時,將中文的值賦予給屬性,而是要在JAVA程序中通過setProperty方法給屬性賦予中文的值,因爲這樣store會將中文轉換成
unicode碼,在讀取時系統會將讀取到的unicode碼按系統的編碼打印出來,對於中文系統,通常是GBK碼,這樣中文才能夠正常顯示。