如何创建“超级 JAR”？使用 Maven Shade Plugin 轻松搞定

2024-03-16 18:38:51

创建“超级 JAR”：使用 Maven Shade Plugin

对于一个经验丰富的开发者来说，高效可靠地管理 Java 依赖项至关重要。“超级 JAR” 技术是简化部署、解决依赖冲突和优化性能的强大解决方案。借助 Maven Shade Plugin ，创建“超级 JAR”变得轻而易举。

“超级 JAR”的概念

“超级 JAR”包含项目及其所有依赖项，无需外部依赖即可运行。这使得部署和维护更加便捷，避免了依赖性冲突的困扰，并提高了应用程序的加载速度。

重命名依赖项包的重要性

Maven Shade Plugin 还允许您重命名依赖项包。这对于以下情况非常有用：

避免冲突： 解决不同依赖项使用相同包名称而导致的冲突。
定制化： 将依赖项包名称与您的项目约定或编码风格相匹配。
隐藏依赖： 保护第三方依赖项的实现细节，防止知识产权泄露。

Maven Shade Plugin 的应用场景

在以下场景下使用 Maven Shade Plugin 非常有效：

发布可执行 JAR： 创建可以独立运行的“超级 JAR”。
创建库 JAR： 生成一个可以轻松添加到其他项目的“超级 JAR”。
解决依赖冲突： 消除多个依赖项使用相同包名称的冲突。
定制化依赖项包： 根据项目的具体需求重命名依赖项包。
隐藏第三方实现： 保护知识产权并防止第三方代码的泄露。

实际操作示例

使用 Maven Shade Plugin 创建“超级 JAR”非常简单。只需在您的 Maven pom.xml 文件中添加以下配置：

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-shade-plugin</artifactId>
  <version>3.3.0</version>
  <executions>
    <execution>
      <phase>package</phase>
      <goals>
        <goal>shade</goal>
      </goals>
    </execution>
  </executions>
</plugin>

这将创建一个名为 my-project-shaded.jar 的“超级 JAR”，其中包含您的项目及其所有依赖项。

要重命名依赖项包，可以使用 shadePluginConfiguration 配置：

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-shade-plugin</artifactId>
  <version>3.3.0</version>
  <executions>
    <execution>
      <phase>package</phase>
      <goals>
        <goal>shade</goal>
      </goals>
    </execution>
  </executions>
  <configuration>
    <transformers>
      <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
        <manifestEntries>
          <Main-Class>com.example.Main</Main-Class>
        </manifestEntries>
      </transformer>
      <transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
        <resource>META-INF/services/com.example.Service</resource>
      </transformer>
    </transformers>
  </configuration>
</plugin>