JAVA讀寫(xiě)Properties屬性文件
Properties 類(lèi)表示了一個(gè)持久的屬性集。Properties 可保存在流中或從流中加載。屬性列表中每個(gè)鍵及其對(duì)應(yīng)值都是一個(gè)字符串。
一個(gè)屬性列表可包含另一個(gè)屬性列表作為它的“默認(rèn)值”;如果未能在原有的屬性列表中搜索到屬性鍵,則搜索第二個(gè)屬性列表。
因?yàn)?Properties 繼承于 Hashtable,所以可對(duì) Properties 對(duì)象應(yīng)用 put 和 putAll 方法。但不建議使用這兩個(gè)方法,因?yàn)樗鼈冊(cè)试S調(diào)用者插入其鍵或值不是 String 的項(xiàng)。相反,應(yīng)該使用 setProperty 方法。如果在“不安全”的 Properties 對(duì)象(即包含非 String 的鍵或值)上調(diào)用 store 或 save 方法,則該調(diào)用將失敗。類(lèi)似地,如果在“不安全”的Properties 對(duì)象(即包含非 String 的鍵)上調(diào)用 propertyNames 或 list 方法,則該調(diào)用將失敗。
Properties屬性文件在JAVA應(yīng)用程序中是經(jīng)常可以看得見(jiàn)的,也是特別重要的一類(lèi)文件。它用來(lái)配置應(yīng)用程序的一些信息,不過(guò)這些信息一般都是比較少的數(shù)據(jù),沒(méi)有必要使用數(shù)據(jù)庫(kù)文件來(lái)保存,而使用一般的文本文件來(lái)保存,如果是通過(guò)File直接保存的話,可能在存儲(chǔ)和讀取上都不是很方便,但如果保存為Properties文件就不一樣了,屬性文件都有鍵值對(duì)應(yīng)的,在JAVA的包中,有提供專門(mén)的操作屬性文件的類(lèi)。這個(gè)類(lèi)就是 java.uitl.Properties類(lèi),由于Properties類(lèi)是一個(gè)集合類(lèi),所以,Properties會(huì)將屬性以集合的方式讀寫(xiě)。
注意:下面的代碼中對(duì)于拋出的異常都未采取捕獲的方式,自己在編寫(xiě)程序的時(shí)候一定要注意捕獲異常,推薦將捕獲的異常處理掉。
Properties類(lèi)繼承字Hashtable類(lèi),采用鍵值對(duì)應(yīng)的存儲(chǔ)方式,在使用Properties類(lèi)管理屬性文件時(shí)有什么方便的呢?Properties類(lèi)有專門(mén)的讀寫(xiě)方法來(lái)讀寫(xiě)Properties屬性文件,不用擔(dān)心讀寫(xiě)的格式問(wèn)題,只要為Properties類(lèi)提供一個(gè)讀寫(xiě)流即可。Properties用于讀寫(xiě)屬性文件的方法分別是:
- //讀取屬性文件流的方法
- public void load(InputStream inStream) throws IOException {}
- //寫(xiě)屬性文件流的方法
- public void store(OutputStream out, String comments) throws IOException {}
首先,我們來(lái)看看如何從一個(gè)屬性文件中讀取屬性。
假定我們已經(jīng)新建了一個(gè)屬性文件,名為prop.properties,內(nèi)容如下:
sitename=abcjava
siteurl=www.abcjava.com
我們要做的第一步就是要將文件讀取到Properties類(lèi)對(duì)象中,由于load有一個(gè)參數(shù)是InputStream,所以我們可以用 InputStream的子類(lèi)FileInputStream將屬性文件讀取到Properties對(duì)象中,知道prop.properties的路徑,我們就用FileInputStream(String name)構(gòu)造函數(shù):
- Properties prop = new Properties();//屬性集合對(duì)象
- FileInputStream fis = new FileInputStream("prop.properties");//屬性文件流
- prop.load(fis);//將屬性文件流裝載到Properties對(duì)象中
接下來(lái)我們將做的事情就是如果讀取一個(gè)屬性,因?yàn)閷傩晕募械拿恳恍卸际且粋€(gè)鍵值對(duì)應(yīng),所以每一行都代表了一個(gè)屬性對(duì)象,每一行都將以鍵和值的關(guān)系存儲(chǔ)到Properties中,Properties類(lèi)提供了getProperty(String key)方法用來(lái)通過(guò)鍵名讀取鍵值,當(dāng)key在屬性集合中找不到時(shí)又想為key在程序中賦予一個(gè)值時(shí)可以使用public String getProperty(String key, String defaultValue)方法,這個(gè)方法的意思就是用指定的鍵在屬性列表中搜索屬性。如果在屬性列表中未找到該鍵,則接著遞歸檢查默認(rèn)屬性列表及其默認(rèn)值。如果未找到屬性,則此方法返回默認(rèn)值變量:
- //獲取屬性值,sitename已在文件中定義
- System.out.println("獲取屬性值:sitename=" + prop.getProperty("sitename"));
- //獲取屬性值,country未在文件中定義,將在此程序中返回一個(gè)默認(rèn)值,但并不修改屬性文件
- System.out.println("獲取屬性值:country=" + prop.getProperty("country", "中國(guó)"));
在知道怎么讀取屬性文件之后我們還有一個(gè)很重要的事情就是要修改和添加新的屬性到屬性文件,這里就是使用public void store(OutputStream out, String comments)方法,這個(gè)方法是將屬性集合寫(xiě)到一個(gè)OutputStream流中,同InputStream流一樣,這里同樣是使用其子類(lèi) FileOutputStream(String name),這里就不多說(shuō)了。
在保存屬性集合到文件之前,我們還有一件事情就是如何修改和添加新的屬性到屬性集合,這里使用了一個(gè)方法就是 setProperty(String key, String value),這個(gè)方法就是當(dāng)屬性集合中存在指定的key時(shí),就修改這個(gè)key的值,如果不存在,就新建一個(gè)key,同樣是通過(guò)鍵值關(guān)系保存的,但值得注意的是,Properties類(lèi)繼承自Hashtable,所以也可以用Hashtable的put和putAll方法保存,但強(qiáng)烈反對(duì)使用這兩個(gè)方法,因?yàn)樗鼈冊(cè)试S調(diào)用方插入其鍵或值不是 Strings 的項(xiàng)。相反,應(yīng)該使用 setProperty 方法。如果在“有危險(xiǎn)”的 Properties 對(duì)象(即包含非 String 的鍵或值)上調(diào)用 store 或 save 方法,則該調(diào)用將失敗。那好,下面我們就來(lái)看看修改、添加和保存屬性的程序:
- //修改sitename的屬性值
- prop.setProperty("sitename", "Boxcode");
- //添加一個(gè)新的屬性studio
- prop.setProperty("studio", "Boxcode Studio");
- //文件輸出流
- FileOutputStream fos = new FileOutputStream("prop.properties");
- //將Properties集合保存到流中
- prop.store(fos, "Copyright (c) Boxcode Studio");
- fos.close();//關(guān)閉流
接下就是整個(gè)程序的源代碼:
- 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();// 屬性集合對(duì)象
- FileInputStream fis = new FileInputStream("prop.properties");// 屬性文件輸入流
- prop.load(fis);// 將屬性文件流裝載到Properties對(duì)象中
- fis.close();// 關(guān)閉流
- // 獲取屬性值,sitename已在文件中定義
- System.out.println("獲取屬性值:sitename=" + prop.getProperty("sitename"));
- // 獲取屬性值,country未在文件中定義,將在此程序中返回一個(gè)默認(rèn)值,但并不修改屬性文件
- System.out.println("獲取屬性值:country=" + prop.getProperty("country", "中國(guó)"));
- // 修改sitename的屬性值
- prop.setProperty("sitename", "Boxcode");
- // 添加一個(gè)新的屬性studio
- prop.setProperty("studio", "Boxcode Studio");
- // 文件輸出流
- FileOutputStream fos = new FileOutputStream("prop.properties");
- // 將Properties集合保存到流中
- prop.store(fos, "Copyright (c) Boxcode Studio");
- fos.close();// 關(guān)閉流
- }
- }