分布式配置中心 Disconf实践- 使用篇

首先打开disconf控制台:http://localhost:1111,第一步:创建应用,awesome-project(自定);第二步:创建配置文件。创建后应用和配置文件信息如下:

image.png

以一个简单的例子演示如何使用Disconf:

假如应用有一个redis.properties配置文件,内容如下:

  redis.host=128.0.0.1
  redis.port=6379

在disconf控制台选中刚才你创建的应用,再选择新建->新建配置文件:

image.png

创建后就可以在主界面看到刚才创建的redis.properties文件了。启动要接入disconf的应用有四部曲:

1、添加Maven依赖:

        <dependency>

            <groupId>com.baidu.disconf</groupId>

            <artifactId>disconf-client</artifactId>

            <version>2.6.36</version>

        </dependency>

 

2、创建disconf.properties

 
# 是否使用远程配置文件
# true(默认)会从远程获取配置 false则直接获取本地配置
disconf.enable.remote.conf=true
 
# 配置服务器的 HOST,用逗号分隔  127.0.0.1:8000,127.0.0.1:8000
disconf.conf_server_host=127.0.0.1:1111
 
# 版本, 请采用 X_X_X_X 格式
disconf.version=1_0_0_0
 
# APP 请采用 产品线_服务名 格式
disconf.app=
 
# 环境
disconf.env=rd
 
# debug
disconf.debug=true
 
# 忽略哪些分布式配置,用逗号分隔
disconf.ignore=
 
# 获取远程配置 重试次数,默认是3次
disconf.conf_server_url_retry_times=1
 
# 获取远程配置 重试时休眠时间,默认是5秒
disconf.conf_server_url_retry_sleep_seconds=1

3、创建disconf.xml

 
    <!-- 使用disconf必须添加以下配置 -->
    <bean id="disconfMgrBean" class="com.baidu.disconf.client.DisconfMgrBean"
          destroy-method="destroy">
        <property name="scanPackage" value="com.example.disconf.demo"/>
    </bean>
    <bean id="disconfMgrBean2" class="com.baidu.disconf.client.DisconfMgrBeanSecond"
          init-method="init" destroy-method="destroy">
    </bean>
 
    <!-- 使用托管方式的disconf配置(无代码侵入, 配置更改会自动reload)-->
    <bean id="configproperties_disconf"
          class="com.baidu.disconf.client.addons.properties.ReloadablePropertiesFactoryBean">
        <property name="locations">
            <list>
                <value>classpath:/autoconfig.properties</value>
                <value>classpath:/autoconfig2.properties</value>
                <value>classpath:/myserver_slave.properties</value>
                <value>classpath:/testJson.json</value>
                <value>testXml2.xml</value>
            </list>
        </property>
    </bean>
 
    <bean id="propertyConfigurer"
          class="com.baidu.disconf.client.addons.properties.ReloadingPropertyPlaceholderConfigurer">
        <property name="ignoreResourceNotFound" value="true"/>
        <property name="ignoreUnresolvablePlaceholders" value="true"/>
        <property name="propertiesArray">
            <list>
                <ref bean="configproperties_disconf"/>
            </list>
        </property>
    </bean>
 
    <!--
             使用托管方式的disconf配置(无代码侵入, 配置更改不会自动reload)
            只会同步属性文件到本地,但不会reload到系统中,需要系统重启一下。
    -->
    <bean id="configproperties_no_reloadable_disconf"
          class="com.baidu.disconf.client.addons.properties.ReloadablePropertiesFactoryBean">
        <property name="locations">
            <list>
                <value>myserver.properties</value>
            </list>
        </property>
    </bean>
 
    <bean id="propertyConfigurerForProject1"
          class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
        <property name="ignoreResourceNotFound" value="true"/>
        <property name="ignoreUnresolvablePlaceholders" value="true"/>
        <property name="propertiesArray">
            <list>
                <ref bean="configproperties_no_reloadable_disconf"/>
            </list>
        </property>
    </bean>

4、redis.properties配置监听

/**
 * Redis配置文件
 *
 * @author liaoqiqi
 * @version 2014-6-17
 */
@Service
@Scope("singleton")
@DisconfFile(filename = "redis.properties")
@DisconfUpdateService(classes = {JedisConfig.class})
public class JedisConfig implements IDisconfUpdate {
 
    protected static final Logger LOGGER = LoggerFactory.getLogger(JedisConfig.class);
 
    // 代表连接地址
    private String host;
 
    // 代表连接port
    private int port;
 
    /**
     * 地址, 分布式文件配置
     *
     * @return
     */
    @DisconfFileItem(name = "redis.host", associateField = "host")
    public String getHost() {
        return host;
    }
 
    public void setHost(String host) {
        this.host = host;
    }
 
    /**
     * 端口, 分布式文件配置
     *
     * @return
     */
    @DisconfFileItem(name = "redis.port", associateField = "port")
    public int getPort() {
        return port;
    }
 
    public void setPort(int port) {
        this.port = port;
        LOGGER.info("i' m here: setting redis port");
    }
 
    public void reload() throws Exception {
        LOGGER.info("host: " + host);
    }
}

这里有几个关键点:

 接口IDisconfUpdate:需要监听的服务都要实现该接口 
 注解@DisconfFile:指定分布式配置文件,就是刚才控制台创建的redis.properties 
 注解@DisconfUpdateService:标识配置更新时需要进行更新的服务,需要指定它影响的配置数据,可以是配置文件或者是配置项,比如这里JedisConfig 
  注解@DisconfFileItem:分布式的配置文件中的key,比如redis.host

 启动项目,成功后刷新disconf控制台,在实例列表就会出现你本地的机器了。disconf会自动帮程序获取控制台的配置了。

下面修改disconf控制台的redis.properties,将host改为127.0.0.1,观察IDEA控制台日志输出:

image.png

发现配置确实变更了,而且是实时刷新。至此在项目中使用disconf就接入完成了,接下来要做的是移除所有项目配置(properties文件),统一由disconf管理,并且让disconf支持公共配置。


disconf Demo 代码:

   https://github.com/knightliao/disconf-demos-java