Maven Assembly Plugin 插件使用说明

1 Maven Assembly Plugin 地址

https://maven.apache.org/plugins/maven-assembly-plugin/index.html

2 Maven Assembly Plugin 特点

Maven Assembly Plugin使开发人员能够将项目输出合并到单个可分发存档中，该存档还包含依赖项、模块、站点文档和其他文件

• 可以使用预定义的程序集描述符轻松构建分发“程序集”。这些描述符处理许多常见操作，例如将项目与生成的文档一起打包到单个 zip 存档中。
• 或者，您的项目可以提供自己的描述符，并对依赖项、模块、文件集和单个文件在程序集中的打包方式实现更高级别的控制。
• 支持的包格式有
  zip，tar，tar.gz (or tgz)，tar.bz2 (or tbz2)，tar.snappy，tar.xz (or txz)，tar.zst (or tzst)，jar，dir，war，以及 ArchiveManager 已配置的任何其他格式

3 maven-assembly-plugin 的用法

3.1 使用预制描述符 jar-with-dependencies 构建 一个包含所有依赖项的Jar文件

官网链接：https://maven.apache.org/plugins/maven-assembly-plugin/usage.html

• 构建 一个包含所有依赖项可执行的jar包

    <build><plugins><plugin><artifactId>maven-assembly-plugin</artifactId><version>3.7.1</version><configuration><descriptorRefs><descriptorRef>jar-with-dependencies</descriptorRef></descriptorRefs><appendAssemblyId>false</appendAssemblyId><archive><manifest><!-- 指定主类 --><mainClass>com.ccf.Main</mainClass></manifest></archive></configuration><executions><execution><id>make-assembly</id><!-- bind to the packaging phase --><phase>package</phase><goals><goal>single</goal></goals></execution></executions></plugin></plugins></build>

• 如果要 打包成不可执行的jar包，只需 删除 mainClass配置

<archive><manifest><!-- 指定主类 --><mainClass>com.yq.Main</mainClass> </manifest>
</archive>

• 参数说明
  • <appendAssemblyId>false</appendAssemblyId>
    最后打包成的文件名 是否包含 assembly id，预制描述符jar-with-dependencies 对应的 assembly id 就是"jar-with-dependencies"，如果是true(默认），会生成两个文件，一个是不包含依赖的名为 {artifactId}{version}.jar,一个是包括全部依赖的名为{artifactId}{version}-jar-with-dependencies.jar,如果改为false，则只会有一个是包含依赖的名为 {artifactId}{version}.jar

3.2 自定义描述符文件

大数据项目中往往有很多shell脚本、SQL脚本、.properties及.xml配置项等，采用assembly插件可以让输出的结构清晰而标准化。

<build><plugins><plugin><artifactId>maven-assembly-plugin</artifactId><version>3.7.1</version><configuration><!-- 配置描述符文件 --><descriptors><descriptor>src/assembly/assembly.xml</descriptor></descriptors><archive><manifest><mainClass>com.yq.Main</mainClass> <!-- 指定主类 --></manifest></archive></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>