What is a shaded JAR file? And what is the difference/similarities between an uber JAR and shaded JAR? [duplicate]

by

I’ll explain what an uber JAR is first because this underpins the shading explanation.

Uber JAR

An uber JAR is a JAR which contains the contents of multiple JARs (or, less commonly, multiple other JARs themselves)

Your application will almost certainly use other packages and these packages might be provided as JARs. When using Maven these dependencies would be expressed as follows:

<dependency>
    <groupId>...</groupId>
    <artifactId>...</artifactId>
    <version>...</version>
</dependency>

At runtime your application will expect to find the classes contained in this JAR on its classpath.

Rather than shipping each of these dependent JARs along with your application, you could create an uber JAR which contains all of the classes etc from these dependent JARs and then simply run your application from this uber JAR.

Shading

Shading provides a way of creating an uber JAR and renaming the packages which that uber JAR contains. If your uber JAR is likely to be used as a dependency in another application then there’s a risk that the versions of the dependent classes in the uber JAR might clash with versions of those same dependencies in this other application. Shading helps to avoid any such issue by renaming the packages within the uber JAR.

For example:

  1. You create an uber JAR which contains v1.0.0 of the Foo library.
  2. Someone else uses your uber JAR in their application, Bar
  3. The Bar application has its own dependency on Foo but on v1.2.0 of that library.

Now, if there is any clash between versions 1.0.0 and 1.2.0 of Foo we may have a problem because the owner of Bar cannot rely on which one will be loaded so either their code will misbehave or your code – when running within their application – will misbehave.

Shading helps to avoid issues such as this and also allows the provider of Foo to be explicit about the versions of the dependent libraries it uses.

The maven-shade-plugin allows you to (a) create an uber JAR and (b) to shade its contents.

Summary

Creating an uber JAR is a useful technique for simplifying your deployment process.

Shading is an extension to the uber JAR idea which is typically limited to use cases where

  • The JAR is a library to be used inside another application/library
  • The authors of the JAR want to be sure that the dependencies used by the JAR are in their control
  • The authors of the JAR want to avoid ‘version clash’ issues for any applications/libraries using the JAR

More Related Contents:

  1. What is the maven-shade-plugin used for, and why would you want to relocate Java packages?
  2. How to create spring-based executable jar with maven?
  3. Could not calculate build plan: Plugin org.apache.maven.plugins:maven-resources-plugin:2.5 or one of its dependencies could not be resolved
  4. Unable to compile simple Java 10 / Java 11 project with Maven
  5. Dealing with “Xerces hell” in Java/Maven?
  6. How do I configure Maven for offline development?
  7. Updating version numbers of modules in a multi-module Maven project
  8. Cannot change version of project facet Dynamic Web Module to 3.0?
  9. Could not transfer artifact org.apache.maven.plugins:maven-surefire-plugin:pom:2.7.1 from/to central (http://repo1.maven.org/maven2)
  10. Execute jar file with multiple classpath libraries from command prompt
  11. Is there a way to add maven dependencies while using the maven-jlink-plugin?
  12. Configure active profile in SpringBoot via Maven
  13. Adding resources in IntelliJ for Maven project
  14. Maven resource filtering not working – because of spring boot dependency [duplicate]
  15. build maven project with propriatery libraries included [duplicate]
  16. How to create a Java / Maven project that works in Visual Studio Code?
  17. How can you display the Maven dependency tree for the *plugins* in your project?
  18. Android: Dex cannot parse version 52 byte code
  19. maven “cannot find symbol” message unhelpful
  20. In Maven, Why Run ‘mvn clean’?
  21. Maven version with a property
  22. Surefire is not picking up Junit 4 tests
  23. spring Exception when running application on WebSphere with java 8
  24. Loading Maven dependencies from GitHub [duplicate]
  25. SASS implementation for Java? [closed]
  26. java.lang.IllegalStateException: No transactional EntityManager available
  27. Using antcontrib task via maven-antrun-plugin
  28. What is the implicit ID of a maven plugin execution?
  29. maven missing dependency jta-1.0.1b
  30. Karaf / Maven – Unable to resolve: missing requirement osgi.wiring.package

Leave a Comment