Distributed Configuration Management Platform(分布式配置管理平台)

客官°小女子只卖身不卖艺 2022-01-13 05:41 137阅读 0赞

[2019独角兽企业重金招聘Python工程师标准>>> ][2019_Python_] ![hot3.png][]

专注于各种 `分布式系统配置管理` 的`通用组件`/`通用平台`, 提供统一的`配置管理服务`。

[![30183038_roq0.jpg][]][30183038_roq0.jpg 1]

## 主要目标： ##

*  部署极其简单：同一个上线包，无须改动配置，即可在 多个环境中(RD/QA/PRODUCTION) 上线
 *  部署动态化：更改配置，无需重新打包或重启，即可 实时生效
 *  统一管理：提供web平台，统一管理 多个环境(RD/QA/PRODUCTION)、多个产品 的所有配置

## 项目信息 ##

*  CLIENT 端：
    
     *  Java: 目前唯一支持语言
     *  python：打算支持
     *  PHP：暂未支持
 *  WEB 管理端：  
    
    
     *  Java SpringMvc 实现，前后端分离 实现方式(基于Spring 4.1.7.RELEASE)

### java client ###

disconf.git branches and Maven version:

*  dev(develop branch): 2.6.28-SNAPSHOT
 *  master(stable branch)：2.6.27
 *  [更新日志][Link 1]
 *  在Maven Central Repository里查看 [com.baidu.disconf][]

#### Java Client Elegant Usage Preview ####

*  [注解式分布式配置使用方式][Link 2]
 *  [XML配置式分布式配置方式][XML]

## 当前版本功能特点 ##

*  支持配置（配置项+配置文件）的分布式化管理
 *  配置发布统一化
 *  极简的使用方式（注解式编程 或 XML无代码侵入模式）
 *  低侵入性或无侵入性、强兼容性

## 未来版本（完全版）功能特点 ##

Disconf的功能特点描述图：

[![30183038_R1Mi.jpg][]][30183038_R1Mi.jpg 1]

[查看大图][Link 3]

### 重要功能特点 ###

*  支持配置（配置项+配置文件）的分布式化管理
 *  配置发布统一化
    
     *  配置发布、更新统一化:
        
         *  同一个上线包 无须改动配置 即可在 多个环境中(RD/QA/PRODUCTION) 上线
         *  配置存储在云端系统，用户统一管理 多个环境(RD/QA/PRODUCTION)、多个平台 的所有配置
     *  配置更新自动化：用户在平台更新配置，使用该配置的系统会自动发现该情况，并应用新配置。特殊地，如果用户为此配置定义了回调函数类，则此函数类会被自动调用。
 *  配置异构系统管理
    
     *  异构包部署统一化：这里的异构系统是指一个系统部署多个实例时，由于配置不同，从而需要多个部署包（jar或war）的情况（下同）。使用Disconf后，异构系统的部署只需要一个部署包，不同实例的配置会自动分配。特别地，在业界大量使用部署虚拟化（如JPAAS系统，SAE，BAE）的情况下，同一个系统使用同一个部署包的情景会越来越多，Disconf可以很自然地与他天然契合。
     *  异构主备自动切换：如果一个异构系统存在主备机，主机发生挂机时，备机可以自动获取主机配置从而变成主机。
     *  异构主备机Context共享工具：异构系统下，主备机切换时可能需要共享Context。可以使用Context共享工具来共享主备的Context。
 *  极简的使用方式（注解式编程 或 XML无代码侵入模式）：我们追求的是极简的、用户编程体验良好的编程方式。目前支持两种开发模式：基于XML配置或者基于注解，即可完成复杂的配置分布式化。

注：配置项是指某个类里的某个Field字段。

### 其它功能特点 ###

*  低侵入性或无侵入性、强兼容性：
    
     *  低侵入性：通过极少的注解式代码撰写，即可实现分布式配置。
     *  无侵入性：通过XML简单配置，即可实现分布式配置。
     *  强兼容性：为程序添加了分布式配置注解后，开启Disconf则使用分布式配置；若关闭Disconf则使用本地配置；若开启Disconf后disconf-web不能正常Work，则Disconf使用本地配置。
 *  支持配置项多个项目共享，支持批量处理项目配置。
 *  配置监控：平台提供自校验功能（进一步提高稳定性），可以定时校验应用系统的配置是否正确。

