用JFig管理配置文件

許多應用使用各種各樣的配置文件。配置在應用開發中扮演着一個重要的角色。因爲在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="[email protected]" />
      <entry key="senderAddress" value="[email protected]" />
   </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" [email protected]. />
</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>
依賴包的截圖:

文件目錄結構截圖:
運行截圖:
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章