用JFig管理配置文件

来源:互联网 发布:使命召唤12i5优化补丁 编辑:程序博客网 时间:2024/05/16 11:59

许多应用使用各种各样的配置文件。配置在应用开发中扮演着一个重要的角色。因为在java应用中,各种各样的配置文件被使用,如属性文件,XML文件等。

JFig对于Java应用来说,是一个强大且易于使用的配置工具。它允许开发者管理更多的配置文件。

列表1展示了一个JFig的一个简单的配置文件,名字为:主机名.config.xml,这儿的“主机名”就是hostname。这是因为JFig默认搜索的配置文件为<hostname>.config.xml。但是他也可以用自定义的JFigLocator使用其他的文件名。
列表1:JFig 配置文件:hostname.config.xml
<configuration>
   <section name="WebProject">
      <entry key="instance" value="base" />
      <entry key="httpHost" value="entServer" />
   </section>

   <section name="authentication">
      <entry key="userid" value="admin" />
      <entry key="pword" value="x98oln1wq" />
      <entry key="role" value="administration" />
      <entry key="rights" value="all" />
   </section>

   <section name="notification">
      <entry key="notificationType" value="general" />
      <entry key="receiverAddress" value="admin@mycomp.com" />
      <entry key="senderAddress" value="webproj_dev@mycomp.com" />
   </section>
</configuration>

JFig支持“扩展”,可以包括其他新的配置文件,新的配置文件将“继承”老的配置内容,如果新的配置内容在老的配置文件中重复,就会被“覆盖(override)”。

 

Listing 2: JFig configuration file develop.config.xml

<configuration>

<!-- Extending parent configuration -->
<include name="hostname.config.xml"/>

<!-- Overriding all entry values of a section in parent configuration-->
<section name="authentication">
    <entry key="userid" value="admin" />
    <entry key="pword" value="x98oln1wq" />
    <entry key="role" value="administration" />
    <entry key="rights" value="all" />
</section>

<!-- Overriding only select entry values of a section in base 
configuration also possible -->
 <section name="notification">
     <entry key="senderAddress" value=.webproj_dev@mycomp.com. />
</section>

</configuration>
JFig容器中有一名叫JFigLocator的组件
JFig容器中有一名叫的组件,他能扩展使用,可以自动加载不在类路径(classpath)下的本地的配置文件。依照用户定义搜索文件。JFig提供了获取系统信息的功能:语法如下:
value="$system_propert_name$"。例如:<entry key="class_Path" value="$CLASSPATH$" />
另外,JFig支持.ini文件。这对于基于window系统的应用来说很有用。
安装JFig:安装JFig是个十分简单的过程,首先下载相关的jar包(https://sourceforge.net/project/showfiles.php?group_id=85731)。JFig提供了MavenFig和AntFig类对Maven和Ant提供支持。在JFig首页(http://jfig.sourceforge.net/)列出了各种技术,综合了Log4j,weblogic和其他工具。
在安装完JFig和必要的配置文件后,现在我们写一段应用代码看如何使用它。
列表3:JFig初始化代码
try {
   JFig.initialize();

} catch (JFigException e) {
   e.getMessage();
}
于此JFig类的initialize()将会初始化JFig's一个也是仅有的一个实例(JFig是基于单实例的)。
在初始化后,配置值可以在应用中使用如下的JFig方法:
  • getValue(String section_name, String key_name)在给定的section_name,返回一个给定key_name的value值。否则抛出JFigException异常。 
    String uid = JFig.getInstance().getValue("authentication","userid");


      
  • getVaue(String section_name, String key_name, String defaultValue): 在给定的section_name,返回一个给定key_name的value值。假如值不存在,它将返回一个默认值。
    String uid = JFig.getInstance().getValue("authentication","userid","guest"); 
  • setConfigurationValue(String section_name, String key_name, String value): Sets the configuration value; in other words, the value of the given key_name in the given section_name with the given value. Rarely used, because configuration values are usually set during the initial parsing of configuration files.
    Usage:  
    JFig.setConfigurationValue(("authentication", "userid","developer");
  • reprocessConfiguration(): 该方法允许你在系统运行时修改配置文件,然后重新处理这些文件。在运行系统中通过GUI或者其他机制可以很容易的调用该方法。JFig允许你实现一个JFigListener来接收JFig被值更改的通知。大多数情况下,重新处理配置文件后,在需要属性值时直接调用JFig已经足够,并不需要Listener。有些情况,有人可能只想初始化一个File对象一次,如果在JFig的属性值被改变时想重新初始化该File对象,则使用JFigListener。
    JFig支持多种设置系统属性的方法。setSectionAsProperties(sectionName)方法允许用户将JFig的section设置成系统属性或者其他的Properties对象。
    还有一种方法是在JFig的配置文件中定义一个名为properties的section,该section中的属性都将被设置成系统属性。(可能翻译不准确,把一段英文加上:Reprocesses configuration on a running application and creates a new configuration directory containing all JFig values. Used when a change in the configuration values occurs)
    JFig.getInstance().reprocessConfiguration();
  • printConfigurationDictionary(): 打印出某一JFig实例的所有JFig值在控制台上。用于监测目的。 
    JFig.getInstance().printConfigurationDictionary();

下面还有一些JFig 方法,可能也是很有帮助的。

  • getIntegerValue(String sectionName, String keyName, String defaultValue)  
  • getFloatValue(String sectionName, String keyName, String defaultValue)  
  • getBooleanValue(String sectionName, String keyName, String defaultValue)  
  • getArrayValue(String sectionName, String keyName)  
  • getEntriesStartingWith(String sectionName, String keyName)  
  • getValuesStartingWith(String sectionName, String keyValue)  
  • getSection(String sectionName)  
  • getSectionAsProperties(String sectionName)  
  • addConfigEventListener(JFigListener listener)  

如要了解过多的JFig方法,请参考其javadoc文档。

下面给出一个小例子:
--------------------------------------------------

package com.myIfig;

import org.igfay.jfig.JFigLocator;
import org.igfay.jfig.JFigIF;
import org.igfay.jfig.JFig;

import java.util.Properties;
import java.util.Enumeration;

public class MyMain {
    private static final String DAO_CONFIG_FILE = "com/myIfig/dao.xml";

    public static void main(String[] args) {
        JFigLocator jfigLocator = new JFigLocator(DAO_CONFIG_FILE);
        JFigIF daoConfig = JFig.getInstance(jfigLocator);
        Properties prop = daoConfig.getSectionAsProperties("DAO");
        Enumeration enumsection = prop.keys();
        while (enumsection.hasMoreElements()) {
            String daoIface = (String) enumsection.nextElement();
            String daoImpl = prop.getProperty(daoIface);
            System.out.println("**** " + daoIface + "  " + daoImpl);
        }
        System.out.println(">>>>");
    }
}
dao2.xml
<?xml version="1.0" encoding="UTF-8" ?>
<configuration>
    <section name="DAO">
        <entry key="com.myfig.MyMain2" value="myMain9"></entry>
    </section>
</configuration>
依赖包的截图:

文件目录结构截图:
运行截图:
原创粉丝点击