Maven Assembly外掛介紹

YatHo發表於2017-09-27


轉自:http://blueram.iteye.com/blog/1684070

已經寫得挺好的,就不用重寫了。

你是否想要建立一個包含指令碼、配置檔案以及所有執行時所依賴的元素(jar)Assembly外掛能幫你構建一個完整的釋出包。

Assembly外掛會生成 “assemblies”, 此特性等同於的Maven 1 distribution plug-in.。該外掛不僅支援建立二進位制歸檔檔案,也支援建立原始碼歸檔檔案。這些assemblies定義在一個assembly描述符檔案裡。你可以選擇自定義assembly描述符或者直接使用外掛自帶的三個預定義描述符中的任何一個.

目前Assembly外掛支援如下格式的歸檔檔案:

  • zip
  • tar.gz
  • tar.bz2
  • jar
  • dir
  • war
  • and any other format that the ArchiveManager has been configured for

Maven 2上使用assembly的簡單步驟:

  • 從預定義描述符裡選擇一個或者自己編寫一個assembly描述符號。
  • 工程的pom.xml裡配置Assembly外掛。
  • 在工程根目錄下執行”mvn assembly:assembly”命令 。

如何自定義assembly描述符,詳見Assembly Descriptor Format.

什麼是Assembly?

“assembly”是把一組檔案、目錄、依賴元素組裝成一個歸檔檔案. 比如, 假設一個 Maven project定義了一個JAR artifact,它包含控制檯應用程式和Swing應用程式 。這樣一個工程可以定義兩套包含描述符,一套給給控制檯應用,另一套給Swing應用程式,它們包含各自的指令碼、目錄和依賴。

Assembly Plugin的描述符可以定義任何一個檔案或者目錄歸檔方式。舉個例子,如果的你的Maven 2工程包含”src/main/bin”這個目錄,你可以指示Assembly外掛複製“src/main/bin”目錄下所有的檔案到bin目錄裡(歸檔檔案裡的目錄),並且可以修改它們的許可權屬性(UNIX mode)。見 assembly descriptor.

The Maven Assembly Plugin

Maven 2.0的Assembly外掛目的是提供一個把工程依賴元素、模組、網站文件等其他檔案存放到單個歸檔檔案裡。

使用任何一個預定義的描述符你可以輕鬆的構建一個釋出包。這些描述符能處理一些常用的操作,如:把依賴的元素的歸檔到一個jar檔案. 當然, 你可以自定義描述符來更靈活的控制依賴,模組,檔案的歸檔方式。

 

 

maven-assembly-plugin : 是maven中針對打包任務而提供的標準外掛

(1)、在pom.xml 檔案裡面的配置說明

 

Java程式碼  
  1. <plugin>  
  2.     <artifactId>maven-assembly-plugin</artifactId>  
  3.     <executions>  <!--執行器 mvn assembly:assembly-->  
  4.         <execution>  
  5.             <id>make-zip</id><!--名字任意 -->    
  6.         <phase>package</phase><!-- 繫結到package生命週期階段上 -->    
  7.         <goals>    
  8.            <goal>single</goal><!-- 只執行一次 -->    
  9.         </goals>    
  10.             <configuration>  
  11.                      <descriptors> <!--描述檔案路徑-->  
  12.                           <descriptor>src/main/resources/zip.xml</descriptor>  
  13.                     </descriptors>  
  14.             </configuration>  
  15.         </execution>  
  16.     </executions>  
  17.  </plugin>  

 

(2)、zip.xml 檔案配置如下

 

Xml程式碼  
  1. <assembly  
  2.     xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"  
  3.     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
  4.     xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0 http://maven.apache.org/xsd/assembly-1.1.0.xsd">  
  5.     <id>release</id>  
  6.     <formats>  
  7.         <format>zip</format>  
  8.     </formats>  
  9.     <fileSets>  
  10.         <fileSet>  
  11.             <directory>${project.basedir}\src\main\config</directory>  
  12.             <!-- 過濾 -->  
  13.             <excludes>  
  14.                 <exclude>*.xml</exclude>  
  15.             </excludes>  
  16.             <outputDirectory>\</outputDirectory>  
  17.         </fileSet>  
  18.     </fileSets>  
  19.       
  20.     <dependencySets>  
  21.         <dependencySet>  
  22.             <useProjectArtifact>true</useProjectArtifact>  
  23.             <outputDirectory>lib</outputDirectory><!-- 將scope為runtime的依賴包打包到lib目錄下。 -->  
  24.             <scope>runtime</scope>  
  25.         </dependencySet>  
  26.     </dependencySets>  
  27. </assembly>  

 (3)、zip.xml 格式屬性說明

 

打包的檔案格式
可以有:tar.zip war zip
<formats>
 <format>zip</format>
</formats>

 

需要打包的路徑
<directory>${project.basedir}</directory>

 

打包後輸出的路徑
<outputDirectory>/</outputDirectory>

 

打包需要包含的檔案

 <excludes>
        <exclude>junit:junit</exclude>
        <exclude>commons-lang:commons-lang</exclude>
        <exclude>commons-logging:commons-logging</exclude>
</excludes>

 

當前專案構件是否包含在這個依賴集合裡。

<useProjectArtifact>true</useProjectArtifact>

 

依賴包打包到目錄下
<dependencySets>
  <dependencySet>
   <outputDirectory>lib</outputDirectory><!-- 將scope為runtime的依賴包打包到lib目錄下。 -->
   <useProjectArtifact>true</useProjectArtifact>
   <scope>runtime</scope>
  </dependencySet>
</dependencySets>

 

相關文章