java自动化配置工具 - autoconfig 简介
对于java程序员来说各种各样的配置文件是司空见惯的，比如spring的bean配置，struts的action配置等等。有些配置会随着运行环境的变化而各不相同，最典型的就是jdbc驱动的配置，在开发环境可能链接到开发本地的数据库，测试环境则有一套测试专用的数据库环境，线上的生产环境也会有一套数据库，如果一个应用要部署到多个idc中，那这些配置又有可能各不相同。解决这个问题，可能有些团队使用同一份配置文件，在部署到不同的环境之前人肉的修改一下配置，还有些团队会为每一个环境维护一份配置文件。这些做法都比较容易出错，而且随着环境的增多成本会线性地增长。
本文通过一个示例简单介绍一个自动化的配置工具autoconfig。autoconfig使用一套配置模板，为不同的环境生成相应的具体配置。它的核心思想是把一些可变的配置定义为一个模板，在autoconfig运行的时候从这些模板中生成具体的配置文件。autoconfig支持两种运行方式，第一种是作为普通的java应用程序从命令行来调用，另一种是作为maven的插件来运行。本文通过一个maven项目展示一下如何在maven中使用autoconfig。
autoconfig是一个淘宝开源的web框架webx的一个工具包，svn地址为 http://code.taobao.org/svn/webx/citrus-tool/trunk/，使用之前先checkout源代码本地安装一下，当然感兴趣的同学也可已研究一下它的源代码。安装非常简单，在checkout的源代码的根目录下运行 mvn clean install -Dmaven.test.skip。由于autoconfig使用maven build，安装之前必须先安装maven，不知到如何安装maven的同学可以google一下。
首先通过maven新建一个普通的java项目，运行下面这个命令，敲几个回车就能通过maven创建一个普通的java应用程序项目。
mvn archetype:generate -DgroupId=net.kiminotes -DartifactId=autoconfig -Dpackage=net.kiminotes
先删除maven自动创建的一些java源代码 find . -name *.java -exec rm \{} \; (这是linux下的一个工具，使用windows的同学可以通过资源管理器来删除)。创建一个简单的java类 Main，类中只有一个main方法，这个方法读取一个配置文件，并在控制台输出整个配置文件，代码如下。
从代码中可以看到实现的功能非常简单：从classpath中读取配置文件config.properties，然后输出到控制台。
接下来创建antoconfig的描述文件auto-config.xml以及配置文件config.properties的模板config.properties.vm。
config.properties的模板内容如下，它只有一行配置。
property元素定义了一个需要autoconfig配置的属性 net.kiminotes.value。group元素把不同类库的property进行分组，这里仅配置了一个group。generate定义了一个配置文件生成策略，template属性定义了配置文件的的模板，destfile定义了生成后配置文件的存放位置。
注: 有人或许会感觉迷惑，在模板文件config.properties.vm中，需要被替换的明明是net_kiminotes_value，为什么在auto-config.xml文件中会定义属性 net.kiminotes.value 呢？现在只需要记住属性名中的点在autoconfig执行的时候会被替换成下划线，具体原因会在后续的blog中解释。
最后在pom中配置一下maven autoconfig插件，整个pom文件如下。
如果看不明白上面pom中插件的配置可以参加maven相关的一些书籍。
在配置文件的模板 config.properties.vm 中有一个配置变量 ${net_kiminotes_value} 在执行autoconfig的时候需要被替换，那怎么给这个配置项赋值呢？autoconfig提供了两种方式来给配置变量赋值第一从java属性文件中读取第二是交互式地编辑。autoconfig首先读取当前工作目录的antx.properties文件，如果没有则读取${user.home}/antx.properties文件，如果这个文件也不存在，autoconfig就会启动交互式编辑器请求用户输入配置变量的值，如果配置变量的值是不完整的autoconfig则会立即停止配置并抛出一个异常。如果java属性文件的位置不在autoconfig默认的位置可以通过参数autoconfig.userProperties进行配置。处于简单其间，我们在当前目录新建一个java属性文件antx.properties，这个文件中定义了配置变量${net_kiminotes_value}的值。antx.properties 文件的内容如下。
net.kiminotes.value = hello, world
整个项目的结构如下所示：
下面运行maven来build这个项目。运行 mvn package，在target目录下生成一个jar包autoconfig-1.0-SNAPSHOT.jar，运行这个jar包。
本文介绍了一个自动化的配置工具autoconfig，虽然它能解决部署前的软件配置问题，但它同样有一个很关键的问题，与ide没有任何集成，给开发以及单元测试带来一定的麻烦，这就要靠各个使用者开动脑筋来解决这个问题了。
附近是示例的所有源文件。
如果您所在的公司在这方面有更好的实践不妨在留言中跟大家分享一下，前提是不违背您所在公司的保密协议。
--EOF--
1 楼 guooscar 2011-04-30 配置集中管理，使用中央配置仓库，将可变内容存储在数据库中（文本，DB都可以），然后使用模版引擎（velocity，jsp等）生成最终的配置文件，并且提供http或者其他类型的接口给使用方在应用启动前调用 2 楼 lvgang 2011-05-02 guooscar 写道配置集中管理，使用中央配置仓库，将可变内容存储在数据库中（文本，DB都可以），然后使用模版引擎（velocity，jsp等）生成最终的配置文件，并且提供http或者其他类型的接口给使用方在应用启动前调用
呵呵，想法和我们不谋而合，公司内部也有这样一个系统，集中管理各种环境的配置。但这只能处理静态配置，还有一些动态的运行时配置是需要特殊处理的，用这种方式可能就处理不了了。 3 楼 azheng270 2011-09-11 [INFO] Unable to find resource 'com.alibaba.citrus.tool:maven-autoconfig-plugin:pom:1.0.9' in repository central (http:/
/repo1.maven.org/maven2)
不是开放的东西, 没什么用, 浪费时间
