Disconf

Distributed Configuration Management Platform

分布式配置管理平台

项目信息

• Java项目(1.6+)
• Maven管理(3.0.5+)

disconf.git branches and Maven version:

• dev(develop branch): 2.6.19-SNAPSHOT
• master(stable branch)：2.6.18
• 更新日志

在Maven Central Repository里查看 com.baidu.disconf

它是什么?

• 命名为Disconf
• 专注于各种系统的配置管理的通用组件/通用平台

Disconf可以为各种业务平台提供统一的配置管理服务。

当前版本（2.6.18）功能特点

• 支持配置（配置项+配置文件）的分布式化管理
• 配置发布统一化
• 注解式编程，极简的使用方式
• 支持Spring方式编程
• 低侵入性和强兼容性

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

重要功能特点

• 支持配置（配置项+配置文件）的分布式化管理
• 配置发布统一化
  • 配置发布、更新统一化（云端存储、发布）:配置存储在云端系统，用户统一在平台上进行发布、更新配置。
  • 配置更新自动化：用户在平台更新配置，使用该配置的系统会自动发现该情况，并应用新配置。特殊地，如果用户为此配置定义了回调函数类，则此函数类会被自动调用。
• 配置异构系统管理
  • 异构包部署统一化：这里的异构系统是指一个系统部署多个实例时，由于配置不同，从而需要多个部署包（jar或war）的情况（下同）。使用Disconf后，异构系统的部署只需要一个部署包，不同实例的配置会自动分配。特别地，在业界大量使用部署虚拟化（如JPAAS系统，SAE，BAE）的情况下，同一个系统使用同一个部署包的情景会越来越多，Disconf可以很自然地与他天然契合。
  • 异构主备自动切换：如果一个异构系统存在主备机，主机发生挂机时，备机可以自动获取主机配置从而变成主机。
  • 异构主备机Context共享工具：异构系统下，主备机切换时可能需要共享Context。可以使用Context共享工具来共享主备的Context。
• 注解式编程，极简的使用方式：我们追求的是极简的、用户编程体验良好的编程方式。通过简单的标注+极简单的代码撰写，即可完成复杂的配置分布式化。
• 支持Spring方式和非Spring方式编程：用户可以自行选择编程习惯，是否采用Spring方式进行编程。推荐Spring编程方式。

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

Disconf的功能特点描述图：

查看大图

其它功能特点

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

模块架构图

查看大图

模块信息##

• disconf
  • disconf-core: 分布式配置基础包模块
  • disconf-client: 分布式配置客户端模块, 依赖disconf-core包。 用户程序使用它作为Jar包进行分布式配置编程。
  • disconf-tool: 分布式配置工具包，依赖disconf-core包。 Disconf-tool是disconf的辅助工具类。
  • disconf-web: 分布式配置平台服务模块, 依赖disconf-core包。采用SpringMvc+纯HTML方式实现。 用户使用它来进行日常的分布式配置管理。
• demo
  • disconf-spring-demo: 使用disconf的SpringMvc Web demo程序
  • disconf-standalone-demo: 使用disconf的基于Spring的standalone demo程序
  • disconf-standalone-dubbo-demo: 集成了disconf和dubbo的基于Spring的standalone demo程序

用户指南

用户请关注这里。

概述

Disconf为应用方提供了三个工具，

1. disconf-client, 您可以在您的应用系统里加入此Jar包；
2. disconf-web, 它是一个Web平台，您可以此Web平台上管理您的配置。
3. disconf-tool,可选包。

disconf-client 使用

在您的 Maven POM 文件里加入：

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

disconf-web 使用

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

全新主页，高清大图：

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

disconf-client Tutorials

• TutorialSummary 功能总体概述
• Tutorial 1 分布式的配置文件
• Tutorial 2 分布式的配置文件高级篇: 配置更新的通知
• Tutorial 3 分布式的配置项
• Tutorial 4 分布式静态配置文件和静态配置项
• Tutorial 5 非注解式(托管式)的分布式配置文件动态管理
• Tutorial 6 disconf-web 功能详解
• Tutorial 7 可自定义的部分托管的分布式配置
• Tutorial 8 disconf与dubbo的集成 demo
• 配置说明
• 异常考虑
• 局限性和注意事项
• 注意事项
• Zookeeper异常考虑

开发人员指南

• disconf-client详细设计文档
• disconf-web详细设计文档
• 细节讨论

其它

• PPT下载: 分布式配置中心服务20140624.pptx
• 安全性: Disconf并没有配置审核相关的实现，但这并不意味着Disconf不重视安全性。Disconf未来可以与其它审核系统对接。
• 联系·讨论
  • QQ群: 239203866

disconf-client 主要依赖

主要依赖为：