## 模块架构图 ##

[![30183038_m8Zi.jpg][]][30183038_m8Zi.jpg 1]

[查看大图][Link 4]

### 模块信息 ###

*  disconf
    
     *  CLIENT: client目标是支持多语言。目前只提供了java语言客户端。
        
         *  JAVA
            
             *  [disconf-core][]: 分布式配置基础包模块
             *  [disconf-client][]: 分布式配置客户端模块, 依赖disconf-core包。 用户程序使用它作为Jar包进行分布式配置编程。
             *  [disconf-tool][]: 分布式配置工具包，依赖disconf-core包。 Disconf-tool是disconf的辅助工具类, 目前使用不多，建议不使用。
     *  管理端：disconf-web是统一的分布式配置管理平台。[disconf-web][]: 分布式配置平台服务模块, 依赖disconf-core包。采用SpringMvc+纯HTML方式（前后端分离架构）实现。用户使用它来进行日常的分布式配置管理。
 *  demo
    
     *  JAVA client DEMO:
        
         *  [disconf-standalone-demo][]: 使用disconf的基于Spring的standalone demo程序
         *  [disconf-standalone-dubbo-demo][]: 集成了disconf和dubbo的基于Spring的standalone demo程序
         *  [disconf-spring-boot-demo][]: 使用disconf的spring-boot demo程序,更少的配置

## 用户指南 ##

### clint ###

#### java client: disconf-client 使用 ####

在您的 Maven POM 文件里加入：

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

### server: disconf-web 使用 ###

