yonglehou/config-toolkit

Config toolkit用于简化从本地配置文件到zookeeper的迁移

分布配置工具包

在大型集群和分布式应用中，配置不宜分散到集群结点中，应该集中管理。

---

依赖

• JAVA 6+
• TOMCAT 7+

模块

• EasyZk - 封装应用到zookeeper的属性配置的获取及更新
• ConfigWeb - 提供web界面维护属性配置，提供配置导入导出功能

特性

• 集中管理集群配置
• 实现配置热更新
• Spring集成
• 本地配置覆盖
• 配置管理web界面
• 版本控制，支持灰度发布
• 支持为配置项添加注释

RELEASE NOTES

https://github.com/dangdangdotcom/config-toolkit/wiki/release-notes

词典

• ConfigFactory - 配置工厂，用于定义zookeeper地址及配置根目录
• ConfigNode - 配置组，一组配置信息，对应于遗留系统中的properties属性文件

使用

• maven

    <dependency>
      <groupId>com.dangdang</groupId>
      <artifactId>config-toolkit-easyzk</artifactId>
      <version>2.0.0-RELEASE</version>
    </dependency>

• 直接使用

    // 创建配置工厂指向zk的地址及配置在zk中的根地址，映射到zookeeper中的/projectx/modulex
	ConfigFactory configFactory = new ConfigFactory("zoo.host1:8181,zoo.host2:8181,zoo.host3:8181", "/projectx/modulex");
    // 从工厂中加载某配置组，映射到zookeeper中的/projectx/modulex/group0
	ConfigNode node = configFactory.getConfigNode("group0");
    // 从配置组中获取某配置，映射到zookeeper中的/projectx/modulex/group0/name
	Assert.assertNotNull(node.getProperty("name"));

• Spring PlaceholderConfigurer集成

	<bean id="configFactory" class="com.dangdang.config.service.easyzk.ConfigFactory">
		<constructor-arg name="connectStr" value="zoo.host1:8181,zoo.host2:8181,zoo.host3:8181" />
		<constructor-arg name="rootNode" value="/projectx/modulex" />
	</bean>

	<bean id="zookeeperSources" class="com.dangdang.config.service.easyzk.support.spring.ZookeeperSourceFactory" factory-method="create">
		<constructor-arg name="configFactory" ref="configFactory" />
		<constructor-arg name="nodes">
			<list>
				<value>config-group1</value>
				<value>config-group2</value>
				<value>config-group3</value>
			</list>
		</constructor-arg>
	</bean>

	<bean class="org.springframework.context.support.PropertySourcesPlaceholderConfigurer">
		<property name="order" value="1" />
		<property name="ignoreUnresolvablePlaceholders" value="true" />
		<property name="propertySources" ref="zookeeperSources" />
	</bean>

• spring spel集成

旧util properties用法：

	<util:properties id="configToolkitCommon" location="classpath:config-toolkit.properties" />

Config-toolkit支持：

	<bean id="configToolkitCommon" class="com.dangdang.config.service.easyzk.ConfigNode" 
		factory-bean="configFactory" factory-method="getConfigNode">
		<constructor-arg name="node" value="config-toolkit" />
	</bean>

• 本地配置覆盖(一般用于调试集群中的单点)

在classpath下添加本地配置文件,格式为XML,默认为local-override.xml,可以通过指定环境变量来修改 -Dlocal-override.file=yourfile.xml
[例]：

	<?xml version="1.0" encoding="UTF-8"?>
	<node-factories xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
		xsi:schemaLocation="http://crnlmchina.github.io/local-override.xsd">
		<node-factory root="/projectx/modulex">
			<group id="property-group1">
				<node key="string_property_key">Welcome here.</node>
			</group>
		</node-factory>
	</node-factories>

以上的配置会覆盖zookeeper中/projectx/modulex/property-group1/string_property_key的值为Welcome here.

• Config Web 管理界面

为避免误操作其它数据，Config Web将不再提供授权功能，仅保留鉴权，遗留系统的密码需要重置。
鉴权密码为节点的值，使用SHA1 HEX字符串加密，请手动操作zookeeper命令行创建密码。
一般linux系统都带有python，可以使用python脚本方便生成：

python -c "import hashlib;print hashlib.sha1('abc').hexdigest();"

# a9993e364706816aba3e25717850c26c9cd0d89d

echo "set /aaa/bbb a9993e364706816aba3e25717850c26c9cd0d89d" |./zkCli.sh -server localhost:2181