maven-shade-plugin 的用途是什么，为什么要重新定位 Java 包？

简而言之，Uber JAR 是一个包含所有内容的 JAR。

通常在 Maven 中，我们依赖于依赖管理。工件仅包含其自身的类/资源。 Maven 将负责根据项目的构建时间找出项目的所有工件（JAR 等）。

uber-jar 是一种获取所有依赖项的东西，并提取依赖项的内容并将它们与项目本身的类/资源一起放在一个大 JAR 中。通过拥有这样一个 uber-jar，执行起来很容易，因为您只需要一个大 JAR 而不是大量的小 JAR 来运行您的应用程序。在某些情况下，它还简化了分发。

附带说明：避免使用 uber-jar 作为 Maven 依赖项，因为它会破坏 Maven 的依赖项解析功能。通常我们只为实际部署或手动分发的最终工件创建一个 uber-jar，而不是用于放入 Maven 存储库。

更新：我刚刚发现我还没有回答问题的一部分：“重命名依赖项的包有什么意义？”。以下是一些简短的更新，希望能帮助有类似问题的人。

创建一个易于部署的 uber-jar 是 shade 插件的一个用例。还有其他涉及包重命名的常见用例。

例如，我正在开发 Foo 库，它依赖于 Bar 库的特定版本（例如 1.0）。假设我无法使用 Bar lib 的其他版本（因为 API 更改或其他技术问题等）。如果我在 Maven 中简单地将 Bar:1.0 声明为 Foo 的依赖项，则可能会遇到问题：Qux 项目依赖于 Foo，并且还依赖于 Bar:2.0（它不能使用 {4 } 因为 Qux 需要使用 Bar:2.0 中的新功能）。这是一个难题：Qux 应该使用 Bar:1.0（哪个 Qux 的代码不起作用）还是 Bar:2.0（哪个 Foo 的代码不起作用）？

为了解决这个问题，Foo的开发者可以选择使用shade插件重命名Bar的用法，使Bar:1.0jar中的所有类都嵌入到Foojar中，嵌入的包Bar 类从 com.bar 更改为 com.foo.bar。通过这样做，Qux 可以安全地依赖于 Bar:2.0，因为现在 Foo 不再依赖于 Bar，并且它正在使用位于另一个包中的“已更改”Bar 的自己的副本。

https://i.stack.imgur.com/BVX9w.png

---

我最近想知道为什么 elasticsearch 会隐藏并重新定位它的一些（但不是全部）依赖项。以下是项目维护者 @kimchy 的解释：

阴影部分是有意的，我们在 elasticsearch 中使用的阴影库是 elasticsearch 的所有意图和目的部分，使用的版本与 elasticsearch 公开的内容以及它如何基于库的内部工作原理（以及版本之间的变化），netty 和 guava 就是很好的例子。顺便说一句，我实际上提供了几个弹性搜索罐没有问题，一个带有 lucene 没有阴影，一个带有 Lucene 阴影。不知道如何用 maven 来做。例如，我不想提供一个不遮蔽 netty/jackson 的版本，因为 elasticsearch 对它们的使用很深（例如，将即将到来的缓冲改进与除当前版本之外的任何先前版本的 netty 一起使用将与使用更少的内存相比，实际上使用更多的内存）。

-- https://github.com/elasticsearch/elasticsearch/issues/2091#issuecomment-7156766

还有来自drawr的另一个：

阴影对于保持我们的依赖项（尤其是 netty、lucene、guava）接近我们的代码很重要，这样即使上游提供者落后，我们也可以解决问题。我们可能会分发代码的模块化版本，这将有助于解决您的特定问题（例如#2091），但此时我们不能简单地删除阴影依赖项。您可以为您的目的构建一个本地版本的 ES，直到有更好的解决方案。

-- https://github.com/elasticsearch/elasticsearch/pull/3244#issuecomment-20125452

所以，这是一个用例。作为一个说明性示例，下面是 maven-shade-plugin 在 elasticsearch 的 pom.xml (v0.90.5) 中的使用方式。 artifactSet::include 行指示将哪些依赖项拉入 uber JAR（基本上，在生成目标 elasticsearch jar 时，它们会与 elasticsearch 自己的类一起解压缩并重新打包。（如果您还不知道这一点，请JAR 文件只是一个 ZIP 文件，其中包含程序的类、资源等，以及一些元数据。您可以提取一个来看看它是如何组合在一起的。）

relocations::relocation 行类似，只是在每种情况下它们还将指定的替换应用到依赖项的类 - 在本例中，将它们置于 org.elasticsearch.common 之下。

最后，filters 部分从目标 JAR 中排除了一些不应该在其中的东西 - 例如 JAR 元数据、ant 构建文件、文本文件等，它们与一些依赖项打包在一起，但不属于超级罐子。

