disconf客户端使用篇

1. 在Maven POM 文件里加入

    com.baidu.disconf
    disconf-client
    2.6.36

2.classpath下创建disconf.properties：

# 是否使用远程配置文件
# true(默认)会从远程获取配置 false则直接获取本地配置
disconf.enable.remote.conf=true

#
# 配置服务器的 HOST,用逗号分隔  127.0.0.1:8004,127.0.0.1:8004
#nginx对外暴露的ip:port

disconf.conf_server_host=127.0.0.1:8004

# 版本, 请采用 X_X_X_X 格式 
disconf.version=1_0_0_0

# APP 请采用 产品线_服务名 格式 
disconf.app=esearch_search

# 环境
disconf.env=rd

# 忽略哪些分布式配置，用逗号分隔
disconf.ignore=

# 获取远程配置 重试次数，默认是3次
disconf.conf_server_url_retry_times=1
# 获取远程配置 重试时休眠时间，默认是5秒
disconf.conf_server_url_retry_sleep_seconds=1

# 用户指定的下载文件夹, 远程文件下载后会放在这里
disconf.user_define_download_dir=./disconf/download2

# 下载的文件会被迁移到classpath根路径下，强烈建议将此选项置为 true(默认是true)
disconf.enable_local_download_dir_in_class_path=true

3.创建disconf.xml，并使用spring加载：

    

    
    
    
       
        
    
    
    

    
  

    
        
            
                classpath:/disconf/config/remote.properties
                classpath:/testXml.xml
            
        
    

    
        
        
        
            
                
            
        
    

4.创建配置对象注入类和配置更新时的回调函数：

@Service
@DisconfFile(filename = "remote.properties",targetDirPath = "disconf/config")
public class RemoteServerConfig {

    // 代表连接地址
    private String remoteHost;

    // 代表连接port
    private int remotePort = 8080;

    /**
     * 地址, 分布式文件配置
     *
     */
    @DisconfFileItem(name = "remoteHost")
    public String getRemoteHost() {
        return remoteHost;
    }

    public void setRemoteHost(String remoteHost) {
        this.remoteHost = remoteHost;
    }

    /**
     * 端口, 分布式文件配置
     *对应remote.properties文件中key为remotePort
     */
    @DisconfFileItem(name = "remotePort")
    public int getRemotePort() {
        return remotePort;
    }

    public void setRemotePort(int remotePort) {
        this.remotePort = remotePort;
    }

}

@Service
@DisconfUpdateService(classes = {RemoteServerConfig.class})
public class RemoteServiceUpdateCallback implements IDisconfUpdate {

    protected static final Logger LOGGER = LoggerFactory.getLogger(RemoteServiceUpdateCallback.class);

    @Autowired
    private RemoteService remoteService;

    /**
     *
     */
    public void reload() throws Exception {

       LOGGER.info("reload RemoteServerConfig ok.");
    }

}

//xml文件的托管
/**
 * 空的分布式配置文件,用途有两种:

 * 1. 对配置文件里的内容不感兴趣，只是单纯的下载

 * 2. 当配置文件更新时，可以自动下载到本地
 */
@Service
@DisconfFile(filename = "testXml.xml")
public class TestXmlConfig {

}
//xml文件更新时的回调函数
@Service
@DisconfUpdateService(classes = {TestXmlConfig.class})
public class TestXmlConfigCallback implements IDisconfUpdate {
    protected static final Logger LOGGER = LoggerFactory.getLogger(TestXmlConfigCallback.class);

    public void reload() throws Exception {
        //重新读xml更新
        LOGGER.info("===============now i'm at xml update callback================");
    }

}

此时，当更新disconf-web管理台对应的remote.properties文件时，会重新在disconf/config目录下下载最新文件，RemoteServerConfig 中的属性值会对应更新，RemoteServiceUpdateCallback 中的reload函数会被回调。但是对于testXml.xml的更新，disconf不支持配置对象注入，可添加回调函数TestXmlConfigCallback 。

配置类涉及的注解和回调接口有：
DisconfFile

/**
 * 分布式的配置文件
 *
 * @author liaoqiqi
 * @version 2014-5-16
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface DisconfFile {

    /**
     * 配置文件名,必须指定
     */
    String filename();

    /**
     * 环境,默认为用户指定的环境
     */
    String env() default "";

    /**
     * 版本,默认为用户指定的版本
     */
    String version() default "";

    /**
     * 版本,默认为用户指定的app
     */
    String app() default "";

    /**
     * 配置文件目标地址dir, 以"/"开头则是系统的全路径，否则则是相对于classpath的路径，默认是classpath根路径
     * 注意：根路径要注意是否有权限，否则会出现找不到路径，推荐采用相对路径
     *
     * @return
     */
    String targetDirPath() default "";
}

DisconfFileItem

/**
 * 分布式的配置文件中的ITEM
 *
 * @author liaoqiqi
 * @version 2014-5-16
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface DisconfFileItem {

    /**
     * 配置文件里的KEY的名字
     */
    String name();

    /**
     * 所关联的域
     */
    String associateField() default "";
}

DisconfUpdateService

/**
 * 标识配置更新时需要进行更新的服务,需要指定它影响的配置数据
 * 可以是配置文件或者是配置项
 *
 * @author liaoqiqi
 * @version 2014-5-16
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface DisconfUpdateService {

    /**
     * 配置文件
     */
    Class[] classes() default {};

    /**
     * 配置文件key名
     */
    String[] confFileKeys() default {};

    /**
     * 配置项
     */
    String[] itemKeys() default {};
}

IDisconfUpdate

/**
 * 当配置更新 时，用户可以实现此接口，用以来实现回调函数
 *
 * @author liaoqiqi
 * @version 2014-5-20
 */
public interface IDisconfUpdate {

    void reload() throws Exception;
}

参考资料：
官方demo