disconf原理 “入坑”指南

时间 2019-12-08

标签 disconf 原理指南繁體版

原文原文链接

以前有了解过disconf，也知道它是基于zookeeper来作的，可是对于其运行原理不太了解，趁着周末，debug下源码，也算是不枉费周末大好时光哈 :) 。关于这篇文章，笔者主要是参考disconf源码和官方文档，如有不正确地方，感谢评论区指正交流~前端

disconf是一个分布式配置管理平台（Distributed Configuration Management Platform），专一于各类分布式系统配置管理的通用组件/通用平台, 提供统一的配置管理服务，是一套完整的基于zookeeper的分布式配置统一解决方案。disconf目前已经被多个公司在使用，包括百度、滴滴出行、银联、网易、拉勾网、苏宁易购、顺丰科技等知名互联网公司。disconf源码地址 https://github.com/knightliao/disconf ，官方文档 https://disconf.readthedocs.io/zh_CN/latest/ 。java

目前disconf包含了客户端disconf-Client和管理端disconf-Web两个模块，均由java实现。服务依赖组件包括Nginx、Tomcat、Mysql、ZooKeeper，nginx提供反向代理（disconf-web是先后端分离的），Tomcat是后端web容器，配置存储在mysql上，基于zookeeper的wartch模型，实时推送。注意，disconf优先读取本地文件，disconf只支持应用对配置的读操做，经过在disconf-web上更新配置，而后由zookeeper通知到服务实例，最后服务实例去disconf-web端获取最新配置并更新到本地。node

disconf 功能特色：mysql

支持配置（配置项/配置文件）分布式管理
配置发布统一化

配置发布、更新统一化，同一个上线包无须改动配置便可在多个环境中(RD/QA/PRODUCTION) 上线
配置更新自动化：用户在平台更新配置，使用该配置的系统会自动发现该状况，并应用新配置。特殊地，若是用户为此配置定义了回调函数类，则此函数类会被自动调用

上手简单，基于注解或者xml配置方式

功能特色描述图nginx

disconf 架构图git

分析disconf，最好是在本地搭建一个disconf-web环境，方便调试代码，具体步骤可参考官方文档，使用disconf-client，只须要在pom引入依赖便可：github

<dependency>
    <groupId>com.baidu.disconf</groupId>
    <artifactId>disconf-client</artifactId>
    <version>2.6.36</version>
</dependency>

对于开发人员来讲，最多接触的就是disconf-web配置和disconf-client了，disconf-web配置官方文档已经很详细了，这里就来不及解释了，抓紧上车，去分析disconf-client的实现，disconf-client最重要的内容就是disconf-client初始化流程和配置动态更新机制。disconf的功能是基于Spring的（初始化是在Spring的BeanDefinitionRegistryPostProcessor#postProcessBeanDefinitionRegistry开始的，配置动态更新也是要更新到Spring IoC中对应的bean），因此使用disconf，项目必须基于Spring。web

1 disconf-client 初始化流程

关于disconf-client的初始化，联想到Spring IoC流程，咱们先不看代码，能够猜测一下其大体流程，disconf-client首先须要从disconf服务端获取配置，而后等到IoC流程中建立好对应的bean以后，将对应的配置值设置到bean中，这样基本上就完成了初始化流程，其实disconf的初始化实现就是这样的。

disconf-client的初始化开始于BeanDefinitionRegistryPostProcessor#postProcessBeanDefinitionRegistry（Spring IoC初始化时，对于BeanDefinitionRegistryPostProcessor的实现类，会调用其postProcessBeanDefinitionRegistry方法），disconf的DisconfMgrBean类就是BeanDefinitionRegistryPostProcessor的实现类，DisconfMgrBean类的bean配置在哪里呢？其实就是disconf.xml中的配置，该配置是必须的，示例以下：

<!-- 使用disconf必须添加如下配置 -->
<bean id="disconfMgrBean" class="com.baidu.disconf.client.DisconfMgrBean"
      destroy-method="destroy">
    <property name="scanPackage" value="com.luo.demo"/>
</bean>
<bean id="disconfMgrBean2" class="com.baidu.disconf.client.DisconfMgrBeanSecond"
      init-method="init" destroy-method="destroy">
</bean>

DisconfMgrBean#postProcessBeanDefinitionRegistry方法主要作的3件事就是扫描（firstScan）、注册DisconfAspectJ 和 bean属性注入。sql

