Sky's blog

初學(xué)maven(4)-使用maven ant task實(shí)現(xiàn)非標(biāo)準(zhǔn)打包

    maven很強(qiáng)大，但是總有些事情干起來不是得心應(yīng)手，沒有使用ant時(shí)那種想怎么干就怎么干的流暢感。尤其當(dāng)要打包一個(gè)特殊（相對maven的標(biāo)準(zhǔn)架構(gòu)而且）時(shí)，常有不知所措的感覺。當(dāng)然這個(gè)應(yīng)該和自己對maven的了解不夠有關(guān)，畢竟，“初學(xué)maven”嘛。

    但是maven在依賴管理方面實(shí)在是太強(qiáng)大了，太喜歡，退回原來的ant方式完全不可能，我想用過maven的人，一般是不會有回到原來在cvs,subversion中checkin/checkout n個(gè)jar包的時(shí)代，僅此一項(xiàng)理由就足夠繼續(xù)堅(jiān)持使用maven了。

    然而ant的靈活又難于忘懷，尤其是從ant的build.xml一路走來的人，總是回不知不覺間想到ant的美好。魚與熊掌，我都想要。最近想打包一個(gè)java應(yīng)用，很簡單但即不是標(biāo)準(zhǔn)的j2ee appication也不是web application, 用maven完全不知道該怎么打包，package出來的完全不是我想要的，在網(wǎng)上四處google maven資料的時(shí)候，總有用回ant拉倒的沖動(dòng)。

    先交代一下背景吧，我要打包的程序，是這個(gè)樣子：

    demo1
    |____lib
    |_____demo1.jar
    |_____*****.jar
    |_____*****.jar
    |____config
    |_____*****.properties
    |_____*****.xml
    |____log
    |_____*****.log
    |____run.bat
    |____run.sh

    這個(gè)應(yīng)用的打包模式很簡單，一個(gè)bat或者sh腳本用來執(zhí)行，lib目錄下存放所有的jar包，包括自己的源代碼編譯打包的jar和第三方包。config下是配置文件，這些文件需要在安裝時(shí)或者運(yùn)行前修改，比如監(jiān)聽的端口啊，數(shù)據(jù)庫信息之類的。log目錄存放日志文件。最后打包的產(chǎn)物是一個(gè)zip包（或者tar,tar.gz)。

    遇到的問題，就是maven標(biāo)準(zhǔn)的打包方式中根本不考慮類似的情況，什么jar，ear，war完全不適用。而且maven有些理念也詫異，比如maven標(biāo)準(zhǔn)的config目錄是src/main/config，但是這個(gè)目錄里面的配置文件默認(rèn)會打包到j(luò)ar包中，暈，都在jar里面了還讓人怎么改啊？
   
    本著盡量只用maven不用ant的想法，我在maven的資料中看了好久，沒有找到解決的方法。暈，難道大家都只打包標(biāo)準(zhǔn)的ear，jar，war，只有我這樣無聊的人才會有這種打包的需求？

    幾經(jīng)尋覓和探索，最后發(fā)現(xiàn)，maven ant tasks似乎是一個(gè)不錯(cuò)的選擇。帶著mavenanttasks的官方文檔和google上搜到的幾篇文章，開始嘗試，成功實(shí)現(xiàn)功能。現(xiàn)在將過程和方法share給大家。

    首先建立java項(xiàng)目anttaskdemo1，按照maven的推薦，文件結(jié)構(gòu)如下：

    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下放一個(gè)*.properties文件，這個(gè)資源文件是打包到j(luò)ar中，內(nèi)容打包之后不需要改變的。src/main/config下放一個(gè)標(biāo)準(zhǔn)的log4j.xml，這個(gè)是有在安裝運(yùn)行前臨時(shí)修改的需要的。src/main/bin下放置可執(zhí)行文件。

    1. 首先看pom.xml，標(biāo)準(zhǔn)內(nèi)容，很簡單，象征性的加入幾個(gè)依賴
      

    其中commons-codec，log4j是需要打包到lib中的，運(yùn)行時(shí)需要。testng（或者更一般的junit）是用來單元測試的，不需要打包到lib中。請注意它的設(shè)置"<scope>test</scope>"。

    2. 然后看看build.properties文件，這個(gè)內(nèi)容不多：
   
M2_REPO=G:/soft/maven/localRepository