+- org.apache.zookeeper:zookeeper:jar:3.3.6:compile
[INFO] |  +- log4j:log4j:jar:1.2.14:compile
[INFO] |  \- jline:jline:jar:0.9.94:compile
[INFO] +- com.google.code.gson:gson:jar:2.2.4:compile
[INFO] +- javax.ws.rs:javax.ws.rs-api:jar:2.0-rc1:compile
[INFO] |  \- javax.annotation:javax.annotation-api:jar:1.2-b02:compile
[INFO] +- org.reflections:reflections:jar:0.9.9-RC1:compile
[INFO] |  +- com.google.guava:guava:jar:11.0.2:compile
[INFO] |  |  \- com.google.code.findbugs:jsr305:jar:1.3.9:compile
[INFO] |  +- org.javassist:javassist:jar:3.16.1-GA:compile
[INFO] |  \- dom4j:dom4j:jar:1.6.1:compile
[INFO] +- ch.qos.logback:logback-core:jar:1.0.9:compile
[INFO] +- ch.qos.logback:logback-classic:jar:1.0.9:compile
[INFO] +- org.slf4j:slf4j-api:jar:1.7.6:compile
[INFO] +- com.baidu.disconf:disconf-core:jar:2.6.18:compile
[INFO] |  +- commons-io:commons-io:jar:1.4:compile
[INFO] |  +- commons-lang:commons-lang:jar:2.4:compile
[INFO] |  +- org.glassfish.jersey.media:jersey-media-json-jackson:jar:2.0-m13:compile
[INFO] |  |  +- org.glassfish.jersey.core:jersey-common:jar:2.0-m13:compile
[INFO] |  |  +- org.codehaus.jackson:jackson-core-asl:jar:1.9.8:compile
[INFO] |  |  +- org.codehaus.jackson:jackson-mapper-asl:jar:1.9.8:compile
[INFO] |  |  +- org.codehaus.jackson:jackson-jaxrs:jar:1.9.8:compile
[INFO] |  |  \- org.codehaus.jackson:jackson-xc:jar:1.9.8:compile
[INFO] |  +- org.glassfish.jersey.core:jersey-client:jar:2.0-m13:compile
[INFO] |  |  +- org.glassfish.hk2:hk2-api:jar:2.1.64:compile
[INFO] |  |  |  +- org.glassfish.hk2:osgi-resource-locator:jar:1.0.1:compile
[INFO] |  |  |  +- javax.inject:javax.inject:jar:1:compile
[INFO] |  |  |  \- org.glassfish.hk2:hk2-utils:jar:2.1.64:compile
[INFO] |  |  \- org.glassfish.hk2:hk2-locator:jar:2.1.64:compile
[INFO] |  |     +- org.glassfish.hk2.external:javax.inject:jar:2.1.64:compile
[INFO] |  |     +- org.glassfish.hk2.external:asm-all-repackaged:jar:2.1.64:compile
[INFO] |  |     \- org.glassfish.hk2.external:cglib:jar:2.1.64:compile
[INFO] |  \- com.github.knightliao.apollo:apollo:jar:1.0.5:compile
[INFO] +- com.baidu.disconf:disconf-core:test-jar:tests:2.6.18:test
[INFO] +- org.aspectj:aspectjtools:jar:1.7.4:compile
[INFO] +- org.springframework:spring-test:jar:3.1.2.RELEASE:test
[INFO] +- com.google.guava:guava:jar:site:16.0:compile
[INFO] +- com.googlecode.jmockit:jmockit:jar:1.5:test
[INFO] +- com.googlecode.jmockit:jmockit-coverage:jar:0.999.24:test
[INFO] +- com.github.tomakehurst:wiremock:jar:standalone:1.46:test
[INFO] |  +- net.sf.jopt-simple:jopt-simple:jar:4.3:test
[INFO] |  +- xmlunit:xmlunit:jar:1.5:test
[INFO] |  +- com.fasterxml.jackson.core:jackson-core:jar:2.1.2:test
[INFO] |  +- org.mortbay.jetty:jetty:jar:6.1.14:test
[INFO] |  +- org.skyscreamer:jsonassert:jar:1.2.1:test
[INFO] |  |  \- org.json:json:jar:20090211:test
[INFO] |  +- com.jayway.jsonpath:json-path:jar:0.8.1:test
[INFO] |  |  \- net.minidev:json-smart:jar:1.1.1:test
[INFO] |  +- org.apache.httpcomponents:httpclient:jar:4.2.3:test
[INFO] |  |  +- org.apache.httpcomponents:httpcore:jar:4.2.2:test
[INFO] |  |  \- commons-codec:commons-codec:jar:1.6:test
[INFO] |  +- com.fasterxml.jackson.core:jackson-annotations:jar:2.1.2:test
[INFO] |  +- junit:junit-dep:jar:4.10:test
[INFO] |  \- com.fasterxml.jackson.core:jackson-databind:jar:2.1.2:test
[INFO] +- org.springframework:spring-context:jar:3.1.2.RELEASE:compile
[INFO] |  +- org.springframework:spring-expression:jar:3.1.2.RELEASE:compile
[INFO] |  \- org.springframework:spring-asm:jar:3.1.2.RELEASE:compile
[INFO] +- org.springframework:spring-beans:jar:3.1.2.RELEASE:provided
[INFO] +- org.springframework:spring-core:jar:3.1.2.RELEASE:provided
[INFO] |  \- commons-logging:commons-logging:jar:1.0.4:provided
[INFO] +- org.springframework:spring-aop:jar:3.1.2.RELEASE:provided
[INFO] |  \- aopalliance:aopalliance:jar:1.0:provided
[INFO] +- junit:junit:jar:4.10:test
[INFO] |  \- org.hamcrest:hamcrest-core:jar:1.1:test
[INFO] \- cglib:cglib:jar:2.2.2:compile
[INFO]    \- asm:asm:jar:3.3.1:compile