ANT十五大最佳实践

《ANT十五大最佳实践》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、ANT十五大最佳实践作者：EricM.Burke,coauthorofJavaExtremeProgrammingCookbook原文：http://www.onjava.com/pub/a/onjava/2003/12/17/ant_bestpractices.html译者：徐彤MSN:xt121@hotmail.com 在Ant出现之前，构建和部署Java应用需要使用包括特定平台的脚本、Make文件、各种版本的IDE甚至手工操作的“大杂烩”。现在，几乎所有的开源Java项目都在使用Ant，大多数公司的

2、内部项目也在使用Ant。Ant在这些项目中的广泛使用自然导致了读者对一整套Ant最佳实践的迫切需求。本文总结了我喜爱的Ant技巧或最佳实践，多数是从我亲身经历的项目错误或我听说的其他人经历的“恐怖”故事中得到灵感的。比如，有人告诉我有个项目把XDoclet生成的代码放入带有锁定文件功能的版本控制工具中。当开发者修改源代码时，他必须记住手工检出（Checkout）并锁定所有将要重新生成的文件。然后，手工运行代码生成器，只到这时他才能够让Ant编译代码，这一方法还存在如下一些问题：·生成的代码无法存储在版本控

3、制系统中。·Ant（本案例中是Xdoclet）应该自动确定下一次构建涉及的源文件，而不应由程序员手工确定。·Ant的构建文件应该定义好正确的任务依赖关系，这样程序员就不必为了完成构建而不得不按照特定顺序调用任务。当我开始一个新项目时，我首先编写Ant构建文件。Ant文件明确地定义构建的过程，并被团队中的每个程序员使用。本文所列的技巧基于这样的假定：Ant构建文件是一个必须仔细编写的重要文件，它应在版本控制系统中得到维护，并被定期进行重构。下面是我的十五大Ant最佳实践。1.采用一致的编码规范Ant用户有的

4、喜欢有的痛恨其构建文件的XML语法。与其跳进这一令人迷惑的争论中，不如让我们先看一些能保持XML构建文件简洁的方法。首先也是最重要的，花费时间格式化你的XML让它看上去很清晰。不论XML是否美观，Ant都可以工作。但是丑陋的XML很难令人读懂。倘若你在任务之间留出空行，有规则的缩进，每行文字不超过90列左右，那么XML令人惊讶地易读。再加上使用能够高亮XML语法的优秀编辑器或IDE工具，你就不会有阅读的麻烦。同样，精选含意明确、容易读懂的词汇来命名任务和属性。比如，dir.reports就比rpts好。特

5、定的编码规范并不重要，只要拿出一套规范并坚持使用就行。2.将build.xml放在项目根目录中Ant构建文件build.xml可以放在任何位置，但是放在项目顶级目录中可以保持项目简洁。这是最常用的规范，开发者能够在顶级目录中找到预期的build.xml。把构建文件放在根目录中，也能够使人容易了解项目目录树中不同目录之间的逻辑关系。以下是一个典型的项目目录层次：[rootdir]

6、build.xml+--src+--lib(包含第三方JAR包)+--build(由build任务生成)+--dist(由bui

7、ld任务生成)当build.xml在顶级目录时，假设你处于项目某个子目录中，只要输入：ant-findcompile命令，不需要改变工作目录就能够以命令行方式编译代码。参数-find告诉Ant寻找存在于上级目录中的build.xml并执行。3.使用单一的构建文件有人喜欢将一个大项目分解成几个小的构建文件，每个构建文件分担整个构建过程的一小部分工作。这确实是看法不同的问题，但是应该认识到，将构建文件分割会增加对整体构建过程的理解难度。要注意在单一构建文件能够清楚表现构建层次的情况下不要过工程化(over-e

8、ngineer)。即使你把项目划分为多个构建文件，也应使程序员能够在项目根目录下找到核心build.xml。尽管该文件只是将实际构建工作委派给下级构建文件，也应保证该文件可用。4.提供良好的帮助说明应尽量使构建文件自文档化。增加任务描述是最简单的方法。当你输入ant-projecthelp时，你就可以看到带有描述的任务清单。比如，你可以这样定义任务：最简单的规则

9、是把所有你想让程序员通过命令行就可以调用的任务都加上描述。对于一般用来执行中间处理过程的内部任务，比如生成代码或建立输出目录等，就无法使用描述属性。这时，可以通过在构建文件中加入XML注释来处理。或者专门定义一个help任务，当程序员输入anthelp时来显示详细的使用说明。Detaile