返回

版本不兼容的 Jar 包？无需担心！重命名和重新打包以解决冲突！

闲谈

Jar 包冲突的常见场景

在构建 Java 项目时，Jar 包依赖是必不可少的。但当引入的 Jar 包版本不兼容时，就会引发恼人的冲突。例如：

  • 不同版本的第三方库： 两个或多个 Jar 包可能包含同名的类，但不同版本。这会导致类加载器无法确定使用哪个版本，从而引发错误。
  • 不同的打包方式： 某些 Jar 包可能使用不同的打包方式，例如 OSGi 规范或 Spring Boot 规范。这些差异也会导致冲突。

Maven-shade-plugin 拯救局

幸运的是，Maven 提供了一个强大的插件——maven-shade-plugin，它可以帮助解决 Jar 包冲突。这个插件可以将多个 Jar 包合并为一个重新打包的 Jar 包，并在此过程中进行必要的调整以避免冲突。

使用 maven-shade-plugin 重新打包

要使用 maven-shade-plugin，请在项目 pom.xml 文件中添加以下依赖：

<dependency>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-shade-plugin</artifactId>
  <version>3.3.0</version>
</dependency>

接下来，在 pom.xml 文件的<build>部分添加以下配置：

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-shade-plugin</artifactId>
  <executions>
    <execution>
      <phase>package</phase>
      <goals>
        <goal>shade</goal>
      </goals>
      <configuration>
        <transformers>
          <transformer implementation="org.apache.maven.plugins.shade.resource.ServicesResourceTransformer"/>
          <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/spring.factories</resource>
          </transformer>
        </transformers>
      </configuration>
    </execution>
  </executions>
</plugin>

这个配置告诉 maven-shade-plugin 在打包阶段执行 shade 目标。其中配置了三个转换器：

  • ServicesResourceTransformer： 重写 META-INF/services 文件中的服务提供程序类名。
  • ManifestResourceTransformer： 修改清单文件中的 Main-Class 条目。
  • AppendingTransformer： 将指定的资源追加到输出 Jar 包中。

重命名和重新打包 Jar 包

maven-shade-plugin 允许我们通过 relocation（重命名和重新打包）解决 Jar 包冲突。为了重命名 Jar 包，请在 configuration 中添加 relocation 元素：

<relocations>
  <relocation>
    <pattern>com.example.old</pattern>
    <shadedPattern>com.example.new</shadedPattern>
  </relocation>
</relocations>

这会将所有以 com.example.old 开头的类重命名为 com.example.new。这样，即使存在另一个包含 com.example.old 类的新版本 Jar 包，它们也可以在同一个工程中共存。

结论

使用 maven-shade-plugin，我们可以巧妙地解决版本不兼容的 Jar 包冲突。通过重命名和重新打包，我们可以让不同的 Jar 包和平共处，避免类加载器混淆和错误。下次遇到 Jar 包冲突时，别再抓狂，拿出 maven-shade-plugin，让它成为你的救星吧！