maven-assembly-plugin 入门指南

我不是女神ヾ 2022-06-13 20:42 202阅读 0赞

当你使用 Maven 对项目打包时，你需要了解以下 3 个打包 plugin，它们分别是

下面我们就简单介绍一下 maven-assembly-plugin。

## 使用方法 ##

*  使用 descriptorRefs(官方提供的定制化打包方式)，官方提供的 descriptorRef 有 bin, jar-with-dependencies, src, project。【不建议使用】

<project>
      [...]
      <build>
        [...]
        <plugins>
          <plugin>
            
            <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 的话，目标文件则是 $\{artifactId\}-$\{id\}.tar.gz

### formats ###

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

### dependencySets ###

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

<table style="border-collapse:collapse; border-spacing:0px; width:620px; margin-bottom:20px; border-top:1px solid rgb(221,221,221); border-right:1px solid rgb(221,221,221); border-bottom:1px solid rgb(221,221,221); border-left:none; word-break:normal; color:rgb(47,47,47); font-size:16px"> 
 <thead style=""> 
  <tr style=""> 
   <th style="padding:8px; border:1px solid rgb(221,221,221); line-height:20px; vertical-align:middle"> 元素</th> 
   <th style="padding:8px; border:1px solid rgb(221,221,221); line-height:20px; vertical-align:middle"> 类型</th> 
   <th style="padding:8px; border:1px solid rgb(221,221,221); line-height:20px; vertical-align:middle"> 作用</th> 
  </tr> 
 </thead> 
 <tbody style=""> 
  <tr style=""> 
   <td style="padding:8px; border:1px solid rgb(221,221,221); line-height:20px; vertical-align:middle"> outputDirectory</td> 
   <td style="padding:8px; border:1px solid rgb(221,221,221); line-height:20px; vertical-align:middle"> String</td> 
   <td style="padding:8px; border:1px solid rgb(221,221,221); line-height:20px; vertical-align:middle"> 指定包依赖目录，该目录是相对于根目录</td> 
  </tr> 
  <tr style=""> 
   <td style="padding:8px; border:1px solid rgb(221,221,221); line-height:20px; vertical-align:middle"> includes/include*</td> 
   <td style="padding:8px; border:1px solid rgb(221,221,221); line-height:20px; vertical-align:middle"> List&lt;String&gt;</td> 
   <td style="padding:8px; border:1px solid rgb(221,221,221); line-height:20px; vertical-align:middle"> 包含依赖</td> 
  </tr> 
  <tr style=""> 
   <td style="padding:8px; border:1px solid rgb(221,221,221); line-height:20px; vertical-align:middle"> excludes/exclude*</td> 
   <td style="padding:8px; border:1px solid rgb(221,221,221); line-height:20px; vertical-align:middle"> List&lt;String&gt;</td> 
   <td style="padding:8px; border:1px solid rgb(221,221,221); line-height:20px; vertical-align:middle"> 排除依赖</td> 
  </tr> 
 </tbody> 
</table>

### fileSets ###

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

<table style="border-collapse:collapse; border-spacing:0px; width:620px; margin-bottom:20px; border-top:1px solid rgb(221,221,221); border-right:1px solid rgb(221,221,221); border-bottom:1px solid rgb(221,221,221); border-left:none; word-break:normal; color:rgb(47,47,47); font-size:16px"> 
 <thead style=""> 
  <tr style=""> 
   <th style="padding:8px; border:1px solid rgb(221,221,221); line-height:20px; vertical-align:middle"> 元素</th> 
   <th style="padding:8px; border:1px solid rgb(221,221,221); line-height:20px; vertical-align:middle"> 类型</th> 
   <th style="padding:8px; border:1px solid rgb(221,221,221); line-height:20px; vertical-align:middle"> 作用</th> 
  </tr> 
 </thead> 
 <tbody style=""> 
  <tr style=""> 
   <td style="padding:8px; border:1px solid rgb(221,221,221); line-height:20px; vertical-align:middle"> outputDirectory</td> 
   <td style="padding:8px; border:1px solid rgb(221,221,221); line-height:20px; vertical-align:middle"> String</td> 
   <td style="padding:8px; border:1px solid rgb(221,221,221); line-height:20px; vertical-align:middle"> 指定文件集合的输出目录，该目录是相对于根目录</td> 
  </tr> 
  <tr style=""> 
   <td style="padding:8px; border:1px solid rgb(221,221,221); line-height:20px; vertical-align:middle"> includes/include*</td> 
   <td style="padding:8px; border:1px solid rgb(221,221,221); line-height:20px; vertical-align:middle"> List&lt;String&gt;</td> 
   <td style="padding:8px; border:1px solid rgb(221,221,221); line-height:20px; vertical-align:middle"> 包含文件</td> 
  </tr> 
  <tr style=""> 
   <td style="padding:8px; border:1px solid rgb(221,221,221); line-height:20px; vertical-align:middle"> excludes/exclude*</td> 
   <td style="padding:8px; border:1px solid rgb(221,221,221); line-height:20px; vertical-align:middle"> List&lt;String&gt;</td> 
   <td style="padding:8px; border:1px solid rgb(221,221,221); line-height:20px; vertical-align:middle"> 排除文件</td> 
  </tr> 
  <tr style=""> 
   <td style="padding:8px; border:1px solid rgb(221,221,221); line-height:20px; vertical-align:middle"> fileMode</td> 
   <td style="padding:8px; border:1px solid rgb(221,221,221); line-height:20px; vertical-align:middle"> String</td> 
   <td style="padding:8px; border:1px solid rgb(221,221,221); line-height:20px; vertical-align:middle"> 指定文件属性，使用八进制表达，分别为(User)(Group)(Other)所属属性，默认为 0644</td> 
  </tr> 
 </tbody> 
