利用Java的Properties類讀取配置文件信息
在我們平時(shí)寫程序的時(shí)候,有些參數(shù)是經(jīng)常改變的,而這種改變不是我們預(yù)知的。比如說(shuō)我們開發(fā)了一個(gè)操作數(shù)據(jù)庫(kù)的模塊,在開發(fā)的時(shí)候我們連接本地的數(shù)據(jù)庫(kù)那么IP,數(shù)據(jù)庫(kù)名稱,表名稱,數(shù)據(jù)庫(kù)主機(jī)等信息是我們本地的,要使得這個(gè)操作數(shù)據(jù)的模塊具有通用性,那么以上信息就不能寫死在程序里。通常我們的做法是用配置文件來(lái)解決。
各種語(yǔ)言都有自己所支持的配置文件類型。比如Python,他支持.ini文件。因?yàn)樗麅?nèi)部有一個(gè)ConfigParser類來(lái)支持.ini文件的讀寫,根據(jù)該類提供的方法程序員可以自由的來(lái)操作.ini文件。而在Java中,Java支持的是.properties文件的讀寫。JDK內(nèi)置的java.util.Properties類為我們操作.properties文件提供了便利。
一..properties文件的形式
==========================================================
#以下為服務(wù)器、數(shù)據(jù)庫(kù)信息
dbPort = localhost
databaseName = mydb
dbUserName = root
dbPassword = root
#以下為數(shù)據(jù)庫(kù)表信息
dbTable = mytable
#以下為服務(wù)器信息
ip = 192.168.0.9
在上面的文件中我們假設(shè)該文件名為:test.properties文件。其中#開始的一行為注釋信息;在等號(hào)“=”左邊的我們稱之為key;等號(hào)“=”右邊的我們稱之為value。(其實(shí)就是我們常說(shuō)的鍵-值對(duì))key應(yīng)該是我們程序中的變量。而value是我們根據(jù)實(shí)際情況配置的。
二.JDK中的Properties類
Properties類存在于胞Java.util中,該類繼承自Hashtable
,它提供了幾個(gè)主要的方法:
1.getProperty
(String key)
,
用指定的鍵在此屬性列表中搜索屬性。也就是通過(guò)參數(shù)key,得到key所對(duì)應(yīng)的value。
2.
load
(InputStream inStream)
,從輸入流中讀取屬性列表(鍵和元素對(duì))。通過(guò)對(duì)指定的文件(比如說(shuō)上面的test.properties文件)進(jìn)行裝載來(lái)獲取該文件中的所有鍵-值對(duì)。以供getProperty
(String key)
來(lái)搜索。
3.setProperty
(String key, String value)
,調(diào)用 Hashtable 的方法 put
。他通過(guò)調(diào)用基類的put方法來(lái)設(shè)置
鍵-值對(duì)。
4.store
(OutputStream out, String comments)
, 以適合使用 load
方法加載到 Properties
表中的格式,將此 Properties
表中的屬性列表(鍵和元素對(duì))寫入輸出流。與load方法相反,該方法將鍵-值對(duì)寫入到指定的文件中去。
5.clear
()
,清除所有裝載的
鍵-值對(duì)。該方法在基類中提供。
有了以上幾個(gè)方法我們就可以對(duì).properties文件進(jìn)行操作了!
三.代碼實(shí)例
package configuration;

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


/** *//**
* 讀取properties文件
* @author Qutr
*
*/
public class Configuration

