在我们平时写程序的时候,有些参数是经常改变的,而这种改变不是我们预知的。比如说我们开发了一个操作数据库的模块,在开发的时候我们连接本地的数据库那么 IP ,数据库名称,表名称,数据库主机等信息是我们本地的,要使得这个操作数据的模块具有通用性,那么以上信息就不能写死在程序里。通常我们的做法是用配置文件来解决。
各种语言都有自己所支持的配置文件类型。比如 Python ,他支持 .ini 文件。因为他内部有一个 ConfigParser 类来支持 .ini 文件的读写,根据该类提供的方法程序员可以自由的来操作 .ini 文件。而在 Java 中, Java 支持的是 .properties 文件的读写。 JDK 内置的 java.util.Properties 类为我们操作 .properties 文件提供了便利。
# 开始的一行为注释信息;在等号“ = ”左边的我们称之为 key ;等号“ = ”右边的我们称之为 value 。(其实就是我们常说的键 - 值对) key 应该是我们程序中的变量。而 value 是我们根据实际情况配置的。
1. JDK 中的 Properties 类 Properties 类存在于胞 Java.util 中,该类继承自 Hashtable ,它提供了几个主要的方法: 1.getProperty ( String key) ,用指定的键在此属性列表中搜索属性。也就是通过参数 key ,得到 key 所对应的 value 。
load ( InputStream inStream) ,从输入流中读取属性列表(键和元素对)。通过对指定的文件(比如说上面的 test.properties 文件)进行装载来获取该文件中的所有键 - 值对。以供 getProperty ( String key) 来搜索。 3. setProperty ( String key, String value) ,调用 Hashtable 的方法 put 。他通过调用基类的put方法来设置 键 - 值对。
4. store ( OutputStream out, String comments) , 以适合使用 load 方法加载到 Properties 表中的格式,将此 Properties 表中的属性列表(键和元素对)写入输出流。与 load 方法相反,该方法将键 - 值对写入到指定的文件中去。
5. clear () ,清除所有装载的 键 - 值对。该方法在基类中提供。
有了以上几个方法我们就可以对 .properties 文件进行操作了!
test.properties属性文件,放在classes类路径下,通过this.getClass().getResource("/")得到类路径
save.properties属性文件,是程序生成的属性文件,放在项目路径下
public class TestProperties {
private Properties properties;
private FileInputStream inputFile;
private FileOutputStream outputFile;
/**
* 初始化TestProperties类
*/
public TestProperties(){}
/**
* 初始化TestProperties类
* @param fileName 要读取的配置文件的路径+名称
*/
public TestProperties(String fileName){
properties = new Properties();
try{
inputFile = new FileInputStream(this.getClass().getResource("/").getPath() + fileName);
properties.load(inputFile);
inputFile.close();
}catch(FileNotFoundException ex){
System.out.println("读取属性文件--->失败!- 原因:文件路径错误或者文件不存在");
ex.printStackTrace();
}catch(IOException ex){
System.out.println("装载文件--->失败!");
ex.printStackTrace();
}
}
/**
* 重载函数,得到key的值
* @param key取得其值的键
* @return key的值
*/
public String getValue(String key){
if(properties.containsKey(key)){
String value = properties.getProperty(key);
return value;
}else{
return null;
}
}
/**
* 重载函数,得到key的值
* @param fileName properties文件的路径+文件名
* @param key取得其值的键
* @return key的值
*/
public String getValue(String fileName, String key){
try{
String value = null;
inputFile = new FileInputStream(fileName);
properties.load(inputFile);
inputFile.close();
if(properties.containsKey(key)){
value = properties.getProperty(key);
return value;
}else
return value;
}catch (FileNotFoundException e){
e.printStackTrace();
return null;
} catch (IOException e) {
e.printStackTrace();
return null;
} catch (Exception ex){
ex.printStackTrace();
return null;
}
}
/**
* 改变或添加一个key的值,当key存在于properties文件中时该key的值被value所代替,
* 当key不存在时,该key的值是value
* @param key 要存入的键
* @param value 要存入的值
*/
public void setValue(String key, String value){
properties.setProperty(key, value);
}
/**
* 将更改后的文件数据存入指定的文件中,该文件可以事先不存在。
* @param fileName 文件路径+文件名称
* @param description 对该文件的描述
*/
public void saveFile(String fileName, String description){
try {
outputFile = new FileOutputStream(fileName);
properties.store(outputFile, description);
outputFile.close();
} catch (FileNotFoundException e){
e.printStackTrace();
} catch (IOException ioe){
ioe.printStackTrace();
}
}
/**
* 清除properties文件中所有的key和其值
*/
public void clear(){
properties.clear();
}
/**
* @param args
*/
public static void main(String[] args) {
TestProperties testProperties = new TestProperties("test.properties");
//以下读取properties文件的值
String ip = testProperties.getValue("ip");
String host = testProperties.getValue("DatabasePort");
String table = testProperties.getValue("DatabaseTable");
System.out.println("=====E:/work/workbench/TEST/test/bin/test.properties=====");
System.out.println("ip = " + ip);
System.out.println("host = " + host);
System.out.println("table = " + table);
System.out.println("=====E:/work/workbench/TEST/test/save.properties=====");
String fileName = "save.properties";
testProperties.clear();
testProperties.setValue("min", "999");
testProperties.setValue("max", "1000");
testProperties.saveFile(fileName, "Test outFileStream");
System.out.println(testProperties.getValue(fileName, "min"));
System.out.println(testProperties.getValue(fileName, "max"));
}
}