Disconf分布式配置管理平臺(tái)

Distributed Configuration Management Platform(分布式配置管理平臺(tái))。

專注于各種?分布式系統(tǒng)配置管理?的通用組件/通用平臺(tái), 提供統(tǒng)一的配置管理服務(wù)。

包括?百度、滴滴打車、銀聯(lián)、網(wǎng)易、拉勾網(wǎng)?等知名互聯(lián)網(wǎng)公司正在使用!

「disconf」在「2015 年度新增開(kāi)源軟件排名 TOP 100(OSC開(kāi)源中國(guó)提供)」中排名第16強(qiáng)。

主要目標(biāo)：

• 部署極其簡(jiǎn)單：同一個(gè)上線包，無(wú)須改動(dòng)配置，即可在 多個(gè)環(huán)境中(RD/QA/PRODUCTION) 上線
• 部署動(dòng)態(tài)化：更改配置，無(wú)需重新打包或重啟，即可 實(shí)時(shí)生效
• 統(tǒng)一管理：提供web平臺(tái)，統(tǒng)一管理 多個(gè)環(huán)境(RD/QA/PRODUCTION)、多個(gè)產(chǎn)品 的所有配置
• 支持微服務(wù)架構(gòu)

demos

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

項(xiàng)目信息

• CLIENT 端：
  • Java: 目前唯一支持語(yǔ)言
  • python：打算支持
  • PHP：暫未支持
• WEB 管理端：
  • Java SpringMvc 實(shí)現(xiàn)，前后端分離 實(shí)現(xiàn)方式(基于Spring 4.1.7.RELEASE)

java client

disconf.git branches and Maven version:

• dev(develop branch): 2.6.31-SNAPSHOT
• master(stable branch)：2.6.31
• 更新日志
• 在Maven Central Repository里查看?com.baidu.disconf

Java Client Elegant Usage Preview

• 注解式分布式配置使用方式
• XML配置式分布式配置方式

當(dāng)前版本功能特點(diǎn)

• 支持配置（配置項(xiàng)+配置文件）的分布式化管理
• 配置發(fā)布統(tǒng)一化
• 極簡(jiǎn)的使用方式（注解式編程 或 XML無(wú)代碼侵入模式）
• 低侵入性或無(wú)侵入性、強(qiáng)兼容性

未來(lái)版本（完全版）功能特點(diǎn)

Disconf的功能特點(diǎn)描述圖：

查看大圖

重要功能特點(diǎn)

• 支持配置（配置項(xiàng)+配置文件）的分布式化管理
• 配置發(fā)布統(tǒng)一化
  • 配置發(fā)布、更新統(tǒng)一化:
    • 同一個(gè)上線包 無(wú)須改動(dòng)配置 即可在 多個(gè)環(huán)境中(RD/QA/PRODUCTION) 上線
    • 配置存儲(chǔ)在云端系統(tǒng)，用戶統(tǒng)一管理 多個(gè)環(huán)境(RD/QA/PRODUCTION)、多個(gè)平臺(tái) 的所有配置
  • 配置更新自動(dòng)化：用戶在平臺(tái)更新配置，使用該配置的系統(tǒng)會(huì)自動(dòng)發(fā)現(xiàn)該情況，并應(yīng)用新配置。特殊地，如果用戶為此配置定義了回調(diào)函數(shù)類，則此函數(shù)類會(huì)被自動(dòng)調(diào)用。
• 配置異構(gòu)系統(tǒng)管理
  • 異構(gòu)包部署統(tǒng)一化：這里的異構(gòu)系統(tǒng)是指一個(gè)系統(tǒng)部署多個(gè)實(shí)例時(shí)，由于配置不同，從而需要多個(gè)部署包（jar或war）的情況（下同）。使用Disconf后，異構(gòu)系統(tǒng)的部署只需要一個(gè)部署包，不同實(shí)例的配置會(huì)自動(dòng)分配。特別地，在業(yè)界大量使用部署虛擬化（如JPAAS系統(tǒng)，SAE，BAE）的情況下，同一個(gè)系統(tǒng)使用同一個(gè)部署包的情景會(huì)越來(lái)越多，Disconf可以很自然地與他天然契合。
  • 異構(gòu)主備自動(dòng)切換：如果一個(gè)異構(gòu)系統(tǒng)存在主備機(jī)，主機(jī)發(fā)生掛機(jī)時(shí)，備機(jī)可以自動(dòng)獲取主機(jī)配置從而變成主機(jī)。
  • 異構(gòu)主備機(jī)Context共享工具：異構(gòu)系統(tǒng)下，主備機(jī)切換時(shí)可能需要共享Context?？梢允褂肅ontext共享工具來(lái)共享主備的Context。
