基于Ant构建的Java项目布局最佳实践

我有点震惊(如果?)这个精确的问题还没有被问到,但是15分钟的扫描没有找到一个精确的匹配。(如果我错了,给我指正确的方向,投票结束……)

问题1:

在Ant构建系统下部署Java项目的最佳实践是什么? 就我们的目的而言,我们有以下背景(也许其中大部分是不相关的):

• 大多数开发人员都在使用Eclipse(不是全部)
• 在subversion中维护项目
• 项目构建最近迁移到了Hudson,在Hudson中,我们希望使用发布插件来管理发布,并使用一些自定义脚本来处理自动部署
• 该项目是一个“常规”应用程序,一种“生产原型”,用户池非常有限,但它们位于具有气隙分离的远程站点,因此提供版本化、可跟踪的工件以便于安装、手动数据收集/恢复和远程诊断非常重要。
• 一些依赖项(jar)包含在SVN repo中;如果需要,可以在构建时通过ant脚本获取其他依赖项。没有什么比常春藤更奇特的了(请不要告诉我换成Maven3。。。我知道,如果合适的时候我们会这样做的。)
• 构建包括JUnit、FindBugs、CheckStyle、PMD、JavaDoc,以及一些自定义文档生成
• 两个或三个主JAR工件(一个主应用程序工件加上几个最小的API JAR以包含在几个耦合的应用程序中)
• 希望分发以下分发工件:
  • 一个“完整”的源代码+bin tarball,解决了所有依赖项,jars和JavaDoc都是预先构建的
  • 一个bin tarball,只有docs和JavaDoc、jars和辅助包装脚本等
  • 一个“Partner”源代码+bin,其中包含合作开发人员可能要查看的“共享”源代码,以及相关的测试用例

当前结构如下

project-root/
project-root/source                 
project-root/source/java             // main application (depends on -icd)
project-root/source/java-icd         // distributable interface code
project-root/source/test             // JUnit test sources
project-root/etc                     // config/data stuff
project-root/doc                     // pre-formatted docs (release notes, howtos, etc)
project-root/lib                     // where SVN-managed or Ant-retrieved Jars go
project-root/bin                     // scripts, etc...

在构建时,它扩展到包括:

build/classes                        // Compiled classes
build/classes-icd 
build/classes-test
build/javadoc
build/javadoc-icd                    
build/lib                            // Compiled JAR artifacts
build/reports                        // PMD, FindBugs, JUnit, etc... output goes here
build/dist                           // tarballs, zipfiles, doc.jar/src.jar type things, etc..
build/java                           // Autogenerated .java products
build/build.properties               // build and release numbering, etc...

问题2:

如何在开发树中保持修订控制项和构建时工件之间的严格分离 当 产生如上所述的相干分布 以及 允许我在开发和测试期间将开发树视为操作/分发? 尤其是,我不愿意 <jar> 顶级的task drop.jar文件 lib 目录——开发人员树中的目录是不可侵犯的SVN领域。但是分发一些公共用途的东西 build/lib/*.jar 是令人困惑的烦恼。文档和其他构建的工件也是如此,我们希望它们出现在发行版中的一致位置,但不希望开发人员和用户使用完全不同的目录结构。

将所有生成的产品放在一个单独的 build/ 目录在开发时是非常好的,但是它是一个烦人的工件。为了便于分发,我宁愿把所有的罐子放在一个 图书馆 位置,实际上,下面这样的结构最有意义。目前,我们正在使用 ant dist 通过执行一些复杂的路径操作,如.tar.gz和.zip工件被构建。

我觉得这个蒸馏器应该是什么样子的:

project-root/
project-root/source                  // present in only some dists 
project-root/etc                     // same as in development tree
project-root/doc                     // same as in development tree
project-root/doc/javadoc             // from build 
project-root/lib                     // all dependency and built JAR files
project-root/bin                     // same as in development tree
build.properties               // build and release numbering, etc...

这个问题仅限于“如何维护清洁的开发和分发项目布局?”正如我上面所问;同时也收集关于Java/Ant项目布局的一般信息,以及对我们特定方法的评论。(是的,如果你认为它应该是一个社区Wiki,我会这么做的……)