Java实现配置加载机制

实战运用实例

有一份菜市场配置文件market.xml，配置了菜市场的商品，里面有两种商品，分别是苹果和鸡蛋。

    
        red
        100
    
    
        200
    

另外还有一份关于各个档口老板名字的配置文件，owner.properties

port1=Steve Jobs
port2=Bill Gates
port3=Kobe Bryant

我们先定义好如下类:MarketConfig.java

/**
 *
 *
 * @author Bean
 * @date 2016年1月21日 下午11:03:37
 * @version 1.0
 *
 */
public class MarketConfig {

    private AppleConfig appleConfig;
    private EggConfig eggConfig;
    private OwnerConfig ownerConfig;

    public AppleConfig getAppleConfig() {
        return appleConfig;
    }
    public void setAppleConfig(AppleConfig appleConfig) {
        this.appleCOnfig= appleConfig;
    }
    public EggConfig getEggConfig() {
        return eggConfig;
    }
    public void setEggConfig(EggConfig eggConfig) {
        this.eggCOnfig= eggConfig;
    }
    public OwnerConfig getOwnerConfig() {
        return ownerConfig;
    }
    public void setOwnerConfig(OwnerConfig ownerConfig) {
        this.ownerCOnfig= ownerConfig;
    }
}

AppleConfig.java

/**
 *
 *
 * @author Bean
 * @date 2016年1月21日 下午11:03:45
 * @version 1.0
 *
 */
public class AppleConfig {

    private int price;
    private String color;

    public void setPrice(int price) {
        this.price = price;
    }

    public int getPrice() {
        return this.price;
    }

    public void setColor(String color) {
        this.color = color;
    }

    public String getColor() {
        return this.color;
    }
}

EggConfig.java

/**
 *
 *
 * @author Bean
 * @date 2016年1月21日 下午11:03:58
 * @version 1.0
 *
 */
public class EggConfig {

    private int weight;

    public void setWeight(int weight) {
        this.weight = weight;
    }

    public int getWeight() {
        return this.weight;
    }
}

OwnerConfig.java

/**
 *
 *
 * @author Bean
 * @date 2016年1月21日 下午11:04:06
 * @version 1.0
 *
 */
public class OwnerConfig {

    private Map owner = new HashMap();

    public void addOwner(String portName, String owner) {
        this.owner.put(portName, owner);
    }

    public String getOwnerByPortName(String portName) {
        return this.owner.get(portName);
    }

    public Map getOwners() {
        return Collections.unmodifiableMap(this.owner);
    }
}

这个例子有两种配置加载方式，分别是Dom和Properties加载方式。

所以我们的提供者建造工厂需要制造两种提供者provider.

而且需要定义2个配置加载器，分别是:

OwnerConfigLoader

/**
 *
 *
 * @author Bean
 * @date 2016年1月21日 下午11:24:50
 * @version 1.0
 *
 */
public class OwnerConfigLoader extends AbstractConfigLoader{

    /**
     * @param provider
     */
    protected OwnerConfigLoader(IConfigProvider provider) {
        super(provider);
    }

    /* 
     * @see AbstractConfigLoader#load(java.lang.Object)
     */
    @Override
    public OwnerConfig load(Properties props) throws ConfigException {
        OwnerConfig ownerCOnfig= new OwnerConfig();

        /**
         * 利用props，设置ownerConfig的属性值
         * 
         * 此处代码省略
         */
        return ownerConfig;
    }
}

然后是MarketConfigLoader

import org.w3c.dom.Document;

/**
 *
 *
 * @author Bean
 * @date 2016年1月21日 下午11:18:56
 * @version 1.0
 *
 */
public class MarketConfigLoader extends AbstractConfigLoader {

    /**
     * @param provider
     */
    protected MarketConfigLoader(IConfigProvider provider) {
        super(provider);
    }

    /* 
     * AbstractConfigLoader#load(java.lang.Object)
     */
    @Override
    public MarketConfig load(Document document) throws ConfigException {

        MarketConfig marketCOnfig= new MarketConfig();
        AppleConfig appleCOnfig= new AppleConfig();
        EggConfig eggCOnfig= new EggConfig();
        /**
         * 在这里处理document,然后就能得到
         * AppleConfig和EggConfg
         * 
         * 此处代码省略
         */
        marketConfig.setAppleConfig(appleConfig);
        marketConfig.setEggConfig(eggConfig);

        /**
         * 由于OwnerConfig是需要properties方式来加载，不是xml
         * 所以这里要新建一个OwnerConfigLoader，委托它来加载OwnerConfig
         */

        OwnerConfigLoader ownerCOnfigLoader= new OwnerConfigLoader(ConfigProviderFactory.createPropertiesProvider(YOUR_FILE_PATH));
        OwnerConfig ownerCOnfig= ownerConfigLoader.load();

        marketConfig.setOwnerConfig(ownerConfig);

        return marketConfig;
    }
}

然后，我们在应用层面如何获取到MarketConfig呢

MarketConfigLoader marketCOnfigLoader= new MarketConfigLoader(ConfigProviderFactory.createDocumentProvider(YOUR_FILE_PATH));
MarketConfig marketCOnfig= marketConfigLoader.load();

也许有个地方会人奇怪，明明有四个配置类，为什么只有2个配置加载器呢。因为MarketConfig、EggConfig和AppleConfig，都是从同一个xml配置文件里面加载，所以只要一个Document对象，通过MarketConfigLoader就可以全部加载。

而OwnerConfig是不同的加载方式，所以需要另外一个加载器。

总结

本文提出的配置加载机制，并不能够实际帮忙加载配置，这事应该留给DOM，SAX，以及其他一些开源库如dom4j，Digester去做。但本文提出的配置加载机制能够让配置加载机制更灵活，容易扩展，并且能够集成多种配置加载方式，融合到一个机制进来，发挥各自有点。

实际上，有些软件经常需要同时从多种不同格式的配置文件里面加载配置，例如struts2，以及我最近在研究并被气到吐血的某国产开源数据库中间件软件，如果没有一套完整的配置加载机制，那么代码会比较散乱，可维护性不高。容易使人吐血。