<plugins>
    <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-shade-plugin</artifactId>
        <version>2.1</version>
        <executions>
            <execution>
                <phase>package</phase>
                <goals>
                    <goal>shade</goal>
                </goals>
            </execution>
        </executions>
        <configuration>
            <minimizeJar>true</minimizeJar>
            <artifactSet>
                <includes>
                    <include>com.google.guava:guava</include>
                    <include>net.sf.trove4j:trove4j</include>
                    <include>org.mvel:mvel2</include>
                    <include>com.fasterxml.jackson.core:jackson-core</include>
                    <include>com.fasterxml.jackson.dataformat:jackson-dataformat-smile</include>
                    <include>com.fasterxml.jackson.dataformat:jackson-dataformat-yaml</include>
                    <include>joda-time:joda-time</include>
                    <include>io.netty:netty</include>
                    <include>com.ning:compress-lzf</include>
                </includes>
            </artifactSet>
            <relocations>
                <relocation>
                    <pattern>com.google.common</pattern>
                    <shadedPattern>org.elasticsearch.common</shadedPattern>
                </relocation>
                <relocation>
                    <pattern>gnu.trove</pattern>
                    <shadedPattern>org.elasticsearch.common.trove</shadedPattern>
                </relocation>
                <relocation>
                    <pattern>jsr166y</pattern>
                    <shadedPattern>org.elasticsearch.common.util.concurrent.jsr166y</shadedPattern>
                </relocation>
                <relocation>
                    <pattern>jsr166e</pattern>
                    <shadedPattern>org.elasticsearch.common.util.concurrent.jsr166e</shadedPattern>
                </relocation>
                <relocation>
                    <pattern>org.mvel2</pattern>
                    <shadedPattern>org.elasticsearch.common.mvel2</shadedPattern>
                </relocation>
                <relocation>
                    <pattern>com.fasterxml.jackson</pattern>
                    <shadedPattern>org.elasticsearch.common.jackson</shadedPattern>
                </relocation>
                <relocation>
                    <pattern>org.joda</pattern>
                    <shadedPattern>org.elasticsearch.common.joda</shadedPattern>
                </relocation>
                <relocation>
                    <pattern>org.jboss.netty</pattern>
                    <shadedPattern>org.elasticsearch.common.netty</shadedPattern>
                </relocation>
                <relocation>
                    <pattern>com.ning.compress</pattern>
                    <shadedPattern>org.elasticsearch.common.compress</shadedPattern>
                </relocation>
            </relocations>
            <filters>
                <filter>
                    <artifact>*:*</artifact>
                    <excludes>
                        <exclude>META-INF/license/**</exclude>
                        <exclude>META-INF/*</exclude>
                        <exclude>META-INF/maven/**</exclude>
                        <exclude>LICENSE</exclude>
                        <exclude>NOTICE</exclude>
                        <exclude>/*.txt</exclude>
                        <exclude>build.properties</exclude>
                    </excludes>
                </filter>
            </filters>
        </configuration>
    </plugin>
</plugins>

---

我认为需要“阴影”jar 的一个例子是 AWS Lambda 函数。它们似乎只允许您上传 1 个 jar，而不是像您在典型的 .war 文件中找到的整个 .jar 集合。因此，创建一个包含项目所有依赖项的单个 .jar 可以让您执行此操作。

---

小警告

虽然这没有描述为什么要使用 maven-shade-plugin（因为所选答案描述得很好），但我想指出我遇到了问题。它改变了 JAR（因为它正在做的事情）并导致我的软件回归。

因此，我没有使用这个（或 maven-jarjar-plugin），而是使用了 JarJar 的二进制文件，它似乎可以正常工作。

我在这里发布我的解决方案，因为我花了一些时间才找到一个体面的解决方案。

下载 JarJar 的 JAR 文件

您可以从此处下载 jar：https://code.google.com/p/jarjar/ 在左侧菜单中，您有一个下载链接。

如何使用 JarJar 将 JAR 的类从一个包重新定位到另一个包

在本例中，我们将把包从“com.fasterxml.jackson”更改为“io.kuku.dependencies.com.fasterxml.jackson”。 - 源 JAR 称为“jackson-databind-2.6.4.jar”，新修改的（目标）JAR 称为“kuku-jackson-databind-2.6.4.jar”。 - “jarjar” JAR 文件的版本为 1.4

创建一个“rules.txt”文件。该文件的内容应该是（注意'@'字符之前的句点）： rule com.fasterxml.jackson.** io.kuku.dependencies.com.fasterxml.jackson.@1 运行以下命令：java -jar jarjar-1.4.jar 进程 rules.txt jackson-databind-2.6.4.jar kuku-jackson-databind-2.6.4.jar

将修改后的 JAR 安装到本地存储库

在这种情况下，我正在安装位于“c:\my-jars\”文件夹中的 3 个文件。

mvn install:install-file -Dfile=C:\my-jars\kuku-jackson-annotations-2.6.4.jar -DgroupId=io.kuku.dependencies -DartifactId=kuku-jackson-annotations -Dversion=2.6.4 - dpackaging=jar

mvn install:install-file -Dfile=C:\my-jars\kuku-jackson-core-2.6.4.jar -DgroupId=io.kuku.dependencies -DartifactId=kuku-jackson-core -Dversion=2.6.4 - dpackaging=jar

mvn install:install-file -Dfile=C:\my-jars\kuku-jackson-databind-2.6.4.jar -DgroupId=io.kuku.dependencies -DartifactId=kuku-jackson-annotations -Dversion=2.6.4 - dpackaging=jar

在项目的 pom 中使用修改后的 JAR

在此示例中，这是项目 pom 中的“依赖项”元素：

<dependencies>
    <!-- ================================================== -->
    <!-- kuku JARs -->
    <!-- ================================================== -->
    <dependency>
        <groupId>io.kuku.dependencies</groupId>
        <artifactId>kuku-jackson-annotations</artifactId>
        <version>2.6.4</version>
    </dependency>
    <dependency>
        <groupId>io.kuku.dependencies</groupId>
        <artifactId>kuku-jackson-core</artifactId>
        <version>2.6.4</version>
    </dependency>
    <dependency>
        <groupId>io.kuku.dependencies</groupId>
        <artifactId>kuku-jackson-databind</artifactId>
        <version>2.6.4</version>
    </dependency>
</dependencies>

---