• 極簡(jiǎn)的使用方式（注解式編程 或 XML無(wú)代碼侵入模式）：我們追求的是極簡(jiǎn)的、用戶編程體驗(yàn)良好的編程方式。目前支持兩種開(kāi)發(fā)模式：基于XML配置或者基于注解，即可完成復(fù)雜的配置分布式化。

注：配置項(xiàng)是指某個(gè)類里的某個(gè)Field字段。

其它功能特點(diǎn)

• 低侵入性或無(wú)侵入性、強(qiáng)兼容性：
  • 低侵入性：通過(guò)極少的注解式代碼撰寫，即可實(shí)現(xiàn)分布式配置。
  • 無(wú)侵入性：通過(guò)XML簡(jiǎn)單配置，即可實(shí)現(xiàn)分布式配置。
  • 強(qiáng)兼容性：為程序添加了分布式配置注解后，開(kāi)啟Disconf則使用分布式配置；若關(guān)閉Disconf則使用本地配置；若開(kāi)啟Disconf后disconf-web不能正常Work，則Disconf使用本地配置。
• 支持配置項(xiàng)多個(gè)項(xiàng)目共享，支持批量處理項(xiàng)目配置。
• 配置監(jiān)控：平臺(tái)提供自校驗(yàn)功能（進(jìn)一步提高穩(wěn)定性），可以定時(shí)校驗(yàn)應(yīng)用系統(tǒng)的配置是否正確。

模塊架構(gòu)圖

查看大圖

模塊信息

• CLIENT: client目標(biāo)是支持多語(yǔ)言。目前只提供了java語(yǔ)言客戶端。
  • JAVA
    • disconf-core: 分布式配置基礎(chǔ)包模塊
    • disconf-client: 分布式配置客戶端模塊, 依賴disconf-core包。 用戶程序使用它作為Jar包進(jìn)行分布式配置編程。
    • disconf-tool: 分布式配置工具包，依賴disconf-core包。 Disconf-tool是disconf的輔助工具類, 目前使用不多，建議不使用。
• 管理端：disconf-web是統(tǒng)一的分布式配置管理平臺(tái)。disconf-web: 分布式配置平臺(tái)服務(wù)模塊, 依賴disconf-core包。采用SpringMvc+純HTML方式（前后端分離架構(gòu)）實(shí)現(xiàn)。用戶使用它來(lái)進(jìn)行日常的分布式配置管理。

用戶指南

clint

java client: disconf-client 使用

在您的 Maven POM 文件里加入：

    com.baidu.disconf
    disconf-client
    2.6.31

server: disconf-web 使用

部署方法請(qǐng)參見(jiàn)：https://github.com/knightliao/disconf/tree/master/disconf-web

全新主頁(yè)，高清大圖：

APP+環(huán)境+版本+ZK查詢：

java client Tutorials

總體概述

• TutorialSummary 功能總體概述
• 文章介紹：分布式配置管理平臺(tái)Disconf

基于注解式的分布式配置（支持配置文件和配置項(xiàng)）

推薦新建的項(xiàng)目使用disconf時(shí)使用

• Tutorial 1 注解式分布式的配置文件
• Tutorial 2 注解式分布式的配置文件高級(jí)篇: 配置更新的通知
• Tutorial 3 注解式分布式的配置項(xiàng)
• Tutorial 4 注解式分布式靜態(tài)配置文件和靜態(tài)配置項(xiàng)

注：將配置文件移至一個(gè)專有類里，而不是分散在項(xiàng)目的各個(gè)地方，整個(gè)代碼架構(gòu)清晰易懂、易管理。 即便如果哪天不使用disconf，也只需要將注解去掉即可。

基于XML的分布式配置（無(wú)代碼侵入）（僅支持配置文件）

推薦舊項(xiàng)目使用disconf時(shí)使用

• Tutorial 8 基于XML的分布式配置文件管理,自動(dòng)reload
• Tutorial 5 基于XML的分布式配置文件管理,不會(huì)自動(dòng)reload,對(duì)于那些比較重的資源如jdbc等，特別有用

demos

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

其它

• Tutorial 6 disconf-web 功能詳解
• Tutorial 7 可自定義的部分托管的分布式配置
• Tutorial disconf與dubbo的集成 demo
• Tutorial 9 實(shí)現(xiàn)真正意義上的統(tǒng)一上線包
• Tutorial 10 實(shí)現(xiàn)一個(gè)配置更新下載器agent
• 配置說(shuō)明
• 異常考慮
• 局限性和注意事項(xiàng)
• 注意事項(xiàng)
• Zookeeper異?？紤]

詳細(xì)設(shè)計(jì)和討論

• disconf-client詳細(xì)設(shè)計(jì)文檔
• disconf-web詳細(xì)設(shè)計(jì)文檔
• 細(xì)節(jié)討論