无论是有图形化的选项配置对话框,或者是系统提供的注册表,文本形式的本地配置文件依然是最牢靠、应用最广泛的配置信息保存形式。配置信息的一般模式就是一个配置项对应一个值,前者一般是个字符串,后者可能是数字或者字符串或者别的什么。在传统win32编程中有系统提供的api供我们解读.ini文件,后来也有操作注册表的封装好的api,在.net中更是有解读XML形式.config文件的现成方法。在Java中,对配置文件的使用进行封装也是十分有意义的。
封装应该达到这样的效果:应用只管从配置信息进行按名读取值、设置值、保存等操作,而不需要关心具体以什么文件格式保存、如何解析。文件格式(纯文本?XML?数据库?)、IO方式(本地文件?远程文件?控制台流?)在封装类内部的变更,都不会影响应用对配置信息的感知。
从键名-值的对应关系以及文件的存取,我们最容易想到的就是Java.util.Properties对象,他是HashTable的子类,保存的就是很多组键名-值的对应二原组,并提供快速的查询和直接的从文件读取、保存为文件的方法。具体请参考相关文档,我们直接看程序。
首先自定义一个异常:
public class ConfigurationException extends Exception{ public ConfigurationException(){} public ConfigurationException(String msg){ super(msg); }}
然后是我们的封装类:
public class Configuration { private Properties config=new Properties();//记录配置项 private String fn=null;//记录配置文件名
//此构造方法用于新建配置文件 public Configuration(){}
//从指定文件名读入配置信息 public Configuration(String fileName) throws ConfigurationException { try { FileInputStream fin = new FileInputStream(fileName); config.load(fin); //载入文件 fin.close(); } catch (IOException ex) { throw new ConfigurationException ("无法读取指定的配置文件:"+fileName); } fn=fileName; }
//指定配置项名称,返回配置值 public String getValue(String itemName){ return config.getProperty(itemName); }
//指定配置项名称和默认值,返回配置值 public String getValue(String itemName, String defaultValue){ return config.getProperty(itemName,defaultValue); }
//设置配置项名称及其值 public void setValue(String itemName,String value){ config.setProperty(itemName,value); return; }
//保存配置文件,指定文件名和抬头描述 public void saveFile(String fileName,String description) throws ConfigurationException { try { FileOutputStream fout = new FileOutputStream(fileName); config.store(fout, description);//保存文件 fout.close(); } catch (IOException ex) { throw new ConfigurationException ("无法保存指定的配置文件:"+fileName); } }
//保存配置文件,指定文件名 public void saveFile(String fileName) throws ConfigurationException { saveFile(fileName,""); }
//保存配置文件,采用原文件名 public void saveFile() throws ConfigurationException { if(fn.length()==0) throw new ConfigurationException ("需指定保存的配置文件名"); saveFile(fn); }}
从这个封装类我们可以看到,实例化对象的时候我们可以指定一个文件名使得从中读取配置信息,通过getValue方法取得属性值,setValue方法设置属性值,saveFile方法保存文件。然后我们具体来看看如何使用:
//SetConfig.Javaimport configuration.*;//包含这个包方能使用配置类import Java.io.*;
public class SetConfig { public static void main(String[] args) { try { Configuration config = new Configuration(); //设置一些属性值 config.setValue("Max_Users_Count", "50"); config.setValue("Max_OpenedFile_Count", "20"); //保存文件 config.saveFile("system.conf", "Sytem Global Configuration"); } catch (ConfigurationException ex) { //捕获我们自定义的异常 ex.printStackTrace(); } }}
这段程序新建了一个配置,设置了两个配置项:Max_Users_Count为50;Max_OpenedFile_Count为20。最后将这个配置保存为system.conf文件,并加入抬头注释"Sytem Global Configuration"。执行之后,在程序所在目录下产生了一个system.conf文件,我们用纯文本编辑器打开看看内容到底是什么:
可以看到,第一行写入了我们加入的抬头注释,第二行自动产生了一个时间,后面两行用<配置项名称>=<配置值>的形式记录了配置信息。下面我们来读取这个配置文件:
public class ReadConfig { public static void main(String[] args) { try { //读取指定文件 Configuration config = new Configuration("system.conf"); //获取特定值 System.out.println (config.getValue("Max_Users_Count") + " users can be actived at the same time"); //指定默认值 System.out.println (config.getValue("Max_OpenedFile_Count", "10") + " files can be opened at the same time"); } catch (ConfigurationException ex) { ex.printStackTrace(); } }}
系统输出了
这样我们的封装类可以胜任普通的配置信息操作工作了。而且对于大多数的情况,这个类也足够用了。这里的代码都是可复用的,大家可以直接拷贝到自己的工程中去。最后说明:这些属性值当然可以自己在文件里面改动,而且这也是配置文件最常见的使用方式;#号开头的都表示注释,可以任意添加和删除。
任务完成了,但是还并不完美。采用Properties最大的方便就是有现成的查询、设置、文件存取方法,但是这样的<配置项名称>=<配置值>格式只是方便了在Java中的使用,考虑到系统将来的扩展性或者开发平台的迁移,都是欠妥的。下一次我们来试试利用DOM封装XML格式的配置文件。
<script type="text/javascript"> </script> <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> </script>