maven-plugin-shade 详解

最新推荐文章于 2025-03-23 06:47:30 发布

六开箱

最新推荐文章于 2025-03-23 06:47:30 发布

阅读量2.8k

点赞数 2

分类专栏： Maven 文章标签： java maven

本文为博主原创文章，未经博主允许不得转载。

本文链接：https://blog.csdn.net/RandomParty/article/details/115112006

版权

maven-plugin-shade 插件能将项目及其依赖打包成 uber-jar，包括重命名依赖包的功能。它默认在 package 阶段运行，通过配置可选择性地包含依赖、重定位 class 文件，甚至生成可执行 jar 包。此外，还能通过自定义 ResourceTransformer 处理资源文件。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

一、介绍 ¹

This plugin provides the capability to package the artifact in an uber-jar, including its dependencies and to shade - i.e. rename - the packages of some of the dependencies.

maven-plugin-shade 插件提供了两个能力：

把整个项目（包含它的依赖）都打包到一个 “uber-jar” 中
shade - 即重命名某些依赖的包

由此引出了两个问题：

什么是 uber-jar ？

uber-jar 也叫做 fat-jar 或者 jar-with-dependencies，意思就是包含依赖的 jar。
什么是 shade ？

shade 意为遮挡，在此处可以理解为对依赖的 jar 包的重定向（主要通过重命名的方式）。

💁‍♂ 下文中可能使用 shade 来代替 maven-plugin-shade。

二、基本使用 ²

maven-plugin-shade 必须和 Maven 构建生命周期中的 package 阶段绑定，也就是说，当执行 mvn package 时会自动触发 shade。

要使用 maven-plugin-shade，只需要在 pom.xml 的 <plugins> 标签下添加它的配置即可，示例如下：

<project>
    ...
    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-shade-plugin</artifactId>
                <version>3.2.4</version>
                <configuration>
                    <!-- 此处按需编写更具体的配置 -->
                </configuration>
                <executions>
                    <execution>
                        <!-- 和 package 阶段绑定 -->
                        <phase>package</phase>
                        <goals>
                            <goal>shade</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
    ...
</project>