Properties文件
Properties 文件是配置程序的一種常用作法. Commons Configuration當(dāng)然支持這種格式并且增強(qiáng) java.util.Properties 這個(gè)類(lèi) 這一節(jié)就是介紹PropertiesConfiguration 類(lèi)的一些特性。
Loading 加載
At 首先,假設(shè)有個(gè)應(yīng)用程序的所有配置信息都在一個(gè)叫“usergui.properties ”的properties 文件里,文件的內(nèi)容如下:
# Properties definining the GUI
colors.background = #FFFFFF
要加載這個(gè)文件,你可以像下面這樣寫(xiě):
Configuration config = new PropertiesConfiguration("usergui.properties");
If 如果你可以使用文件的絕對(duì)路徑,那么這個(gè)文件會(huì)自動(dòng)在下面幾個(gè)地方被搜尋:
當(dāng)前目錄
用戶(hù)主目錄
classpath
Includes 包含文件
If a 如果property文件里有叫做 "include"的鍵值對(duì),并且值是一個(gè) property文件名, 這么個(gè)文件也將被自動(dòng)包含進(jìn)配置信息中,舉例如下:
# usergui.properties
include = colors.properties
include = sizes.properties
# colors.properties
colors.background = #FFFFFF
Automatic Reloading 自動(dòng)重新加載
A common issue with properties file is to handle the reloading of the file when it changes. 通常你需要開(kāi)啟一個(gè)線(xiàn)程來(lái)監(jiān)視配置文件的時(shí)間,并在文件被修改后重新加載進(jìn)來(lái)。 Commons Configuration集成了這個(gè)加載機(jī)制, 如果需要使用自動(dòng)加載,只需要在年id配置信息里聲明一個(gè)自動(dòng)重載策略:
PropertiesConfiguration config = new PropertiesConfiguration("usergui.properties");
config.setReloadingStrategy(new FileChangedReloadingStrategy());
現(xiàn)在你隨時(shí)手動(dòng)修改了usergui.properties, 配置信息都能夠自動(dòng)刷新,修改后的值立即在程序里生效。
Saving 保存
調(diào)用save()方法就可以保存你的配置:
PropertiesConfiguration config = new PropertiesConfiguration("usergui.properties");
config.setProperty("colors.background", "#000000);
config.save();
你也可以復(fù)制一份配置保存到另外一個(gè)文件:
PropertiesConfiguration config = new PropertiesConfiguration("usergui.properties");
config.setProperty("colors.background", "#000000);
config.save("usergui.backup.properties);
如果你不想在配置信息改變之后費(fèi)心的手動(dòng)保存文件,你可以激活自動(dòng)保存模式::
PropertiesConfiguration config = new PropertiesConfiguration("usergui.properties");
config.setAutoSave(true);
config.setProperty("colors.background", "#000000); // the configuration is saved after this call
Lists and arrays
Commons Configuration 可以很輕松的返回一組值, 例如你的文件包含了用逗號(hào)分割的一組數(shù)據(jù):
# chart colors
colors.pie = #FF0000, #00FF00, #0000FF
你不用手動(dòng)拆分字符串,可以直接作為數(shù)組返回:
String[] colors = config.getStringArray("colors.pie");
另外一種作法, 你可以通過(guò)多行的同名鍵值對(duì),來(lái)返回一組值。
# chart colors
colors.pie = #FF0000;
colors.pie = #00FF00;
colors.pie = #0000FF;
變量竄改
如果你熟悉Ant或者M(jìn)aven,你肯定已經(jīng)用到 (像 ${token})這樣可以在配置文件被加載時(shí)自動(dòng)擴(kuò)充的變量。 Commons Configuration 也支持這樣的特性, 下面是個(gè)示例:
application.name = Killer App
application.version = 1.6.2
application.title = ${application.name} ${application.version}
特殊字符
如果你需要用到一些特殊字符,比如換行符,制表符,或者unicode字符,你需要進(jìn)行字符轉(zhuǎn)義,字符串分隔符(默認(rèn)的是逗號(hào)“,”)也需要被轉(zhuǎn)義 :
key = This \n string \t contains \, escaped \\ characters \u0020
原文地址:[url=http://jakarta.apache.org/commons/configuration/howto_properties.html]http://jakarta.apache.org/commons/configuration/howto_properties.html[/url] ( lizongbo @ gmail.com) Properties文件 Properties 文件是配置程序的一種常用作法. Commons Configuration當(dāng)然支持這種格式并且增強(qiáng) java.util.Properties 這個(gè)類(lèi) 這一節(jié)就是介紹PropertiesConfiguration 類(lèi)的一些特性。 Loading 加載 At 首先,假設(shè)有個(gè)應(yīng)用程序的所有配置信息都在一個(gè)叫“usergui.properties ”的properties 文件里,文件的內(nèi)容如下: # Properties definining the GUI colors.background = #FFFFFF 要加載這個(gè)文件,你可以像下面這樣寫(xiě): Configuration config = new PropertiesConfiguration("usergui.properties"); If 如果你可以使用文件的絕對(duì)路徑,那么這個(gè)文件會(huì)自動(dòng)在下面幾個(gè)地方被搜尋: 當(dāng)前目錄 用戶(hù)主目錄 classpath Includes 包含文件 If a 如果property文件里有叫做 "include"的鍵值對(duì),并且值是一個(gè) property文件名, 這么個(gè)文件也將被自動(dòng)包含進(jìn)配置信息中,舉例如下: # usergui.properties include = colors.properties include = sizes.properties # colors.properties colors.background = #FFFFFF Automatic Reloading 自動(dòng)重新加載 A common issue with properties file is to handle the reloading of the file when it changes. 通常你需要開(kāi)啟一個(gè)線(xiàn)程來(lái)監(jiān)視配置文件的時(shí)間,并在文件被修改后重新加載進(jìn)來(lái)。 Commons Configuration集成了這個(gè)加載機(jī)制, 如果需要使用自動(dòng)加載,只需要在年id配置信息里聲明一個(gè)自動(dòng)重載策略: PropertiesConfiguration config = new PropertiesConfiguration("usergui.properties"); config.setReloadingStrategy(new FileChangedReloadingStrategy()); 現(xiàn)在你隨時(shí)手動(dòng)修改了usergui.properties, 配置信息都能夠自動(dòng)刷新,修改后的值立即在程序里生效。 Saving 保存調(diào)用save()方法就可以保存你的配置: PropertiesConfiguration config = new PropertiesConfiguration("usergui.properties"); config.setProperty("colors.background", "#000000); config.save(); 你也可以復(fù)制一份配置保存到另外一個(gè)文件: PropertiesConfiguration config = new PropertiesConfiguration("usergui.properties"); config.setProperty("colors.background", "#000000); config.save("usergui.backup.properties); 如果你不想在配置信息改變之后費(fèi)心的手動(dòng)保存文件,你可以激活自動(dòng)保存模式:: PropertiesConfiguration config = new PropertiesConfiguration("usergui.properties"); config.setAutoSave(true); config.setProperty("colors.background", "#000000); // the configuration is saved after this call Lists and arrays Commons Configuration 可以很輕松的返回一組值, 例如你的文件包含了用逗號(hào)分割的一組數(shù)據(jù): # chart colors colors.pie = #FF0000, #00FF00, #0000FF 你不用手動(dòng)拆分字符串,可以直接作為數(shù)組返回: String[] colors = config.getStringArray("colors.pie"); 另外一種作法, 你可以通過(guò)多行的同名鍵值對(duì),來(lái)返回一組值。 # chart colors colors.pie = #FF0000; colors.pie = #00FF00; colors.pie = #0000FF; 變量竄改如果你熟悉Ant或者M(jìn)aven,你肯定已經(jīng)用到 (像 ${token})這樣可以在配置文件被加載時(shí)自動(dòng)擴(kuò)充的變量。 Commons Configuration 也支持這樣的特性, 下面是個(gè)示例: application.name = Killer App application.version = 1.6.2 application.title = ${application.name} ${application.version} 特殊字符如果你需要用到一些特殊字符,比如換行符,制表符,或者unicode字符,你需要進(jìn)行字符轉(zhuǎn)義,字符串分隔符(默認(rèn)的是逗號(hào)“,”)也需要被轉(zhuǎn)義 : key = This \n string \t contains \, escaped \\ characters \u0020