public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException {
    // scanPackList包括disconf.xml中DisconfMgrBean.scanPackage
    List<String> scanPackList = StringUtil.parseStringToStringList(scanPackage, SCAN_SPLIT_TOKEN);

    // 1. 进行扫描
    DisconfMgr.getInstance().setApplicationContext(applicationContext);
    DisconfMgr.getInstance().firstScan(scanPackList);

    // 2. register java bean
    registerAspect(registry);
}

1.1 firstScan

firstScan操做主要是加载系统配置和用户配置（disconf.properties），进行包扫描并入库，而后获取获取数据/注入/Watch。

protected synchronized void firstScan(List<String> scanPackageList) {
    // 导入配置
    ConfigMgr.init();
    
    // registry
    Registry registry = RegistryFactory.getSpringRegistry(applicationContext);

    // 扫描器
    scanMgr = ScanFactory.getScanMgr(registry);

    // 第一次扫描并入库
    scanMgr.firstScan(scanPackageList);

    // 获取数据/注入/Watch
    disconfCoreMgr = DisconfCoreFactory.getDisconfCoreMgr(registry);
    disconfCoreMgr.process();
}

进行包扫描是使用Reflections来完成的，获取路径下（好比xxx/target/classes）某个包下符合条件（好比com.luo.demo）的资源（reflections），而后从reflections获取某些符合条件的资源列表，以下：json

/**
 * 扫描基本信息
 */
private ScanStaticModel scanBasicInfo(List<String> packNameList) {
    ScanStaticModel scanModel = new ScanStaticModel();

    // 扫描对象
    Reflections reflections = getReflection(packNameList);
    scanModel.setReflections(reflections);

    // 获取DisconfFile class
    Set<Class<?>> classdata = reflections.getTypesAnnotatedWith(DisconfFile.class);
    scanModel.setDisconfFileClassSet(classdata);

    // 获取DisconfFileItem method
    Set<Method> af1 = reflections.getMethodsAnnotatedWith(DisconfFileItem.class);
    scanModel.setDisconfFileItemMethodSet(af1);

    // 获取DisconfItem method
    af1 = reflections.getMethodsAnnotatedWith(DisconfItem.class);
    scanModel.setDisconfItemMethodSet(af1);

    // 获取DisconfActiveBackupService
    classdata = reflections.getTypesAnnotatedWith(DisconfActiveBackupService.class);
    scanModel.setDisconfActiveBackupServiceClassSet(classdata);

    // 获取DisconfUpdateService
    classdata = reflections.getTypesAnnotatedWith(DisconfUpdateService.class);
    scanModel.setDisconfUpdateService(classdata);
    
    return scanModel;
}

View Code

获取到资源信息（好比DisconfFile 和DisconfFileItem ）以后，读取DisConfFile类及其对应的DisconfFileItem信息，将它们放到disconfFileItemMap中，最后将这些信息存储到仓库DisconfCenterStore。这部分逻辑在ScanMgrImpl.firstScan方法中，总体逻辑仍是比较清晰的，这里就不贴代码了。

扫描入库以后，就该获取数据/注入/Watch（DisconfCoreFactory.getDisconfCoreMgr()中逻辑）了。

public static DisconfCoreMgr getDisconfCoreMgr(Registry registry) throws Exception {
    FetcherMgr fetcherMgr = FetcherFactory.getFetcherMgr();
    
    // 不开启disconf，则不要watch了
    WatchMgr watchMgr = null;
    if (DisClientConfig.getInstance().ENABLE_DISCONF) {
        // Watch 模块
        watchMgr = WatchFactory.getWatchMgr(fetcherMgr);
    }
    return new DisconfCoreMgrImpl(watchMgr, fetcherMgr, registry);
}
public static WatchMgr getWatchMgr(FetcherMgr fetcherMgr) throws Exception {

    synchronized(hostsSync) {
        // 从disconf-web端获取 Zoo Hosts信息，及zookeeper host和zk prefix信息(默认 /disconf)
        hosts = fetcherMgr.getValueFromServer(DisconfWebPathMgr.getZooHostsUrl(DisClientSysConfig
                                                                                   .getInstance()
                                                                                   .CONF_SERVER_ZOO_ACTION));
        zooPrefix = fetcherMgr.getValueFromServer(DisconfWebPathMgr.getZooPrefixUrl(DisClientSysConfig
                                                                                        .getInstance
                                                                                             ()
                                                                                        .CONF_SERVER_ZOO_ACTION));

        /**
         * 初始化watchMgr，这里会与zookeeper创建链接，若是/disconf节点不存在会新建
         */
        WatchMgr watchMgr = new WatchMgrImpl();
        watchMgr.init(hosts, zooPrefix, DisClientConfig.getInstance().DEBUG);

        return watchMgr;
    }

    return null;
}

