AutoConfig工具使用

下载安装Auto工具包：

• http://code.taobao.org/mvn/repository/com/alibaba/citrus/tool/antx-autoconfig/1.0.9/antx-autoconfig-1.0.9.tgz
• http://code.taobao.org/mvn/repository/com/alibaba/citrus/tool/antx-autoexpand/1.0.9/antx-autoexpand-1.0.9.tgz

tar zxvf autoconfig-1.0.9.tgztar zxvf autoexpand-1.0.9.tgzcp autoconfig /usr/local/bincp autoexpand /usr/local/bin------------------------------------------------------------------------------------------------------

引：<filter>${user.home}/antx.properties</filter>用指定的properties文件（${user.home}/antx.properties）中的值，替换上述文件行中的placeholders(占位符)

AutoConfig不需要提取源码，也不需要重新build，即可改变目标文件中所有配置文件中placeholders的值，并对placeholder及其值进行检查。

AutoConfig Features：

	/META-INF/autoconf目录用来存放AutoConfig的描述文件，以及可选的模板文件。
	auto-config.xml是用来指导AutoConfig行为的关键描述文件

创建war和jar包的AutoConfig机制，关键在于创建war或jar目标包中的/META-INF/autoconf/auto-config.xml描述文件

-----------------------------------------------------------------------------------------------------------------------------------

AutoConfig描述文件示例:

<?xml version="1.0" encoding="UTF-8"?>
<config>
    <group>

        <property name="petstore.work"
                    description="应用程序的工作目录" />

        <property name="petstore.loggingRoot"
                    defaultValue="${petstore.work}/logs"
                    description="日志文件目录" /> 

        <property name="petstore.upload"
                    defaultValue="${petstore.work}/upload"
                    description="上传文件的目录" />

        <property name="petstore.loggingLevel"
                    defaultValue="warn"
                    description="日志文件级别"> 

            <validator name="choice"
                         choice="trace, debug, info, warn, error" /> 

        </property>

    </group>
    <script>
        <generate template="WEB-INF/web.xml" /> 

        <generate template="WEB-INF/common/resources.xml" />
    </script>
</config>

	定义properties
	定义property的验证规则（可选）
	生成配置文件的指令。

定义一个property的完整格式如下：

例如下定义一个property

<property
    name="..."
    [defaultValue="..."]
    [description="..."]
    [required="true|false"]
>
    <validator name="..." />
    <validator name="..." />
    ...
</property>

可用的property参数包括：

定义property时可用的参数如下:

定义property的验证规则

目前，有以下几种验证器：

可用的property验证规则如下

<validator name="boolean" />

<validator name="choice"
           choice="trace, debug, info, warn, error" />

<validator name="email" />

<validator name="fileExist"
           [file="WEB-INF/web.xml"] />

<validator name="hostExist" />

<validator name="keyword" />

<validator name="number" />

<validator name="regexp"
           regexp="..."
           [mode="exact|prefix|contain"] />

<validator name="url"
           [checkHostExist="false"]
           [protocols="http, https"]
           [endsWithSlash="true"] />

生成配置文件的指令

描述文件中，每个<generate>标签指定了一个包含placeholders的配置文件模板，具体格式为：

生成配置文件的指令：

<generate
    template="..."
    [destfile="..."]
    [charset="..."]
    [outputCharset="..."]
>

下面是参数的说明：

生成配置文件的指令参数：

---------------------------------------------------------------------------------------------------------------------------

建立模板文件：

在auto-config.xml中定义了模板的位置后，把模板文件放在指定的位置。

AutoConfig的寻找模板的逻辑是：

• 如果在auto-config.xml所在的目录下发现模板文件，就使用它；
• 否则在包的根目录中查找模板文件；如果两处均未找到，则报错。

书写模板是很简单的事，你只要：

• 把需要配置的点替换成placeholder：“${property.name}”。当然，你得确保property.name被定义在auto-config.xml中。
• 假如模板中包含不希望被替换的运行时的placeholder“${...}”，需要更改成“${D}{...}” 。

此外，AutoConfig模板其实是由Velocity模板引擎来渲染的。因此，所有的placeholder必须能够通过velocity的语法。

使用不符合velocity语法的placeholders

例如，下面的placeholder被velocity看作非法：

${my.property.2}

解决的办法是，改写成如下样式：

${my_property_2}-----------------------------------------------------------------------------------------------------------------------------------Autoconfig工具的使用

最简单的AutoConfig命令

autoconfig petstore.war        无论petstore.war是一个zip包还是目录，AutoConfig都会正确地生成其中的配置文件

AutoConfig会生成一个日志文件，就在auto-config.xml所在的目录下，名字为：auto-config.xml.log。

默认情况下，AutoConfig会按下列顺序查找user properties：

1. 当前目录 ./antx.properties
2. 当前用户HOME目录/antx.properties

你可以指定一个自己的properties文件，用下面的命令：

autoconfig ...  –u  my.props

你可以指定另一个输出文件或目录，这样，原来的文件或目录就不会被修改:

autoconfig petstore.war  –o  petstore-configured.war

如果antx.properties文件中指定了相应”Property name“的替换值，而auto-config.xml描述文件中不存在该”Property name“时，则执行autoconfig时会提示如下图所示要求更新antx.properties配置文件内容。逐项选择Next后再选Yes保存即可。

摘自http://webx.taobao.org/docs/autoconfig.html 

AutoConfig工具使用