Disconf分布式配置管理平臺

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

專注于各種?分布式系統配置管理?的通用組件/通用平臺, 提供統一的配置管理服務。

包括?百度、滴滴打車、銀聯、網易、拉勾網?等知名互聯網公司正在使用!

「disconf」在「2015 年度新增開源軟件排名 TOP 100(OSC開源中國提供)」中排名第16強。

主要目標：

• 部署極其簡單：同一個上線包，無須改動配置，即可在 多個環境中(RD/QA/PRODUCTION) 上線
• 部署動態化：更改配置，無需重新打包或重啟，即可 實時生效
• 統一管理：提供web平臺，統一管理 多個環境(RD/QA/PRODUCTION)、多個產品 的所有配置
• 支持微服務架構

demos

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

項目信息

• 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.31-SNAPSHOT
• master(stable branch)：2.6.31
• 更新日志
• 在Maven Central Repository里查看?com.baidu.disconf

Java Client Elegant Usage Preview

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

當前版本功能特點

• 支持配置（配置項+配置文件）的分布式化管理
• 配置發布統一化
• 極簡的使用方式（注解式編程 或 XML無代碼侵入模式）
• 低侵入性或無侵入性、強兼容性

未來版本（完全版）功能特點

Disconf的功能特點描述圖：

查看大圖

重要功能特點

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

注：配置項是指某個類里的某個Field字段。

其它功能特點

• 低侵入性或無侵入性、強兼容性：
  • 低侵入性：通過極少的注解式代碼撰寫，即可實現分布式配置。
  • 無侵入性：通過XML簡單配置，即可實現分布式配置。
  • 強兼容性：為程序添加了分布式配置注解后，開啟Disconf則使用分布式配置；若關閉Disconf則使用本地配置；若開啟Disconf后disconf-web不能正常Work，則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方式（前后端分離架構）實現。用戶使用它來進行日常的分布式配置管理。

用戶指南

clint

java client: disconf-client 使用

在您的 Maven POM 文件里加入：

    com.baidu.disconf
    disconf-client
    2.6.31

server: disconf-web 使用

部署方法請參見：https://github.com/knightliao/disconf/tree/master/disconf-web

全新主頁，高清大圖：

APP+環境+版本+ZK查詢：

java client Tutorials

總體概述

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

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

推薦新建的項目使用disconf時使用

• Tutorial 1 注解式分布式的配置文件
• Tutorial 2 注解式分布式的配置文件高級篇: 配置更新的通知
• Tutorial 3 注解式分布式的配置項
• Tutorial 4 注解式分布式靜態配置文件和靜態配置項

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

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

推薦舊項目使用disconf時使用

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

demos

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

其它

• Tutorial 6 disconf-web 功能詳解
• Tutorial 7 可自定義的部分托管的分布式配置
• Tutorial disconf與dubbo的集成 demo
• Tutorial 9 實現真正意義上的統一上線包
• Tutorial 10 實現一個配置更新下載器agent
• 配置說明
• 異?？紤]
• 局限性和注意事項
• 注意事項
• Zookeeper異?？紤]

詳細設計和討論

• disconf-client詳細設計文檔
• disconf-web詳細設計文檔
• 細節討論