</table>

### files ###

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

<table style="border-collapse:collapse; border-spacing:0px; width:620px; margin-bottom:20px; border-top:1px solid rgb(221,221,221); border-right:1px solid rgb(221,221,221); border-bottom:1px solid rgb(221,221,221); border-left:none; word-break:normal; color:rgb(47,47,47); font-size:16px"> 
 <thead style=""> 
  <tr style=""> 
   <th style="padding:8px; border:1px solid rgb(221,221,221); line-height:20px; vertical-align:middle"> 元素</th> 
   <th style="padding:8px; border:1px solid rgb(221,221,221); line-height:20px; vertical-align:middle"> 类型</th> 
   <th style="padding:8px; border:1px solid rgb(221,221,221); line-height:20px; vertical-align:middle"> 作用</th> 
  </tr> 
 </thead> 
 <tbody style=""> 
  <tr style=""> 
   <td style="padding:8px; border:1px solid rgb(221,221,221); line-height:20px; vertical-align:middle"> source</td> 
   <td style="padding:8px; border:1px solid rgb(221,221,221); line-height:20px; vertical-align:middle"> String</td> 
   <td style="padding:8px; border:1px solid rgb(221,221,221); line-height:20px; vertical-align:middle"> 源文件，相对路径或绝对路径</td> 
  </tr> 
  <tr style=""> 
   <td style="padding:8px; border:1px solid rgb(221,221,221); line-height:20px; vertical-align:middle"> outputDirectory</td> 
   <td style="padding:8px; border:1px solid rgb(221,221,221); line-height:20px; vertical-align:middle"> String</td> 
   <td style="padding:8px; border:1px solid rgb(221,221,221); line-height:20px; vertical-align:middle"> 输出目录</td> 
  </tr> 
  <tr style=""> 
   <td style="padding:8px; border:1px solid rgb(221,221,221); line-height:20px; vertical-align:middle"> destName</td> 
   <td style="padding:8px; border:1px solid rgb(221,221,221); line-height:20px; vertical-align:middle"> String</td> 
   <td style="padding:8px; border:1px solid rgb(221,221,221); line-height:20px; vertical-align:middle"> 目标文件名</td> 
  </tr> 
  <tr style=""> 
   <td style="padding:8px; border:1px solid rgb(221,221,221); line-height:20px; vertical-align:middle"> fileMode</td> 
   <td style="padding:8px; border:1px solid rgb(221,221,221); line-height:20px; vertical-align:middle"> String</td> 
   <td style="padding:8px; border:1px solid rgb(221,221,221); line-height:20px; vertical-align:middle"> 设置文件 UNIX 属性</td> 
  </tr> 
 </tbody> 
</table>

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

## 样例 ##

工程目录结构

![1240][]

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> 
              <phase>package</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 1]  
[Maven 默认插件以及功能][Maven]  
[maven 依赖管理][maven 2]  
[maven-shade-plugin 入门指南][maven-shade-plugin]  
[maven-assembly-plugin][]

[1240]: /images/20220614/70b6c43e9e584ba6b48bbc6b6ccd070f.png
[maven]: http://www.jianshu.com/p/b4ef9978d85d
[maven 1]: http://www.jianshu.com/p/fd43b3d0fdb0
[Maven]: http://www.jianshu.com/p/977b71e2837e
[maven 2]: http://www.jianshu.com/p/f6ca45865025
[maven-shade-plugin]: http://www.jianshu.com/p/7a0e20b30401
[maven-assembly-plugin]: http://maven.apache.org/plugins/maven-assembly-plugin/index.html