什么是Shaded JAR？Maven Shade插件作用及与Uber JAR的异同

Hey there, let's unpack these terms clearly—they’re often tossed around interchangeably but have key differences that matter for your builds!

What is a Shaded JAR? #

Shaded JARs are a type of "all-in-one" JAR that packages your project’s classes plus all its dependencies into a single file—but with a critical twist: they relocate (rename) the package paths of dependent classes.

For example, if your project uses com.google.gson, a Shaded JAR might move all those Gson classes to com.yourproject.shaded.google.gson. This renaming ensures that when your JAR is used as a dependency in another project, it won’t clash with other versions of Gson (or any other library) that the parent project might be using. No more frustrating NoSuchMethodError or ClassNotFoundException from conflicting library versions!

The Practical Value of maven-shade-plugin #

The Maven Shade Plugin is the go-to tool for building Shaded JARs, and it’s packed with practical perks:

• Solve Dependency Conflicts: The biggest win—relocating dependency packages eliminates version clashes between your library and the projects that use it.
• Build Self-Contained Executable JARs: Package all dependencies into one JAR so users can run your app with just java -jar your-shaded.jar, no need to manage messy classpaths or download separate JARs.
• Customize Package Contents: Filter out unused classes, resources, or duplicate files (like conflicting META-INF/services entries) to keep your JAR lean and avoid runtime hiccups.
• Namespace Consolidation: Wrap dependencies into your project’s own package structure, making the JAR feel cohesive rather than a jumble of external libraries.

Here’s a quick snippet of a typical Shade Plugin configuration to relocate Gson:

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-shade-plugin</artifactId>
  <version>3.4.1</version>
  <executions>
    <execution>
      <phase>package</phase>
      <goals>
        <goal>shade</goal>
      </goals>
      <configuration>
        <relocations>
          <relocation>
            <pattern>com.google.gson</pattern>
            <shadedPattern>com.yourproject.shaded.gson</shadedPattern>
          </relocation>
        </relocations>
      </configuration>
    </execution>
  </executions>
</plugin>

What is an Uber JAR? #

An Uber JAR (also called a Fat JAR) is a single JAR file that contains your project’s classes and all its dependencies—but without any package relocation.

Think of it as a "dump" of everything your project needs to run. The downside? If two dependencies in your project use different versions of the same library, the Uber JAR will typically include only one version (the last one declared in your pom.xml), which can lead to runtime conflicts if the code expects a different version.

Shaded JAR vs. Uber JAR: Differences & Similarities #

Similarities #

• Both package your project + all dependencies into a single, easy-to-distribute JAR file.
• Both can be made executable, allowing users to launch your app with a single java -jar command.

Key Differences #

内容的提问来源于stack exchange，提问作者user3478709