许晓斌_Maven实战（九）---打包的技巧
來源于：http://www.infoq.com/cn/news/2011/06/xxb-maven-9-package
“打包“這個詞聽起來比較土，比較正式的說法應(yīng)該是”構(gòu)建項目軟件包“，具體說就是將項目中的各種文件，比如源代碼、編譯生成的字節(jié)碼、配置文件、文檔，按照規(guī)范的格式生成歸檔，最常見的當(dāng)然就是JAR包和WAR包了，復(fù)雜點的例子是Maven官方下載頁面的分發(fā)包，它有自定義的格式，方便用戶直接解壓后就在命令行使用。作為一款”打包工具“，Maven自然有義務(wù)幫助用戶創(chuàng)建各種各樣的包，規(guī)范的JAR包和WAR包自然不在話下，略微復(fù)雜的自定義打包格式也必須支持，本文就介紹一些常用的打包案例以及相關(guān)的實現(xiàn)方式，除了前面提到的一些包以外，你還能看到如何生成源碼包、Javadoc包、以及從命令行可直接運行的CLI包。
Packaging的含義
任何一個Maven項目都需要定義POM元素packaging（如果不寫則默認(rèn)值為jar）。顧名思義，該元素決定了項目的打包方式。實際的情形中，如果你不聲明該元素，Maven會幫你生成一個JAR包；如果你定義該元素的值為war，那你會得到一個WAR包；如果定義其值為POM（比如是一個父模塊），那什么包都不會生成。除此之外，Maven默認(rèn)還支持一些其他的流行打包格式，例如ejb3和ear。你不需要了解具體的打包細(xì)節(jié)，你所需要做的就是告訴Maven，”我是個什么類型的項目“，這就是約定優(yōu)于配置的力量。
為了更好的理解Maven的默認(rèn)打包方式，我們不妨來看看簡單的聲明背后發(fā)生了什么，對一個jar項目執(zhí)行mvn package操作，會看到如下的輸出：
[INFO] --- maven-jar-plugin:2.3.1:jar (default-jar) @ git-demo --- [INFO] Building jar: /home/juven/git_juven/git-demo/target/git-demo-1.2-SNAPSHOT.jar相比之下，對一個war項目執(zhí)行mvn package操作，輸出是這樣的：
[INFO] --- maven-war-plugin:2.1:war (default-war) @ webapp-demo --- [INFO] Packaging webapp [INFO] Assembling webapp [webapp-demo] in [/home/juven/git_juven/webapp-demo/target/webapp-demo-1.0-SNAPSHOT] [INFO] Processing war project [INFO] Copying webapp resources [/home/juven/git_juven/webapp-demo/src/main/webapp] [INFO] Webapp assembled in [90 msecs] [INFO] Building war: /home/juven/git_juven/webapp-demo/target/webapp-demo-1.0-SNAPSHOT.war對應(yīng)于同樣的package生命周期階段，Maven為jar項目調(diào)用了maven-jar-plugin，為war項目調(diào)用了maven-war-plugin，換言之，packaging直接影響Maven的構(gòu)建生命周期。了解這一點非常重要，特別是當(dāng)你需要自定義打包行為的時候，你就必須知道去配置哪個插件。一個常見的例子就是在打包war項目的時候排除某些web資源文件，這時就應(yīng)該配置maven-war-plugin如下：
<plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-war-plugin</artifactId><version>2.1.1</version><configuration><webResources><resource><directory>src/main/webapp</directory><excludes><exclude>**/*.jpg</exclude></excludes></resource></webResources></configuration></plugin>源碼包和Javadoc包
本專欄的《坐標(biāo)規(guī)劃》一文中曾解釋過，一個Maven項目只生成一個主構(gòu)件，當(dāng)需要生成其他附屬構(gòu)件的時候，就需要用上classifier。源碼包和Javadoc包就是附屬構(gòu)件的極佳例子。它們有著廣泛的用途，尤其是源碼包，當(dāng)你使用一個第三方依賴的時候，有時候會希望在IDE中直接進入該依賴的源碼查看其實現(xiàn)的細(xì)節(jié)，如果該依賴將源碼包發(fā)布到了Maven倉庫，那么像Eclipse就能通過m2eclipse插件解析下載源碼包并關(guān)聯(lián)到你的項目中，十分方便。由于生成源碼包是極其常見的需求，因此Maven官方提供了一個插件來幫助用戶完成這個任務(wù)：
<plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-source-plugin</artifactId><version>2.1.2</version><executions><execution><id>attach-sources</id><phase>verify</phase><goals><goal>jar-no-fork</goal></goals></execution></executions></plugin>類似的，生成Javadoc包只需要配置插件如下：
<plugin> <groupId>org.apache.maven.plugins</groupId><artifactId>maven-javadoc-plugin</artifactId><version>2.7</version><executions><execution><id>attach-javadocs</id><goals><goal>jar</goal></goals></execution></executions></plugin>為了幫助所有Maven用戶更方便的使用Maven中央庫中海量的資源，中央倉庫的維護者強制要求開源項目提交構(gòu)件的時候同時提供源碼包和Javadoc包。這是個很好的實踐，讀者也可以嘗試在自己所處的公司內(nèi)部實行，以促進不同項目之間的交流。
可執(zhí)行CLI包
除了前面提到了常規(guī)JAR包、WAR包，源碼包和Javadoc包，另一種常被用到的包是在命令行可直接運行的CLI（Command Line）包。默認(rèn)Maven生成的JAR包只包含了編譯生成的.class文件和項目資源文件，而要得到一個可以直接在命令行通過java命令運行的JAR文件，還要滿足兩個條件：
- JAR包中的/META-INF/MANIFEST.MF元數(shù)據(jù)文件必須包含Main-Class信息。
- 項目所有的依賴都必須在Classpath中。
Maven有好幾個插件能幫助用戶完成上述任務(wù)，不過用起來最方便的還是maven-shade-plugin，它可以讓用戶配置Main-Class的值，然后在打包的時候?qū)⒅堤钊?META-INF/MANIFEST.MF文件。關(guān)于項目的依賴，它很聰明地將依賴JAR文件全部解壓后，再將得到的.class文件連同當(dāng)前項目的.class文件一起合并到最終的CLI包中，這樣，在執(zhí)行CLI JAR文件的時候，所有需要的類就都在Classpath中了。下面是一個配置樣例：
<plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-shade-plugin</artifactId><version>1.4</version><executions><execution><phase>package</phase><goals><goal>shade</goal></goals><configuration><transformers><transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer"><mainClass>com.juvenxu.mavenbook.HelloWorldCli</mainClass></transformer></transformers></configuration></execution></executions></plugin>上述例子中的，我的Main-Class是com.juvenxu.mavenbook.HelloWorldCli，構(gòu)建完成后，對應(yīng)于一個常規(guī)的hello-world-1.0.jar文件，我還得到了一個hello-world-1.0-cli.jar文件。細(xì)心的讀者可能已經(jīng)注意到了，這里用的是cli這個classifier。最后，我可以通過java -jar hello-world-1.0-cli.jar命令運行程序。
自定義格式包
實際的軟件項目常常會有更復(fù)雜的打包需求，例如我們可能需要為客戶提供一份產(chǎn)品的分發(fā)包，這個包不僅僅包含項目的字節(jié)碼文件，還得包含依賴以及相關(guān)腳本文件以方便客戶解壓后就能運行，此外分發(fā)包還得包含一些必要的文檔。這時項目的源碼目錄結(jié)構(gòu)大致是這樣的：
pom.xml src/main/java/ src/main/resources/ src/test/java/ src/test/resources/ src/main/scripts/ src/main/assembly/ README.txt除了基本的pom.xml和一般Maven目錄之外，這里還有一個src/main/scripts/目錄，該目錄會包含一些腳本文件如run.sh和run.bat，src/main/assembly/會包含一個assembly.xml，這是打包的描述文件，稍后介紹，最后的README.txt是份簡單的文檔。
我們希望最終生成一個zip格式的分發(fā)包，它包含如下的一個結(jié)構(gòu)：
bin/ lib/ README.txt其中bin/目錄包含了可執(zhí)行腳本run.sh和run.bat，lib/目錄包含了項目JAR包和所有依賴JAR，README.txt就是前面提到的文檔。
描述清楚需求后，我們就要搬出Maven最強大的打包插件：maven-assembly-plugin。它支持各種打包文件格式，包括zip、tar.gz、tar.bz2等等，通過一個打包描述文件（該例中是src/main/assembly.xml），它能夠幫助用戶選擇具體打包哪些文件集合、依賴、模塊、和甚至本地倉庫文件，每個項的具體打包路徑用戶也能自由控制。如下就是對應(yīng)上述需求的打包描述文件src/main/assembly.xml：
<assembly><id>bin</id><formats><format>zip</format></formats><dependencySets><dependencySet><useProjectArtifact>true</useProjectArtifact><outputDirectory>lib</outputDirectory></dependencySet></dependencySets><fileSets><fileSet><outputDirectory>/</outputDirectory><includes><include>README.txt</include></includes></fileSet><fileSet><directory>src/main/scripts</directory><outputDirectory>/bin</outputDirectory><includes><include>run.sh</include><include>run.bat</include></includes></fileSet></fileSets> </assembly>- 首先這個assembly.xml文件的id對應(yīng)了其最終生成文件的classifier。
- 其次formats定義打包生成的文件格式，這里是zip。因此結(jié)合id我們會得到一個名為hello-world-1.0-bin.zip的文件。（假設(shè)artifactId為hello-world，version為1.0）
- dependencySets用來定義選擇依賴并定義最終打包到什么目錄，這里我們聲明的一個depenencySet默認(rèn)包含所有所有依賴，而useProjectArtifact表示將項目本身生成的構(gòu)件也包含在內(nèi)，最終打包至輸出包內(nèi)的lib路徑下（由outputDirectory指定）。
- fileSets允許用戶通過文件或目錄的粒度來控制打包。這里的第一個fileSet打包README.txt文件至包的根目錄下，第二個fileSet則將src/main/scripts下的run.sh和run.bat文件打包至輸出包的bin目錄下。
打包描述文件所支持的配置遠(yuǎn)超出本文所能覆蓋的范圍，為了避免讀者被過多細(xì)節(jié)擾亂思維，這里不再展開，讀者若有需要可以去參考這份文檔。
最后，我們需要配置maven-assembly-plugin使用打包描述文件，并綁定生命周期階段使其自動執(zhí)行打包操作：
<plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-assembly-plugin</artifactId><version>2.2.1</version><configuration><descriptors><descriptor>src/main/assembly/assembly.xml</descriptor></descriptors></configuration><executions><execution><id>make-assembly</id><phase>package</phase><goals><goal>single</goal></goals></execution></executions></plugin>運行mvn clean package之后，我們就能在target/目錄下得到名為hello-world-1.0-bin.zip的分發(fā)包了。
小結(jié)
打包是項目構(gòu)建最重要的組成部分之一，本文介紹了主流Maven打包技巧，包括默認(rèn)打包方式的原理、如何制作源碼包和Javadoc包、如何制作命令行可運行的CLI包、以及進一步的，如何基于個性化需求自定義打包格式。這其中涉及了很多的Maven插件，當(dāng)然最重要，也是最為復(fù)雜和強大的打包插件就是maven-assembly-plugin。事實上Maven本身的分發(fā)包就是通過maven-assembly-plugin制作的，感興趣的讀者可以直接查看源碼一窺究竟。
總結(jié)
以上是生活随笔為你收集整理的许晓斌_Maven实战（九）---打包的技巧的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。
