當你使用 Maven 對項目打包時，你需要了解以下 3 個打包 plugin，它們分別是
| plugin | function |
|---|---|
| maven-jar-plugin | maven 默認打包插件，用來創建 project jar |
| maven-shade-plugin | 用來打可執行包，executable(fat) jar |
| maven-assembly-plugin | 支持定制化打包方式，例如 apache 項目的打包方式 |
下面我們就簡單介紹一下 maven-assembly-plugin。
使用方法
- 使用 descriptorRefs(官方提供的定制化打包方式)，官方提供的 descriptorRef 有 bin, jar-with-dependencies, src, project。【不建議使用】
<project>
[...]
<build>
[...]
<plugins>
<plugin>
<!-- NOTE: We don't need a groupId specification because the group is
org.apache.maven.plugins ...which is assumed by default.
-->
<artifactId>maven-assembly-plugin</artifactId>
<version>3.0.0</version>
<configuration>
<descriptorRefs>
<descriptorRef>jar-with-dependencies</descriptorRef>
</descriptorRefs>
</configuration>
[...]
</project>
- 使用 descriptors，指定打包文件 src/assembly/src.xml，在該配置文件內指定打包操作。
<project>
[...]
<build>
[...]
<plugins>
<plugin>
<artifactId>maven-assembly-plugin</artifactId>
<version>3.0.0</version>
<configuration>
<descriptors>
<descriptor>src/assembly/src.xml</descriptor>
</descriptors>
</configuration>
[...]
</project>
描述符文件元素
id
<id>release</id>
id 標識符，添加到生成文件名稱的后綴符。如果指定 id 的話，目標文件則是 {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>
樣例
工程目錄結構
scribe-log4j2-test
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>
最終創建生成可執行二進制工程
參考
maven 入門指南
maven 生命周期
Maven 默認插件以及功能
maven 依賴管理
maven-shade-plugin 入門指南
maven-assembly-plugin
