maven-assembly-plugin插件的使用方法

一. Assembly 是什麼意思？

二. maven-assembly-plugin是什麼？

它是maven中針對打包任務而提供的標準插件。

 

三. maven-assembly-plugin插件的做用？

　　摘自官網：http://maven.apache.org/plugins/maven-assembly-plugin/

　　英文原文：The Assembly Plugin for Maven is primarily intended to allow users to aggregate the project output along with its dependencies, 

　　                  modules, site documentation, and other files into a single distributable archive.

　　中文翻譯：Assembly 插件的主要做用是，容許用戶將項目輸出與它的依賴項、模塊、站點文檔、和其餘文件一塊兒組裝成一個可分發的歸檔文件。

　　　　　　　（翻譯不必定準確，以英文爲準）

 

四.maven-assembly-plugin插件在maven項目中如何使用（即便用步驟）？

　　1.  須要指定一個Assembly描述符文件。該文件指定了打包格式，包含的文件/過濾的文件等信息，能夠同時指定多個描述符文件，打包成不一樣的格式。

　　2.  在Maven工程的pom.xml文件裏配置maven-assembly-plugin插件，引入Assembly描述符文件。

 

五. maven項目中Assembly描述符文件詳解

　　示例： 

<?xml version="1.0" encoding="utf-8"?>
<assembly
    xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2 http://maven.apache.org/xsd/assembly-1.1.2.xsd">
    
    <!-- id 標識符，添加到生成文件名稱的後綴符。若是指定 id 的話（這裏指定的是項目的版本），目標文件則是 ${artifactId}-${id}.jar。【如terminal-dispatch-5.0.0.0.jar】 -->
    <id>${project.version}</id>
    
    <!-- 指定打包格式。maven-assembly-plugin插件支持的打包格式有zip、tar、tar.gz (or tgz)、tar.bz2 (or tbz2)、jar、dir、war，能夠同時指定多個打包格式 -->
    <formats>
        <format>jar</format>
    </formats>
    
    <!-- 指定打的包是否包含打包層目錄（好比finalName是terminal-dispatch，當值爲true，全部文件被放在包內的terminal-dispatch目錄下，不然直接放在包的根目錄下）-->
    <includeBaseDirectory>true</includeBaseDirectory>
    
    <!-- 指定將工程依賴的包打到包裏的指定目錄下 -->
    <dependencySets>
        <dependencySet>
            <useProjectArtifact>true</useProjectArtifact> <!-- 指定打包時是否包含工程自身生成的jar包 -->
            <outputDirectory>lib</outputDirectory> <!-- 指定將這些依賴包打到包裏lib目錄下 -->
            <scope>runtime</scope> <!-- 用於管理依賴的部署，runtime表示只在運行時使用 -->
        </dependencySet>
    </dependencySets>
    
    <!-- 指定要包含的文件集，能夠定義多個fileSet -->
    <fileSets>
        <fileSet>
            <directory>src/main/script/linux/bin</directory> <!-- 指定歸檔文件（要打的jar包）要包含的目錄（下的文件及文件夾） -->
            <outputDirectory>bin</outputDirectory> <!-- 指定要將當前目錄（<directory>標籤中的目錄放在歸檔文件（要打的jar包）bin目錄下） -->
            <includes>
                <include>terminal-dispatch</include> <!-- 精確控制要包含的文件，<exclude>用於精確控制要排除的文件  -->
                <include>server</include>
            </includes>
            <fileMode>0755</fileMode> <!-- 設置文件 UNIX 屬性，是一種讀寫權限 -->
        </fileSet>        
        <fileSet>
            <directory>src/main/resources</directory>
            <outputDirectory>conf</outputDirectory>
            <includes>
                <include>config.properties</include>
                <include>logback.xml</include>
            </includes>
            <fileMode>0644</fileMode>
        </fileSet>
        <fileSet>
            <directory>src/main/script/conf</directory>
            <outputDirectory>conf</outputDirectory>
            <includes>
                <include>wrapper.conf</include>
            </includes>
            <fileMode>0644</fileMode>
        </fileSet>
        <fileSet>
            <directory>src/main/script/linux/lib</directory>
            <outputDirectory>lib</outputDirectory>
            <includes>
                <include>libwrapper.so</include>
                <include>wrapper.jar</include>
            </includes>
            <fileMode>0755</fileMode>
        </fileSet>
    </fileSets>
    
</assembly>

 

　　1.  <includeBaseDirectory>true</includeBaseDirectory>標籤做用？

 　　　　指定打的包是否包含打包層目錄，好比finalName是terminal-dispatch，當值爲true，全部文件被放在包內的terminal-dispatch目錄下，不然直接放在包的根目錄下，

　　以下圖所示：

　　2. <fileMode>0755</fileMode>標籤做用？

　　　　設置文件的unix屬性，好像是一種讀寫權限的設定，linux的內容，我沒有深究，不是特別懂，暫時很少說。 

序號	取值	意義
1	compile	缺省值，適用於全部階段，會隨着項目一塊兒發佈
2	provided	相似compile，指望JDK、容器或使用者會提供這個依賴。如servlet.jar
3	runtime	只在運行時使用，如JDBC驅動，適用運行和測試階段
4	test	只在測試時使用，用於編譯和運行測試代碼。不會隨項目發佈
5	system	相似provided，須要顯式提供包含依賴的jar，Maven不會在Repository中查找它

 

六. maven中的pom.xml配置(引入assembly描述符文件)

<build>
    <plugins>
       <plugin>
       　　<groupId>org.apache.maven.plugins</groupId>
　　　　　　<artifactId>maven-assembly-plugin</artifactId>
　　　　　　<version>2.4</version>
　　　　　　　　<executions>
　　　　　　　　　　<execution> <!--執行器 mvn assembly:assembly-->
　　　　　　　　　　　　<id>make-zip</id> <!--名字任意 -->
　　　　　　　　　　　　<phase>package</phase> <!-- 綁定到package生命週期階段上 -->
　　　　　　　　　　　　<goals>
　　　　　　　　　　　　　　<goal>single</goal> <!-- 該打包任務只運行一次 -->
　　　　　　　　　　　　</goals>
　　　　　　　　　　　　<configuration>
　　　　　　　　　　　　　　<descriptors
　　　　　　　　　　　　　　　　<descriptor>src/main/script/assembly.xml</descriptor> 
　　　　　　　　　　　　　　</descriptors>
　　　　　　　　　　</configuration>
　　　　　　　　</execution>
　　　　　　</executions>
　　　　</plugin>
    <plugins>
</build>