Java中封装配置文件(1)-使用Properties

原创 2004年08月26日 16:19:00

http://blog.csdn.net/oxware/archive/2004/08/03/59609.aspx

无论是有图形化的选项配置对话框,或者是系统提供的注册表,文本形式的本地配置文件依然是最牢靠、应用最广泛的配置信息保存形式。配置信息的一般模式就是一个配置项对应一个值,前者一般是个字符串,后者可能是数字或者字符串或者别的什么。在传统win32编程中有系统提供的api供我们解读.ini文件,后来也有操作注册表的封装好的api,在.net中更是有解读XML形式.config文件的现成方法。在Java中,对配置文件的使用进行封装也是十分有意义的。

  封装应该达到这样的效果:应用只管从配置信息进行按名读取值、设置值、保存等操作,而不需要关心具体以什么文件格式保存、如何解析。文件格式(纯文本?XML?数据库?)、IO方式(本地文件?远程文件?控制台流?)在封装类内部的变更,都不会影响应用对配置信息的感知。

  从键名-值的对应关系以及文件的存取,我们最容易想到的就是java.util.Properties对象,他是HashTable的子类,保存的就是很多组键名-值的对应二原组,并提供快速的查询和直接的从文件读取、保存为文件的方法。具体请参考相关文档,我们直接看程序。

  首先自定义一个异常:

//ConfigurationException.java
package configuration;

public class ConfigurationException extends Exception{
  public ConfigurationException(){}
  public ConfigurationException(String msg){
    super(msg);
  }
}

  然后是我们的封装类:

//Configuration.java
package configuration;
import java.io.*;
import java.util.*;
import configuration.*;

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.java
import 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文件,我们用纯文本编辑器打开看看内容到底是什么:

#Sytem Global Configuration
#Mon Aug 02 23:43:39 PDT 2004
Max_OpenedFile_Count=20
Max_Users_Count=50

  可以看到,第一行写入了我们加入的抬头注释,第二行自动产生了一个时间,后面两行用<配置项名称>=<配置值>的形式记录了配置信息。下面我们来读取这个配置文件:

//ReadConfig.java
import configuration.*;

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();
    }
  }
}

  系统输出了

50 users can be actived at the same time
20 files can be opened at the same time
这样的信息。表明我们成功读取了配置信息。

  这样我们的封装类可以胜任普通的配置信息操作工作了。而且对于大多数的情况,这个类也足够用了。这里的代码都是可复用的,大家可以直接拷贝到自己的工程中去。最后说明:这些属性值当然可以自己在文件里面改动,而且这也是配置文件最常见的使用方式;#号开头的都表示注释,可以任意添加和删除。

  任务完成了,但是还并不完美。采用Properties最大的方便就是有现成的查询、设置、文件存取方法,但是这样的<配置项名称>=<配置值>格式只是方便了在Java中的使用,考虑到系统将来的扩展性或者开发平台的迁移,都是欠妥的。下一次我们来试试利用DOM封装XML格式的配置文件。

JDBC中关于封装和读取配置文件properties的问题

JDBC中关于封装和读取配置文件proterties的问题。   在这个实例中,我们会对JDBC做进一步的封装。并且还为其写了资源配置文件 Db.properties.这是要注意的。我们右键src...
  • li12412414
  • li12412414
  • 2016年08月13日 01:14
  • 1998

Spring读取外部的.properties文件内容并设置给bean的两种方法

Spring读取外部的.properties文件内容并设置给bean的两种方法
  • canot
  • canot
  • 2016年01月13日 19:42
  • 3493

【JavaMail开发总结】配置文件形式--发送邮件程序

在上一篇中简单的实现了一个发送邮件功能的程序,今天用配置文件的方式来实现,大致思路一致,示例代码如下: package com.javamail.test.demo;import java.io.IO...
  • u010202304
  • u010202304
  • 2015年08月09日 17:10
  • 1939

JAVA读取classess下的.properties配置文件封装类,linux和windows上都可以使用

http://hi.baidu.com/myzhijie/item/3f73e988aef52bd85e0ec131import java.io.BufferedInputStream; imp...
  • daditao
  • daditao
  • 2014年01月06日 17:54
  • 2569

使用java.util.Properties读取配置文件信息

java中的properties文件是一种配置文件,主要用于表达配置信息,文件类型为*.properties,格式为文本文件,文件的内容是格式是"键=值"的格式 java.util.Properti...
  • jiang12309
  • jiang12309
  • 2018年01月16日 18:49
  • 7

Java 反射将配置文件数据加载到对象属性中Reflect与Properties使用

Java 反射将配置文件数据加载到对象属性中Reflect与Properties使用 Java 反射 可以根据类名找到相应的类,也可以将配置文件中的值加载到对应属性中。 ...
  • wangming520liwei
  • wangming520liwei
  • 2017年12月01日 18:16
  • 74

使用java读取配置文件(ini、properties)

JDK自带的Properties可以读取properties类型的文件,但是对于ini文件进行读取时遇到转义字符时会有问题,例如当遇到STOREPATH = d:\test\,用Properties类...
  • geniusxiaoyu
  • geniusxiaoyu
  • 2011年10月20日 15:53
  • 4255

log4j的使用与java中properties配置文件加载

日志是我们在写代码中经常会用到的,程序出错了我们也需要去查看日志来调错,对于像我们这一些新人来说,怎么去使用日志就比较陌生,下面我将我学习的过程分享一下: 1.需要找到一个log4j包,我使用的是l...
  • u013516035
  • u013516035
  • 2014年12月02日 23:01
  • 7755

使用java.util.Properties类读写配置文件

J2SE 1.5以前的版本要求直接使用XML解析器来装载配置文件并存储设置,虽说也并非难事,相比java.util.Properties却要做额外的解析工作。而java.util.Properties...
  • u013673245
  • u013673245
  • 2015年12月14日 17:46
  • 357

Java zip解压,并遍历zip中的配置文件 .cfg或.properties

  • 2017年12月04日 09:32
  • 6KB
  • 下载
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:Java中封装配置文件(1)-使用Properties
举报原因:
原因补充:

(最多只允许输入30个字)