从disconf-web端获取zk host和 zk prefix以后，会创建与zk的链接，而后就该从disconf-web端下载配置和watcher了，也就是disconfCoreMgr.process()逻辑。下载配置时disconf-client从disconf-web端获取配置的全量数据（http链接），并存放到本地，而后解析数据，生成dataMap，dataMap是全量数据。而后将数据注入到仓库中（DisconfCenterStore.confFileMap，类型为Map<String, DisconfCenterFile>）。注意：这里尚未将配置的值设置到bean中，设置bean值是在Spring的finishBeanFactoryInitialization流程作的，准确来讲是在初始化bean DisconfMgrBeanSecond（bean配置在disconf.xml中），调用其init方法中作的。

在将值设置到仓库以后，就该监听对应配置了，这样才能使用zk的watch机制，在zk上监听的url格式为 /disconf/boot-demo_1_0_0_0_rd/file/specific.properties ，若是该url对应的node不存在则新建，注意该node是persistent类型的。而后在该node下新建临时节点，节点名字是discon-client的签名，格式为host_port_uuid，节点data为针对该配置文件，disconf-client须要的配置项的json格式数据，好比"{"port":9998,"host":"192.168.1.104"}"。

1.2 注册DisconfAspectJ

往Spring中注册一个aspect类DisconfAspectJ，该类会对@DisconfFileItem注解修饰的方法作切面，功能就是当获取bean属性值时，若是开启了DisClientConfig.getInstance().ENABLE_DISCONF，则返回disconf仓库中对应的属性值，不然返回bean实际值。注意：目前版本的disconf在更新仓库中属性值后会将bean的属性值也一同更改，因此，目前DisconfAspectJ类做用已不大，没必要理会，关于该类的讨论可参考issue DisconfAspectJ 拦截的做用？

1.3 bean属性注入

bean属性注入是从DisconfMgr.secondScan开始的：

protected synchronized void secondScan() {
    // 扫描回调函数，也就是注解@DisconfUpdateService修饰的配置更新回调类，该类需实现IDisconfUpdate
    if (scanMgr != null) {
        scanMgr.secondScan();
    }

    // 注入数据至配置实体中
    if (disconfCoreMgr != null) {
        disconfCoreMgr.inject2DisconfInstance();
    }
}

bean属性注入经过获取仓库中对应的属性值，而后调用setMethod.invoke或者field.set方法来设置，bean对应的boject是经过Spring来获取的，也就是说，在获取后bean已经初始化完成，只不过对应的属性值还不是配置文件中配置的而已。若是程序中有2个类的@DisconfFile都是同一个配置文件，那么这个时候获取的bean是哪一个类的bean呢？关于这个能够点击issue DisconfFile用法咨询，disconf目前只支持一个配置文件一个类的方式，不给两个class同时使用同一个 "resources.properties"，不然第二个是不生效的。

2 配置动态更新机制

disconf的配置动态更新借助于zk的watch机制（watch机制是zk 3大重要内容之一，其他两个是zk协议和node存储模型）实现的，初始化流程会中会对配置文件注册watch，这样当配置文件更新时，会通知到discnof-client，而后disconf-client再从disconf-web中获取最新的配置并更新到本地，这样就完成了配置动态更新。

配置动态更新动做开始于DisconfFileCoreProcessorImpl.updateOneConfAndCallback()方法：

/**
 * 更新消息: 某个配置文件 + 回调
 */
@Override
public void updateOneConfAndCallback(String key) throws Exception {

    // 更新 配置
    updateOneConf(key);

    // 回调
    DisconfCoreProcessUtils.callOneConf(disconfStoreProcessor, key);
    callUpdatePipeline(key);
}

更新配置时，首先更新仓库中值，而后更新bean属性值，配置更新回调是用户自定义的回调方法，也就是@DisconfUpdateService修饰的类。配置更新时流程是：

开发人员在前端更新配置 -> disconf-web保存数据并更新zookeeper -> zookeeper通知disconf-client -> discnof-client 从 disconf-web下载对应配置 -> 更新仓库和bean属性 -> 调用回调 -> 更新配置完成。

小结

disconf 做为一个分布式的配置管理平台，文档详细，易于上手，动态配置更新，知足大多数场景的配置更新需求。美中不足的是，代码有的地方有点臃余，获取配置时仍是全量获取方式，目前还不支持多个类共用同一个 "resources.properties"，多余的DisconfAspectJ操做等。

使用disconf，最好的使用方式是基于它，将其改形成适合本公司或者项目组的工具，好比更方便的注解方式和回调方式等。