maven插件maven-assembly-plugin

maven-assembly-plugin自定義打包方式

大數據項目中往往有很多shell腳本、SQL腳本、.properties及.xml配置項等，采用assembly插件可以讓輸出的結構清晰而標准化。
要使用該插件，就在項目pom文件中加入以下內容

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-assembly-plugin</artifactId>
                <version>${maven-assembly-plugin.version}<version>
                <executions>
                    <execution>
                        <id>make-assembly</id>
                        <!-- 綁定到package生命周期 -->
                        <phase>package</phase>
                        <goals>
                            <!-- 只運行一次 -->
                            <goal>single</goal>
                        </goals>
                    </execution>
                </executions>
                <configuration>
                    <!-- 配置描述符文件 -->
                    <descriptor>src/main/assembly/assembly.xml</descriptor>
                    <!-- 也可以使用Maven預配置的描述符
                    <descriptorRefs>
                        <descriptorRef>jar-with-dependencies</descriptorRef>
                    </descriptorRefs> -->
                </configuration>
            </plugin>
        </plugins>
    </build>

描述符文件元素

id

<id>release</id>

id 標識符，添加到生成文件名稱的后綴符。如果指定 id 的話，目標文件則是 ${artifactId}-${id}.tar.gz

formats

maven-assembly-plugin 支持的打包格式有zip、tar、tar.gz (or tgz)、tar.bz2 (or tbz2)、jar、dir、war，可以同時指定多個打包格式

<formats>
    <format>tar.gz</format>
    <format>dir</format>
  </formats>

dependencySets

用來定制工程依賴 jar 包的打包方式，核心元素如下表所示。

元素	類型	作用
outputDirectory	String	指定包依賴目錄，該目錄是相對於根目錄
includes/include*	List<String>	包含依賴
excludes/exclude*	List<String>	排除依賴

<dependencySets>
    <dependencySet>
      <outputDirectory>/lib</outputDirectory>
    </dependencySet>
  </dependencySets>

fileSets

管理一組文件的存放位置，核心元素如下表所示。

元素	類型	作用
outputDirectory	String	指定文件集合的輸出目錄，該目錄是相對於根目錄
includes/include*	List<String>	包含文件
excludes/exclude*	List<String>	排除文件
fileMode	String	指定文件屬性，使用八進制表達，分別為(User)(Group)(Other)所屬屬性，默認為 0644

<fileSets>
    <fileSet>
      <includes>
        <include>bin/**</include>
      </includes>
      <fileMode>0755</fileMode>
    </fileSet>

    <fileSet>
      <includes>
        <include>/conf/**</include>
        <include>logs</include>
      </includes>
    </fileSet>

  </fileSets>

files

可以指定目的文件名到指定目錄，其他和 fileSets 相同，核心元素如下表所示。

元素	類型	作用
source	String	源文件，相對路徑或絕對路徑
outputDirectory	String	輸出目錄
destName	String	目標文件名
fileMode	String	設置文件 UNIX 屬性

<files>
    <file>
      <source>README.txt</source>
      <outputDirectory>/</outputDirectory>
    </file>
  </files>

 

 

pom.xml

<build>
  <finalName>scribe-log4j2-test</finalName>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-compiler-plugin</artifactId>
    </plugin>

    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-assembly-plugin</artifactId>
      <configuration>
        <descriptors>
          <descriptor>src/main/assembly/release.xml</descriptor>
        </descriptors>
      </configuration>

      <executions>
        <execution>
          <id>make-assembly</id> <!-- this is used for inheritance merges -->
          <phase>package</phase> <!-- bind to the packaging phase -->
          <goals>
            <goal>single</goal>
          </goals>
        </execution>
      </executions>
    </plugin>
  </plugins>
</build>

release.xml

<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.3"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.3 http://maven.apache.org/xsd/assembly-1.1.3.xsd">

  <formats>
    <format>tar.gz</format>
    <format>dir</format>
  </formats>

  <dependencySets>
    <dependencySet>
      <outputDirectory>/lib</outputDirectory>
    </dependencySet>
  </dependencySets>

  <fileSets>
    <fileSet>
      <includes>
        <include>bin/**</include>
      </includes>
      <fileMode>0755</fileMode>
    </fileSet>

    <fileSet>
      <includes>
        <include>/conf/**</include>
        <include>logs</include>
      </includes>
    </fileSet>

  </fileSets>

  <files>
    <file>
      <source>README.txt</source>
      <outputDirectory>/</outputDirectory>
    </file>
  </files>

</assembly>

最終創建生成可執行二進制工程

一個完整的使用assembly的項目：https://gitee.com/wangbin2188/data-migration/tree/develop