部署方法请参见：[https://github.com/knightliao/disconf/tree/master/disconf-web][disconf-web]

全新主页，高清大图：

APP+环境+版本+ZK查询：

[![http://ww1.sinaimg.cn/mw1024/60c9620fgw1emyww39wjmj20qw0keq6m.jpg][http_ww1.sinaimg.cn_mw1024_60c9620fgw1emyww39wjmj20qw0keq6m.jpg]][http_ww1.sinaimg.cn_mw1024_60c9620fgw1emyww39wjmj20qw0keq6m.jpg_http_ww1.sinaimg.cn_mw1024_60c9620fgw1emyww39wjmj20qw0keq6m.jpg]

### java client Tutorials ###

#### 总体概述 ####

*  [TutorialSummary 功能总体概述][TutorialSummary]
 *  文章介绍：[分布式配置管理平台Disconf][Disconf]

#### 基于注解式的分布式配置（支持配置文件和配置项） ####

推荐新建的项目使用disconf时使用

*  [Tutorial 1 注解式分布式的配置文件][Tutorial 1]
 *  [Tutorial 2 注解式分布式的配置文件高级篇: 配置更新的通知][Tutorial 2 _]
 *  [Tutorial 3 注解式分布式的配置项][Tutorial 3]
 *  [Tutorial 4 注解式分布式静态配置文件和静态配置项][Tutorial 4]

注：将配置文件移至一个专有类里，而不是分散在项目的各个地方，整个代码架构清晰易懂、易管理。 即便如果哪天不使用disconf，也只需要将注解去掉即可。

#### 基于XML的分布式配置（无代码侵入）（仅支持配置文件） ####

推荐旧项目使用disconf时使用

*  [Tutorial 8 基于XML的分布式配置文件管理,自动reload][Tutorial 8 _XML_reload]
 *  [Tutorial 5 基于XML的分布式配置文件管理,不会自动reload,对于那些比较重的资源如jdbc等，特别有用][Tutorial 5 _XML_reload_jdbc]

#### 其它 ####

*  [Tutorial 6 disconf-web 功能详解][Tutorial 6 disconf-web]
 *  [Tutorial 7 可自定义的部分托管的分布式配置][Tutorial 7]
 *  [Tutorial disconf与dubbo的集成 demo][Tutorial disconf_dubbo_ demo]
 *  [Tutorial 9 实现真正意义上的统一上线包][Tutorial 9]
 *  [Tutorial 10 实现一个配置更新下载器agent][Tutorial 10 _agent]
 *  [配置说明][Link 5]
 *  [异常考虑][Link 6]
 *  [局限性和注意事项][Link 7]
 *  [注意事项][Link 8]
 *  [Zookeeper异常考虑][Zookeeper]

## 详细设计和讨论 ##

*  [disconf-client详细设计文档][disconf-client 1]
 *  [disconf-web详细设计文档][disconf-web 1]
 *  [细节讨论][Link 9]

## 大家都在使用disconf ##

*  \[百度\]（5+条产品线使用）
 *  [润生活][Link 10] （千万融资，全线产品使用）
 *  [拉勾网][Link 11]
 *  [人脉通][Link 12] （目前已B轮融资，4条产品线使用）
 *  [普联(Tp-link)技术有限公司][Tp-link]
 *  [杭州数梦工场科技有限公司][Link 13]
 *  [众钱网][Link 14]
 *  [更多][Link 15]

转载于:https://my.oschina.net/zhanghaiyang/blog/592965

[2019_Python_]: https://my.oschina.net/u/2663968/blog/3061697
[hot3.png]: /images/20220113/5d7e654655ea480e92eedf72a4ba7a51.png
[30183038_roq0.jpg]: /images/20220113/0165887a59c242979d1f0f20bb6184dd.png
[30183038_roq0.jpg 1]: https://camo.githubusercontent.com/a5649519c2097feb8245eeb1617b4c149bd8bca5/687474703a2f2f7777332e73696e61696d672e636e2f6d77313032342f36306339363230666a77316573766a7a6e7931726d6a3230616a3036317439612e6a7067
[Link 1]: https://github.com/knightliao/disconf/wiki/updates
[com.baidu.disconf]: http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.baidu.disconf%22
[Link 2]: http://ww3.sinaimg.cn/mw1024/60c9620fgw1eu5lsrsixcj20ga06ygna.jpg
[XML]: http://ww1.sinaimg.cn/mw1024/60c9620fgw1eu5ltt9uglj20ia0j0tbo.jpg
[30183038_R1Mi.jpg]: /images/20220113/1c7fe57de74b4f3e8721d016fc2fb9e3.png
[30183038_R1Mi.jpg 1]: https://camo.githubusercontent.com/0838195417ce1fc0f7e4ffdcaece76cfca5ea65c/687474703a2f2f7777342e73696e61696d672e636e2f626d6964646c652f36306339363230666a77316573766b716d757064666a323066703038756468372e6a7067
[Link 3]: http://ww1.sinaimg.cn/mw1024/60c9620fjw1esvkqmupdfj20fp08udh7.jpg
[30183038_m8Zi.jpg]: /images/20220113/9561e88957cb459b8c6529b2bfd2857a.png
[30183038_m8Zi.jpg 1]: https://camo.githubusercontent.com/0eb276858aca03de4efffe5edc96f9b1894fd426/687474703a2f2f7777322e73696e61696d672e636e2f626d6964646c652f36306339363230666a77316573766b3336367a36666a32306e6830666a7462752e6a7067
[Link 4]: http://ww2.sinaimg.cn/mw1024/60c9620fjw1esvk366z6fj20nh0fjtbu.jpg
[disconf-core]: https://github.com/knightliao/disconf/tree/master/disconf-core
[disconf-client]: https://github.com/knightliao/disconf/tree/master/disconf-client
[disconf-tool]: https://github.com/knightliao/disconf/tree/master/disconf-tool
[disconf-web]: https://github.com/knightliao/disconf/tree/master/disconf-web
[disconf-standalone-demo]: https://github.com/knightliao/disconf/tree/master/disconf-demos/disconf-standalone-demo
[disconf-standalone-dubbo-demo]: https://github.com/knightliao/disconf/tree/dev/disconf-demos/disconf-standalone-dubbo-demo
[disconf-spring-boot-demo]: https://github.com/knightliao/disconf/tree/dev/disconf-demos/disconf-spring-boot-demo
[http_ww1.sinaimg.cn_mw1024_60c9620fgw1emyww39wjmj20qw0keq6m.jpg]: http://static.oschina.net/uploads/img/201512/30183038_CaJN.jpg
[http_ww1.sinaimg.cn_mw1024_60c9620fgw1emyww39wjmj20qw0keq6m.jpg_http_ww1.sinaimg.cn_mw1024_60c9620fgw1emyww39wjmj20qw0keq6m.jpg]: /images/20220113/1d4c5f4dada64932a87b4f10f55f523d.png
[TutorialSummary]: https://github.com/knightliao/disconf/wiki/TutorialSummary
[Disconf]: https://github.com/knightliao/disconf/wiki/%E5%88%86%E5%B8%83%E5%BC%8F%E9%85%8D%E7%BD%AE%E7%AE%A1%E7%90%86%E5%B9%B3%E5%8F%B0Disconf
[Tutorial 1]: https://github.com/knightliao/disconf/wiki/Tutorial1
[Tutorial 2 _]: https://github.com/knightliao/disconf/wiki/Tutorial2
[Tutorial 3]: https://github.com/knightliao/disconf/wiki/Tutorial3
[Tutorial 4]: https://github.com/knightliao/disconf/wiki/Tutorial4
[Tutorial 8 _XML_reload]: https://github.com/knightliao/disconf/wiki/Tutorial8
[Tutorial 5 _XML_reload_jdbc]: https://github.com/knightliao/disconf/wiki/Tutorial5
[Tutorial 6 disconf-web]: https://github.com/knightliao/disconf/wiki/Tutorial6
[Tutorial 7]: https://github.com/knightliao/disconf/wiki/Tutorial7
[Tutorial disconf_dubbo_ demo]: https://github.com/knightliao/disconf/tree/master/disconf-demos/disconf-standalone-dubbo-demo
[Tutorial 9]: https://github.com/knightliao/disconf/wiki/Tutorial9
[Tutorial 10 _agent]: https://github.com/knightliao/disconf/wiki/Tutorial10
[Link 5]: https://github.com/knightliao/disconf/wiki/%E9%85%8D%E7%BD%AE%E8%AF%B4%E6%98%8E
[Link 6]: https://github.com/knightliao/disconf/wiki/%E5%BC%82%E5%B8%B8%E8%80%83%E8%99%91
[Link 7]: https://github.com/knightliao/disconf/wiki/%E5%B1%80%E9%99%90%E6%80%A7%E5%92%8C%E6%B3%A8%E6%84%8F%E4%BA%8B%E9%A1%B9
[Link 8]: https://github.com/knightliao/disconf/wiki/%E6%B3%A8%E6%84%8F%E4%BA%8B%E9%A1%B9
[Zookeeper]: https://github.com/knightliao/disconf/wiki/Zookeeper%E5%BC%82%E5%B8%B8%E8%80%83%E8%99%91
[disconf-client 1]: https://github.com/knightliao/disconf/wiki/disconf-client%E8%AF%A6%E7%BB%86%E8%AE%BE%E8%AE%A1%E6%96%87%E6%A1%A3
[disconf-web 1]: https://github.com/knightliao/disconf/wiki/disconf-web%E8%AF%A6%E7%BB%86%E8%AE%BE%E8%AE%A1%E6%96%87%E6%A1%A3
[Link 9]: https://github.com/knightliao/disconf/wiki/%E7%BB%86%E8%8A%82%E8%AE%A8%E8%AE%BA
[Link 10]: http://www.szzjcs.com/
[Link 11]: http://www.lagou.com/
[Link 12]: http://renmaitong.com/
[Tp-link]: http://www.tp-link.com.cn/
[Link 13]: https://github.com/knightliao/disconf/blob/master/www.dtdream.com
[Link 14]: https://github.com/knightliao/disconf/blob/master/17money.com
[Link 15]: https://github.com/knightliao/disconf/issues/18