java实现配置加载机制-mile米乐体育

前言

现如今几乎大多数java应用,例如我们耳熟能详的tomcat, struts2, netty…等等数都数不过来的软件,要满足通用性,都会提供配置文件供使用者定制功能。

甚至有一些例如netty这样的网络框架,几乎完全就是由配置驱动,这样的软件我们也通常称之为”微内核架构”的软件。你把它配置成什么,它就是什么。

it is what you configure it to be.

最常见的配置文件格式是xml, properties等等文件。

本文探讨加载配置中最通用也是最常见的场景,那就是把一个配置文件映射成java里的pojo对象.

并探讨如何实现不同方式的加载,例如,有一些配置是从本地xml文件里面加载的,而有一些配置需要从本地properties文件加载,

更有甚者,有一些配置需要通过网络加载配置。

如何实现这样一个配置加载机制,让我们拥有这个机制后,不会让加载配置的代码散布得到处都是,并且可扩展,可管理。

配置加载器

首先,我们需要一个配置加载器,而这个配置加载器是可以有多种不同的加载方式的,因此,我们用一个接口来描述它,如下所示:

/**  *   *  * @author bean  * @date 2016年1月21日 上午11:47:12  * @version 1.0  *  */ public interface iconfigloader {      /**      * load the config typed by t      *      * @return      * @throws configexception      */     public t load() throws configexception; }

可是,为什么我们需要在这个接口上声明泛型 ?

很明显,当我们要使用一个配置加载器时,你得告诉这个配置加载器你需要加载后得到什么结果。

例如,你希望加载配置后得到一个 appleconfig 对象,那么你就可以这么去使用上述定义的接口:

    iconfigloader loader = new appleconfigloader();     appleconfig config = loader.load();

于是你将配置文件里的信息转化成了一个appleconfig对象,并且你能得到这个appleconfig对象实例。

到目前,貌似只要我们的 appleconfigloader 里面实现了怎么加载配置文件的具体劳动,我们就可以轻易加载配置了。

可以这么说,但是不是还没有考虑到,配置可能通过不同的方式加载呢,比如通过properties加载,通过dom方式加载,通过sax方式加载,或者通过某些第三方的开源库来加载。

因此,除了 配置加载器 ,我们还需要另外一种角色,配置加载方式的提供者。暂且,我们就叫它iconfigprovider。

配置加载方式的提供者

配置加载方式的提供者可以提供一种加载方式给配置加载器,换言之,提供一个 对象 给配置加载器。

  • 如果通过dom方式加载,那么 提供者 提供一个 document 对象给 加载器
  • 如果通过properties方式加载,那么 提供者 提供一个 properties 对象给 加载器
  • 如果通过第三方类库提供的方式加载,比如apache-commons-digester3(tomcat的配置加载),那么 提供者 提供一个 digester 对象给 加载器

提供者的职责就是 提供 ,仅此而已,只提供配置加载器所需要的对象,但它本身并不参与配置加载的劳动。

我们用一个接口 iconfigprovider 来定义这个 提供者

/**  *  *  * @author bean  * @date 2016年1月21日 上午11:54:28  * @version 1.0  *  */ public interface iconfigprovider {      /**      * provide a config source used for loading config      *      * @return      * @throws configexception      */     public t provide() throws configexception; }

这里为什么又会有 来声明泛型呢?

如果需要一个提供者,那么至少得告诉这个提供者它该提供什么吧。

因此,一个提供者会提供什么,由这个来决定。

同时,到这里,我们可以先建造一个工厂,让它来生产特定的提供者:

/**  *  *  * @author bean  * @date 2016年1月21日 上午11:56:28  * @version 1.0  *  */ public class configproviderfactory {      private configproviderfactory() {         throw new unsupportedoperationexception("unable to initialize a factory class : "                   getclass().getsimplename());     }      public static iconfigprovider createdocumentprovider(string filepath) {         return new documentprovider(filepath);     }      public static iconfigprovider createpropertiesprovider(string filepath) {         return new propertiesprovider(filepath);     }      public static iconfigprovider createdigesterprovider(string filepath) {             return new digesterprovider(filepath);     } }

可以开始实现具体配置加载器了?

还不行!

到这里,假设我们有一个配置文件,叫apple.xml。而且我们要通过dom方式把这一份apple.xml加载后变成appleconfig对象。

那么,首先我要通过提供者工厂给我制造一个能提供document的提供者。然后拿到这个提供者,我就可以调用它的provide方法来获得document对象,有了document对象,那么我就可以开始来加载配置了。

可是,如果要加载bananaconfig、pearconfig…….呢,其步骤都是一样的。因此我们还要有一个抽象类,来实现一些默认的共同行为。

/**  *  *  * @author bean  * @date 2016年1月21日 上午11:59:19  * @version 1.0  *  */ public abstract class abstractconfigloader  implements iconfigloader{      protected iconfigprovider provider;      protected abstractconfigloader(iconfigprovider provider) {         this.provider = provider;     }      /*      * @see iconfigloader#load()      */     @override     public t load() throws configexception {         return load(getprovider().provide());     }      public abstract t load(u loadersource) throws configexception;      protected iconfigprovider getprovider() {         return this.provider;     } }

每个配置加载器都有一个带参数构造器,接收一个provider。

泛型指明了我要加载的是appleconfig还是bananconfig,泛型 指明了要用什么加载方式加载,是document呢,还是properties,或者其他。

实战运用实例

有一份菜市场配置文件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,以及我最近在研究并被气到吐血的某国产开源数据库中间件软件,如果没有一套完整的配置加载机制,那么代码会比较散乱,可维护性不高。容易使人吐血。

展开全文
内容来源于互联网和用户投稿,文章中一旦含有米乐app官网登录的联系方式务必识别真假,本站仅做信息展示不承担任何相关责任,如有侵权或涉及法律问题请联系米乐app官网登录删除

最新文章

网站地图