...{
private Properties propertie;
private FileInputStream inputFile;
private FileOutputStream outputFile;

/** *//**
* 初始化Configuration類
*/
public Configuration()

...{
propertie = new Properties();
}

/** *//**
* 初始化Configuration類
* @param filePath 要讀取的配置文件的路徑+名稱
*/
public Configuration(String filePath)

...{
propertie = new Properties();

try ...{
inputFile = new FileInputStream(filePath);
propertie.load(inputFile);
inputFile.close();

} catch (FileNotFoundException ex) ...{
System.out.println("讀取屬性文件--->失敗!- 原因:文件路徑錯(cuò)誤或者文件不存在");
ex.printStackTrace();

} catch (IOException ex) ...{
System.out.println("裝載文件--->失敗!");
ex.printStackTrace();
}
}//end ReadConfigInfo(...)

/** *//**
* 重載函數(shù),得到key的值
* @param key 取得其值的鍵
* @return key的值
*/
public String getValue(String key)

...{

if(propertie.containsKey(key))...{
String value = propertie.getProperty(key);//得到某一屬性的值
return value;
}
else
return "";
}//end getValue(...)

/** *//**
* 重載函數(shù),得到key的值
* @param fileName properties文件的路徑+文件名
* @param key 取得其值的鍵
* @return key的值
*/
public String getValue(String fileName, String key)

...{

try ...{
String value = "";
inputFile = new FileInputStream(fileName);
propertie.load(inputFile);
inputFile.close();

if(propertie.containsKey(key))...{
value = propertie.getProperty(key);
return value;
}else
return value;

} catch (FileNotFoundException e) ...{
e.printStackTrace();
return "";

} catch (IOException e) ...{
e.printStackTrace();
return "";

} catch (Exception ex) ...{
ex.printStackTrace();
return "";
}
}//end getValue(...)

/** *//**
* 清除properties文件中所有的key和其值
*/
public void clear()

...{
propertie.clear();
}//end clear();

/** *//**
* 改變或添加一個(gè)key的值,當(dāng)key存在于properties文件中時(shí)該key的值被value所代替,
* 當(dāng)key不存在時(shí),該key的值是value
* @param key 要存入的鍵
* @param value 要存入的值
*/
public void setValue(String key, String value)

...{
propertie.setProperty(key, value);
}//end setValue(...)

/** *//**
* 將更改后的文件數(shù)據(jù)存入指定的文件中,該文件可以事先不存在。
* @param fileName 文件路徑+文件名稱
* @param description 對(duì)該文件的描述
*/
public void saveFile(String fileName, String description)

...{

try ...{
outputFile = new FileOutputStream(fileName);
propertie.store(outputFile, description);
outputFile.close();

} catch (FileNotFoundException e) ...{
e.printStackTrace();

} catch (IOException ioe)...{
ioe.printStackTrace();
}
}//end saveFile(...)
public static void main(String[] args)

...{
Configuration rc = new Configuration(".\config\test.properties");//相對(duì)路徑
String ip = rc.getValue("ipp");//以下讀取properties文件的值
String host = rc.getValue("host");
String tab = rc.getValue("tab");
System.out.println("ip = " + ip + "ip-test leng = " + "ip-test".length());//以下輸出properties讀出的值
System.out.println("ip's length = " + ip.length());
System.out.println("host = " + host);
System.out.println("tab = " + tab);

Configuration cf = new Configuration();
String ipp = cf.getValue(".\config\test.properties", "ip");
System.out.println("ipp = " + ipp);
// cf.clear();
cf.setValue("min", "999");
cf.setValue("max", "1000");
cf.saveFile(".\config\save.perperties", "test");
// Configuration saveCf = new Configuration();
// saveCf.setValue("min", "10");
// saveCf.setValue("max", "1000");
// saveCf.saveFile(".\config\save.perperties");
}//end main()
}//end class ReadConfigInfo

四.小結(jié)
通過(guò)上面的例子不難看出,在Java中操作配置文件是非常簡(jiǎn)單的。在一個(gè)需要用到大量配置信息的模塊或系統(tǒng)里,我們有必要封裝一個(gè)專門的類來(lái)共使用。通過(guò)最后的main函數(shù)調(diào)用,相信大家可以看出該類的用法。不足指出希望大家多多指點(diǎn)。
關(guān)鍵字:Properties, 配置文件
Trackback: http://tb.blog.csdn.net/TrackBack.aspx?PostId=973391
注:本文件來(lái)自
天火——Qutr的專欄 http://blog.csdn.net/qutr/archive/2006/07/25/973391.aspx