maven很强大,但是总有些事情干起来不是得心应手,没有使用ant时那种想怎么干就怎么干的流畅感。尤其当要打包一个特殊(相对maven的标准架构而且)时,常有不知所措的感觉。当然这个应该和自己对maven的了解不够有关,毕竟,“初学maven”嘛。
但是maven在依赖管理方面实在是太强大了,太喜欢,退回原来的ant方式完全不可能,我想用过maven的人,一般是不会有回到原来在cvs,subversion中checkin/checkout n个jar包的时代,仅此一项理由就足够继续坚持使用maven了。
然而ant的灵活又难于忘怀,尤其是从ant的build.xml一路走来的人,总是回不知不觉间想到ant的美好。鱼与熊掌,我都想要。最近想打包一个java应用,很简单但即不是标准的j2ee appication也不是web application, 用maven完全不知道该怎么打包,package出来的完全不是我想要的,在网上四处Google maven资料的时候,总有用回ant拉倒的冲动。
先交代一下背景吧,我要打包的程序,是这个样子:
demo1 |____lib |_____demo1.jar |_____*****.jar |_____*****.jar |____config |_____*****.properties |_____*****.xml |____log |_____*****.log |____run.bat |____run.sh
这个应用的打包模式很简单,一个bat或者sh脚本用来执行,lib目录下存放所有的jar包,包括自己的源代码编译打包的jar和第三方包。config下是配置文件,这些文件需要在安装时或者运行前修改,比如监听的端口啊,数据库信息之类的。log目录存放日志文件。最后打包的产物是一个zip包(或者tar,tar.gz)。
遇到的问题,就是maven标准的打包方式中根本不考虑类似的情况,什么jar,ear,war完全不适用。而且maven有些理念也诧异,比如maven标准的config目录是src/main/config,但是这个目录里面的配置文件默认会打包到jar包中,晕,都在jar里面了还让人怎么改啊?
本着尽量只用maven不用ant的想法,我在maven的资料中看了好久,没有找到解决的方法。晕,难道大家都只打包标准的ear,jar,war,只有我这样无聊的人才会有这种打包的需求?
几经寻觅和探索,最后发现,maven ant tasks似乎是一个不错的选择。带着mavenanttasks的官方文档和Google上搜到的几篇文章,开始尝试,成功实现功能。现在将过程和方法share给大家。
首先建立java项目anttaskdemo1,按照maven的推荐,文件结构如下:
anttaskdemo1 |____src/main/java |____src/main/config |____src/main/bin |____src/main/resources |____src/test/java |____src/test/resources |____target |____build.properties |____build.xml |____pom.xml
其中src/main/java下放java代码;src/main/resources下放一个*.properties文件,这个资源文件是打包到jar中,内容打包之后不需要改变的。src/main/config下放一个标准的log4j.xml,这个是有在安装运行前临时修改的需要的。src/main/bin下放置可执行文件。
1. 首先看pom.xml,标准内容,很简单,象征性的加入几个依赖
commons-codec commons-codec 1.3 log4j log4j 1.2.13 compile org.testng testng 5.8 test jdk15
其中commons-codec,log4j是需要打包到lib中的,运行时需要。testng(或者更一般的junit)是用来单元测试的,不需要打包到lib中。请注意它的设置”test”。
2. 然后看看build.properties文件,这个内容不多:
M2_REPO=G:/soft/maven/localReposiTory
path.package=packagepath.target.name=anttaskdemo1path.package.lib=libpath.package.log=logpath.package.config=configpath.package.bin=
M2_REPO稍后再详谈,后面的path.package之类的是最终打包时使用的几个目录名称,对应于最终打包的结构。
3. build.xml,这个内容比较多。 begintodoalltargettobuildtheresultpackage. MavenbuilddirecToryis${maven.project.build.direcTory} MavenbuildfinalNameis${maven.project.build.finalName} MavenbuildsourceDirecTorydirecToryis${maven.project.build.sourceDirecTory} MavenbuildoutputDirecTorydirecToryis${maven.project.build.outputDirecTory} MavenbuildscriptSourceDirecTorydirecToryis${maven.project.build.testSourceDirecTory} MavenbuildtestOutputDirecTorydirecToryis${maven.project.build.testOutputDirecTory} MavenbuildscriptSourceDirecTorydirecToryis${maven.project.build.scriptSourceDirecTory} MavenbuildresourceDirecTorydirecToryis${maven.project.build.resources} MavenbuildscriptSourceDirecTorydirecToryis${target.jar.name} cleanbuilddirecTory:${maven.project.build.direcTory} makedirforjavacompile:${maven.project.build.outputDirecTory} cleanpackagedirecTory:${maven.project.build.direcTory}/${path.package}
一步一步来讲吧:
3.1 最重要的一步,init_maven
在ant中使用maven-ant-tasks,就需要装载maven-ant-tasks的jar包,方法有两种,一种是直接将maven-ant-tasks-2.0.9.jar放到ant的lib下,自然就可以直接使用。但是个人感觉不怎么喜欢这种方式,我采用的是第二种,在ant的build.xml文件中装载:
这样就可以在后面使用maven-ant-tasks的task,比如artifact:pom,artifact:dependencies。用于指定maven-ant-tasks-2.0.9.jar的路径,这里就有点麻烦了:maven-ant-tasks-2.0.9.jar这个东西放哪里好呢?直接放到项目中,然后存放到cvs/svn?显然不是一个好办法。考虑到maven本来就是干保存jar这行的,交给maven好了。maven-ant-tasks-2.0.9.jar本来就是一个依赖,可以在http://mvnreposiTory.com/找到:
http://mvnreposiTory.com/artifact/org.apache.maven/maven-ant-tasks
pom内容如下:
org.apache.maven maven-ant-tasks 2.0.9
将这个内容随便找个空项目,加入后update一下dependency,在本地的maven reposiTory中就会有它的jar文件。然后就可以直接使用它。
${M2_REPO},这个是eclipse中通用的指向maven local reposiTory的变量,大家使用maven命令建立eclipse项目时会遇到它。我们在这里可以直接使用这个变量来访问maven local reposiTory。如果没有建立这个变量,请自行建立,上面注释中有详细说明。如果在eclispe之外比如命令行直接运行ant打包,则可以通过设置build.properties文件中的“M2_REPO=G:/soft/maven/localReposiTory”来指定。(这里用到ant的一个特性,属性一旦被赋值就不能修改,因此第一次赋值有效,在eclispe中运行,M2_REPO会使用eclispe中设置的值,如果eclispe没有设置或者命令行直接运行,M2_REPO属性会在build.properties文件装载时设置。)
装载ok后,接着是调用artifact:pom和artifact:dependencies 任务来指定pom.xml文件,再得到dependencies信息,后面的编译打包会使用到。注意useScope=”runtime”,这个是为了最后打包时使用,只复制runtie时需要的jar包。
是用来打印maven相关的一些信息的,比如maven下的几个build目录。artifact:pom任务装载了整个pom,因此在后面可以访问到pom的信息,比如${maven.project.build.sourceDirecTory}是java源代码目录,${maven.project.build.finalName}是最终的名称。
pom的内容可以参考这两个官方资料:
1) maven model
http://maven.apache.org/ref/2.0.9/maven-model/maven.html
2) Introduction to the POM
http://maven.apache.org/guides/introduction/introduction-to-the-pom.html
标准目录布局可以参考这个官方资料:
http://maven.apache.org/guides/introduction/introduction-to-the-standard-direcTory-layout.html
3.2 compile
这里是maven ant task的精髓所在,
结合之前maven初始化时的情况:
可以看到,我们的项目完全遵循maven的标准做法,然后ant通过访问pom来得到相关的路径信息和classpath信息,完美结合。
target copyResource 完成了将resource copy到outputDirecTory的任务,这里的resource都是classpath resource。
注: 这个有个问题,就是我没有找到通过pom得到resouce目录的方法,${maven.project.build.resources 只能得到pom文件中, 对于里面包含的不知道该用什么方式来访问,如默认的:
src/main/resources
我试过用${maven.project.build.resources[0];${maven.project.build.resources(0), ${maven.project.build.resources.0,${maven.project.build.resources.resource
等都无效。找了很久都没有找到资料,只好作罢。直接写死src/main/resources吧。
3.3 jar
和compile类似,标准的ant jar,然后通过访问pom来得到相关的路径信息和打包文件名。注意这里的文件名和路径和maven的做法一致,也就是说和执行maven的compile命令结果是一样的。
3.4 package, zip
package_prepare, copyLib, copyConfig, copyBin 这几个target都简单,体力活而已。zip也是。
4. 总结
上面的内容虽多,但是总结起来就只有两点:
1. maven ant task可以将maven的功能和ant的灵活性统一起来,对于非标准的打包情况非常适用
2. maven ant task的使用并不难,不过需要掌握不少maven的基本知识,比如pom,标准目录布局等。
另外,似乎,ant + Ivy会是更好的选择?
造物之前,必先造人。