首页 > 软件编程 > java > Maven Assembly Plugin 插件

Maven Assembly Plugin 插件使用小结

2026-07-16 08:31:34 作者：prcyang

本文主要介绍了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>

到此这篇关于Maven Assembly Plugin 插件使用小结的文章就介绍到这了,更多相关Maven Assembly Plugin 插件内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！