path.package=package
path.target.name=anttaskdemo1
path.package.lib=lib
path.package.log=log
path.package.config=config
path.package.bin=

   
    M2_REPO稍后再詳談，后面的path.package之類的是最終打包時(shí)使用的幾個(gè)目錄名稱，對應(yīng)于最終打包的結(jié)構(gòu)。

    3. build.xml，這個(gè)內(nèi)容比較多。

   

    一步一步來講吧：

    3.1 最重要的一步，init_maven



    在ant中使用maven-ant-tasks，就需要裝載maven-ant-tasks的jar包，方法有兩種，一種是直接將maven-ant-tasks-2.0.9.jar放到ant的lib下，自然就可以直接使用。但是個(gè)人感覺不怎么喜歡這種方式，我采用的是第二種，在ant的build.xml文件中裝載：



    這樣就可以在后面使用maven-ant-tasks的task，比如artifact:pom，artifact:dependencies。<path />用于指定maven-ant-tasks-2.0.9.jar的路徑，這里就有點(diǎn)麻煩了：maven-ant-tasks-2.0.9.jar這個(gè)東西放哪里好呢？直接放到項(xiàng)目中，然后存放到cvs/svn？顯然不是一個(gè)好辦法。考慮到maven本來就是干保存jar這行的，交給maven好了。maven-ant-tasks-2.0.9.jar本來就是一個(gè)依賴，可以在http://mvnrepository.com/找到：
    http://mvnrepository.com/artifact/org.apache.maven/maven-ant-tasks
    pom內(nèi)容如下：

    將這個(gè)內(nèi)容隨便找個(gè)空項(xiàng)目，加入后update一下dependency，在本地的maven repository中就會有它的jar文件。然后就可以直接使用它。
    ${M2_REPO}，這個(gè)是eclipse中通用的指向maven local repository的變量，大家使用maven命令建立eclipse項(xiàng)目時(shí)會遇到它。我們在這里可以直接使用這個(gè)變量來訪問maven local repository。如果沒有建立這個(gè)變量，請自行建立，上面注釋中有詳細(xì)說明。如果在eclispe之外比如命令行直接運(yùn)行ant打包，則可以通過設(shè)置build.properties文件中的“M2_REPO=G:/soft/maven/localRepository”來指定。（這里用到ant的一個(gè)特性，屬性一旦被賦值就不能修改，因此第一次賦值有效，在eclispe中運(yùn)行，M2_REPO會使用eclispe中設(shè)置的值，如果eclispe沒有設(shè)置或者命令行直接運(yùn)行，M2_REPO屬性會在build.properties文件裝載時(shí)設(shè)置。）

    裝載ok后，接著是調(diào)用artifact:pom和artifact:dependencies 任務(wù)來指定pom.xml文件，再得到dependencies信息，后面的編譯打包會使用到。注意useScope="runtime"，這個(gè)是為了最后打包時(shí)使用，只復(fù)制runtie時(shí)需要的jar包。

    <target name="maven_info" />是用來打印maven相關(guān)的一些信息的，比如maven下的幾個(gè)build目錄。artifact:pom任務(wù)裝載了整個(gè)pom，因此在后面可以訪問到pom的信息，比如${maven.project.build.sourceDirectory}是java源代碼目錄，${maven.project.build.finalName}是最終的名稱。

    pom的內(nèi)容可以參考這兩個(gè)官方資料：

    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

    標(biāo)準(zhǔn)目錄布局可以參考這個(gè)官方資料：

        http://maven.apache.org/guides/introduction/introduction-to-the-standard-directory-layout.html

    3.2 compile

        這里是maven ant task的精髓所在，

        結(jié)合之前maven初始化時(shí)的情況：


    可以看到，我們的項(xiàng)目完全遵循maven的標(biāo)準(zhǔn)做法，然后ant通過訪問pom來得到相關(guān)的路徑信息和classpath信息，完美結(jié)合。
    target copyResource 完成了將resource copy到outputDirectory的任務(wù)，這里的resource都是classpath resource。
    注： 這個(gè)有個(gè)問題，就是我沒有找到通過pom得到resouce目錄的方法，${maven.project.build.resources 只能得到pom文件中<resources/>, 對于里面包含的<resource>不知道該用什么方式來訪問，如默認(rèn)的：

    我試過用${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類似，標(biāo)準(zhǔn)的ant jar，然后通過訪問pom來得到相關(guān)的路徑信息和打包文件名。注意這里的文件名和路徑和maven的做法一致，也就是說和執(zhí)行maven的compile命令結(jié)果是一樣的。


    3.4 package， zip
    package_prepare, copyLib, copyConfig, copyBin 這幾個(gè)target都簡單，體力活而已。zip也是。

   
    4. 總結(jié)
   
        上面的內(nèi)容雖多，但是總結(jié)起來就只有兩點(diǎn)：
    1. maven ant task可以將maven的功能和ant的靈活性統(tǒng)一起來，對于非標(biāo)準(zhǔn)的打包情況非常適用
    2. maven ant task的使用并不難，不過需要掌握不少maven的基本知識，比如pom，標(biāo)準(zhǔn)目錄布局等。

        另外，似乎，ant + Ivy會是更好的選擇？

posted on 2008-12-29 16:37 sky ao 閱讀(9077) 評論(1)  編輯  收藏 所屬分類: project building