对Configuration的新认识

作者: holly_wang_王小飞 | 来源:发表于2016-11-17 23:48 被阅读0次

    对于读取配置文件的代码以前没有仔细阅读过,后来自己想做成热配置文件的方式就自己启动了一个线程加载配置文件然后再run方法中 sleep几秒的方式读取配置文件实现热配置。主要代码如下:

    public class HotLoadProperty {
         public static final String[] hotLoadFiles = { "test.properties" };/
        static {
               //守护线程定时刷新前必须先刷新一遍,否则可能导致调用方取不到数据
               for(String file : hotLoadFiles){ 
                    HotLoadProperty.refresh(file); 
                }
                //启动一个守护线程监听热发文件 
                Thread daemonThread = new Thread(new DaemonRunner()); 
                daemonThread.setDaemon(true);// 设置为守护进程 
                daemonThread.start();
         }
        private static class DaemonRunner implements Runnable { 
                  @Override public void run() {
                               while (true) { 
                                        try { Thread.sleep(1000);
                               } catch (InterruptedException e) {
                                     logger.error(e.getMessage(), e); 
                              } 
                            for(String file : hotLoadFiles) { 
                                    HotLoadProperty.refresh(file); 
                            }
                     } 
                 }
           }
        private static boolean loadProperties(String propertyName){
            InputStream stream = null;
            boolean hasLoaded = false;
            try {
                stream = new FileInputStream(propertyName); 
                if (stream != null) {
                    Properties prop = propMap.get(propertyName);
                    if(prop == null){
                        prop = new Properties();
                    }else{
                        prop.clear();
                    }
                    prop.load(new InputStreamReader(stream, "utf-8"));
                    hasLoaded = true;
                }
            } catch (Exception e) {
                logger.error("热发文件加载失败,请检查文件是否存在", e);
            }finally{
                try {
                    if (stream != null) {
                        stream.close();
                    }
                } catch (IOException ioe) {
                    // ignore
                }
            }
            return hasLoaded;
        }
    }
    

    后来想apache的这些小清新工具Configuration应该有这样是的实现才对于是看了下源码
    Configuration的最常用实现类 PropertiesConfiguration 用来加载.properties
    该类继承自 AbstractFileConfiguration

    public class PropertiesConfiguration extends AbstractFileConfiguration{…………}
    

    查看抽象类AbstractFileConfiguration

    public abstract class AbstractFileConfiguration 
    extends BaseConfiguration 
    implements FileConfiguration, FileSystemBased{…………}
    

    其中有个方法

    public void setReloadingStrategy(ReloadingStrategy strategy)
        {
            this.strategy = strategy;
            strategy.setConfiguration(this);
            strategy.init();
        }
    

    查看 接口 ReloadingStrategy 发现其实现类有

    ReloadingStrategy实现类.png

    可以主要看下其实现类FileChangedReloadingStrategy
    主要的方法

    public boolean reloadingRequired()
        {
            if (!reloading)
            {
                long now = System.currentTimeMillis();
    
                if (now > lastChecked + refreshDelay)
                {
                    lastChecked = now;
                    if (hasChanged())
                    {
                        if (logger.isDebugEnabled())
                        {
                            logger.debug("File change detected: " + getName());
                        }
                        reloading = true;
                    }
                }
            }
    
            return reloading;
        }
    

    其实就是什么时机去重新reload。
    这个清新的小公举实现了我想要的机制,可以参考该类实现自己所需的加载策略,比如多个文件只需重新加个个别文件,或者定义是否更改的策略等。

    选择总是多样性的,对于想加载xml文件配置的 其中有个XMLPropertiesConfiguration继承自PropertiesConfiguration

    public class XMLPropertiesConfiguration extends PropertiesConfiguration{………………}
    

    该类简单易用 同样可以设置重新加载的类。看下demo

    配置多个数据库
    <?xmlversion="1.0"encoding="UTF-8"?>
    <!-- const.xml -->
    <config>
        <databases>
            <database>
                <name>dev</name>
                <url>127.0.0.1</url>
                <port>1521</port>
                <login>admin</login>
                <password>pass</password>
            </database>
            <database>
                <name>production</name>
                <url>192.23.44.100</url>
                <port>1521</port>
                <login>admin</login>
                <password>not-so-easy-pass</password>
            </database>
        </databases>
    </config>
    XMLConfiguration config =new XMLConfiguration("const.xml");
     
    // 127.0.0.1
    config.getString("databases.database(0).url");
     
    // 192.23.44.100
    config.getString("databases.database(1).url");
    
    XPath表达式
    XMLConfiguration config =new XMLConfiguration("const.xml");
    config.setExpressionEngine(new XPathExpressionEngine());
     
    // 127.0.0.1
    config.getString("databases/database[name = 'dev']/url");       
     
    // 192.23.44.100
    config.getString("databases/database[name = 'production']/url");
    
    
    访问环境变量
    
    EnvironmentConfiguration config =new EnvironmentConfiguration();
    config.getString("ENV_TYPE");
    
    联合配置
    
     让我们总结一下我们了解的东西,下面的getDbUrl方法做如下事情:
        ·检查系统环境变量中叫做ENV_TYPE的值。
        ·如果值是dev或者produtcion就返回相应的数据库url
        ·如果变量没有配置就抛出异常。
    public String getDbUrl() throws ConfigurationException { 
    EnvironmentConfiguration envConfig =new EnvironmentConfiguration();
     String env = envConfig.getString("ENV_TYPE"); 
    if("dev".equals(env) ||"production".equals(env)) { XMLConfiguration xmlConfig =new XMLConfiguration("const.xml");
     xmlConfig.setExpressionEngine(new XPathExpressionEngine());
     String xpath ="databases/database[name = '"+ env +"']/url"; return xmlConfig.getString(xpath); }
    else{ 
    String msg ="ENV_TYPE environment variable is "+ "not properly set"; throw new IllegalStateException(msg); }}
    
    集中你的配置
    
     对每个不同的需要配置的对象创建多个配置比较烦。假如我们想添加其他的基于XML的配置,我们会怎么搞?我们需要创建另一个XMLConfiguration对象,这会给管理带来很多麻烦。一个解决办法是把配置文件信息集中到一个单个XML文件中。下面是一个例子:
    <?xmlversion="1.0"encoding="UTF-8"?>
    <!-- config.xml -->
     <configuration> 
      <env/>
       <xmlfileName="const.xml"/>
      </configuration>
    
        你需要使用DefaultConfigurationBuilder类,最终版本的getDbUrl方法看起来像这样:
    public String getDbUrl()throws ConfigurationException { 
       DefaultConfigurationBuilder builder = new DefaultConfigurationBuilder("config.xml");
         booleanload =true; 
          CombinedConfiguration config = builder.getConfiguration(load); 
          config.setExpressionEngine(new XPathExpressionEngine()); 
            String env = config.getString("ENV_TYPE"); 
            if("dev".equals(env) ||"production".equals(env)) {
             String xpath ="databases/database[name = '"+ env +"']/url"; return config.getString(xpath); 
           } else{
             String msg ="ENV_TYPE environment variable is "+ "not properly set"; throw new               IllegalStateException(msg);
     }
    }
    
    自动重新加载
     Apache Commons Configuration有很多非常酷的特性。其中一个就是当基于文件的配置变化的时候自动加载,因为我们可以设置加载策略。框架会轮询配置文件,当文件的内容发生改变时,配置对象也会刷新。你可以用程序控制:
        XMLConfiguration config =new XMLConfiguration("const.xml");
        ReloadingStrategy strategy =new FileChangedReloadingStrategy();
        strategy.setRefreshDelay(5000);
        config.setReloadingStrategy(strategy);
     或者把他写到主配置文件中:
        <?xmlversion="1.0"encoding="UTF-8"?>
        <!-- config.xml -->
        <configuration>
          <env/>
          <xmlfileName="const.xml">
            <reloadingStrategyrefreshDelay="5000"
              config-class="org.apache.commons.configuration.reloading.FileChangedReloadingStrategy"/>
          </xml>
        </configuration>
    每五秒框架都检查一下配置文件有没有改变。
    

    最后发现Apache Commons的代码还是牛一些!!!

    相关文章

      网友评论

        本文标题:对Configuration的新认识

        本文链接:https://www.haomeiwen.com/subject/wcgdpttx.html