Including dependencies in a jar with Maven

Question

Is there a way to force maven 2 0 9  to include all the dependencies in a single jar file   I have a project the builds into a single jar file  I want the classes from dependencies to be copied into the jar as well   Update  I know that I cant just include a jar file in a jar file  I m searching for a way to unpack the jars that are specified as dependencies  and package the class files into my jar

User · Answer

lt  -- Method 1 -- gt           lt  -- Copy dependency libraries jar files to a separated LIB folder -- gt           lt plugin gt               lt groupId gt org apache maven plugins lt  groupId gt               lt artifactId gt maven-dependency-plugin lt  artifactId gt               lt configuration gt                   lt outputDirectory gt   project build directory  lib lt  outputDirectory gt                   lt excludeTransitive gt false lt  excludeTransitive gt                    lt stripVersion gt false lt  stripVersion gt               lt  configuration gt               lt executions gt                   lt execution gt                       lt id gt copy-dependencies lt  id gt                       lt phase gt package lt  phase gt                       lt goals gt                           lt goal gt copy-dependencies lt  goal gt                       lt  goals gt                   lt  execution gt               lt  executions gt           lt  plugin gt           lt  -- Add LIB folder to classPath -- gt           lt plugin gt               lt groupId gt org apache maven plugins lt  groupId gt               lt artifactId gt maven-jar-plugin lt  artifactId gt               lt version gt 2 4 lt  version gt               lt configuration gt                   lt archive gt                       lt manifest gt                           lt addClasspath gt true lt  addClasspath gt                           lt classpathPrefix gt lib  lt  classpathPrefix gt                       lt  manifest gt                   lt  archive gt               lt  configuration gt           lt  plugin gt             lt  -- Method 2 -- gt           lt  -- Package all libraries classes into one runnable jar -- gt           lt plugin gt               lt artifactId gt maven-assembly-plugin lt  artifactId gt               lt executions gt                 lt execution gt                   lt phase gt package lt  phase gt                   lt goals gt                     lt goal gt single lt  goal gt                   lt  goals gt                 lt  execution gt               lt  executions gt               lt configuration gt                 lt descriptorRefs gt                   lt descriptorRef gt jar-with-dependencies lt  descriptorRef gt                 lt  descriptorRefs gt               lt  configuration gt           lt  plugin gt

User · Answer

My definitive solution on Eclipse Luna and m2eclipse  Custom Classloader  download and add to your project  5 classes only   http   git eclipse org c jdt eclipse jdt ui git plain org eclipse jdt ui jar 20in 20jar 20loader org eclipse jdt internal jarinjarloader   this classloader is very best of one-jar classloader and very fast    lt project mainClass gt org eclipse jdt internal jarinjarloader JarRsrcLoader lt  project mainClass gt   lt project realMainClass gt my Class lt  project realMainClass gt   Edit in JIJConstants  Rsrc-Class-Path  to  Class-Path      mvn clean dependency copy-dependencies package  is created a jar with dependencies in lib folder with a thin classloader    lt build gt       lt resources gt           lt resource gt               lt directory gt src main java lt  directory gt               lt includes gt                   lt include gt      java lt  include gt                   lt include gt      properties lt  include gt               lt  includes gt           lt  resource gt           lt resource gt               lt directory gt src main resources lt  directory gt               lt filtering gt true lt  filtering gt               lt includes gt                   lt include gt      lt  include gt               lt  includes gt               lt targetPath gt META-INF  lt  targetPath gt           lt  resource gt           lt resource gt               lt directory gt   project build directory  dependency  lt  directory gt               lt includes gt                   lt include gt   jar lt  include gt               lt  includes gt               lt targetPath gt lib  lt  targetPath gt           lt  resource gt       lt  resources gt   lt pluginManagement gt           lt plugins gt                lt plugin gt                   lt groupId gt org apache maven plugins lt  groupId gt                   lt artifactId gt maven-jar-plugin lt  artifactId gt                   lt configuration gt                       lt archive gt                           lt manifest gt                               lt addClasspath gt true lt  addClasspath gt                               lt mainClass gt   project mainClass  lt  mainClass gt                               lt classpathPrefix gt lib  lt  classpathPrefix gt                           lt  manifest gt                            lt manifestEntries gt                               lt Rsrc-Main-Class gt   project realMainClass    lt  Rsrc-Main-Class gt                               lt Class-Path gt    lt  Class-Path gt                           lt  manifestEntries gt                        lt  archive gt                   lt  configuration gt               lt  plugin gt   lt plugin gt                   lt groupId gt org apache maven plugins lt  groupId gt                   lt artifactId gt maven-dependency-plugin lt  artifactId gt                   lt executions gt                       lt execution gt                           lt id gt copy-dependencies lt  id gt                           lt phase gt package lt  phase gt                           lt goals gt                               lt goal gt copy-dependencies lt  goal gt                           lt  goals gt                       lt  execution gt                   lt  executions gt               lt  plugin gt           lt  plugins gt       lt  pluginManagement gt   lt  build gt

User · Answer

If you want to do an executable jar file  them need set the main class too  So the full configuration should be        lt plugins gt               lt plugin gt                    lt artifactId gt maven-assembly-plugin lt  artifactId gt                    lt executions gt                        lt execution gt                             lt phase gt package lt  phase gt                             lt goals gt                                 lt goal gt single lt  goal gt                             lt  goals gt                         lt  execution gt                     lt  executions gt                     lt configuration gt                          lt  --     -- gt                          lt archive gt                              lt manifest gt                                    lt mainClass gt fully qualified MainClass lt  mainClass gt                              lt  manifest gt                          lt  archive gt                          lt descriptorRefs gt                              lt descriptorRef gt jar-with-dependencies lt  descriptorRef gt                         lt  descriptorRefs gt                    lt  configuration gt            lt  plugin gt      lt  plugins gt

User · Answer

http   fiji sc Uber-JAR provides an excellent explanation of the alternatives       There are three common methods for constructing an uber-JAR          Unshaded  Unpack all JAR files  then repack them into a single JAR          Pro  Works with Java s default class loader    Con  Files present in multiple JAR files with the same path  e g     META-INF services javax script ScriptEngineFactory  will overwrite one   another  resulting in faulty behavior    Tools  Maven Assembly   Plugin  Classworlds Uberjar      Shaded  Same as unshaded  but rename  i e    shade   all packages of all dependencies          Pro  Works with Java s default class loader    Avoids some  not all  dependency version clashes    Con  Files   present in multiple JAR files with the same path  e g     META-INF services javax script ScriptEngineFactory  will overwrite one   another  resulting in faulty behavior    Tools  Maven Shade Plugin      JAR of JARs  The final JAR file contains the other JAR files embedded within          Pro  Avoids dependency version clashes  All   resource files are preserved    Con  Needs to bundle a special    bootstrap  classloader to enable Java to load classes from the   wrapped JAR files  Debugging class loader issues becomes more complex    Tools  Eclipse JAR File Exporter  One-JAR

User · Answer

This post may be a bit old  but I also had the same problem recently  The first solution proposed by John Stauffer is a good one  but I had some problems as I am working this spring  The spring s dependency-jars I use have some property files and xml-schemas declaration which share the same paths and names  Although these jars come from the same versions  the jar-with-dependencies maven-goal was overwriting theses file with the last file found    In the end  the application was not able to start as the spring jars could not find the correct properties files  In this case the solution propose by Rop have solved my problem   Also since then  the spring-boot project now exist  It has a very cool way to manage this problem by providing a maven goal which overload the package goal and provide its own class loader  See spring-boots Reference Guide

User · Answer

Thanks I have added below snippet in POM xml file and Mp problem resolved and  create fat jar file that include all dependent jars    lt plugin gt       lt artifactId gt maven-assembly-plugin lt  artifactId gt           lt executions gt               lt execution gt                   lt phase gt package lt  phase gt                   lt goals gt                       lt goal gt single lt  goal gt                   lt  goals gt               lt  execution gt           lt  executions gt           lt configuration gt               lt descriptorRefs gt                   lt descriptorRef gt dependencies lt  descriptorRef gt               lt  descriptorRefs gt           lt  configuration gt       lt  plugin gt   lt  plugins gt

User · Answer

You can use the newly created jar using a  lt classifier gt  tag    lt dependencies gt       lt dependency gt           lt groupId gt your group id lt  groupId gt           lt artifactId gt your artifact id lt  artifactId gt           lt version gt 1 0 lt  version gt           lt type gt jar lt  type gt           lt classifier gt jar-with-dependencies lt  classifier gt       lt  dependency gt   lt  dependencies gt

User · Answer

You can do this using the maven-assembly plugin with the  jar-with-dependencies  descriptor  Here s the relevant chunk from one of our pom xml s that does this        lt build gt       lt plugins gt         lt  -- any other plugins -- gt         lt plugin gt           lt artifactId gt maven-assembly-plugin lt  artifactId gt           lt executions gt             lt execution gt               lt phase gt package lt  phase gt               lt goals gt                 lt goal gt single lt  goal gt               lt  goals gt             lt  execution gt           lt  executions gt           lt configuration gt             lt descriptorRefs gt               lt descriptorRef gt jar-with-dependencies lt  descriptorRef gt             lt  descriptorRefs gt           lt  configuration gt         lt  plugin gt       lt  plugins gt     lt  build gt

User · Answer

There s the shade maven plugin  It can be used to package and rename dependencies  to omit dependency problems on the classpath

User · Answer

If you  like me  dont particularly like the jar-with-dependencies approach described above  the maven-solution I prefer is to simply build a WAR-project  even if it is only a stand-alone java application you are building    Make a normal maven jar-project  that will build your jar-file  without the dependencies   Also  setup a maven war-project  with only an empty src main webapp WEB-INF web xml file  which will avoid a warning error in the maven-build   that only has your jar-project as a dependency  and make your jar-project a  lt module gt  under your war-project   This war-project is only a simple trick to wrap all your jar-file dependencies into a zip-file   Build the war-project to produce the war-file  In the deployment-step  simply rename your  war-file to   zip and unzip it    You should now have a lib-directory  which you can move where you want it  with your jar and all the dependencies you need to run your application   java -cp  path lib    MainClass    The wildcard in classpath works in Java-6 or higher   I think this is both simpler to setup in maven  no need  to mess around with the assembly plugin  and also gives you a clearer view of the application-structure  you will see the version-numbers of all dependent jars in plain view  and avoid clogging everything into a single jar-file

User · Answer

With Maven 2  the right way to do this is to use the Maven2 Assembly Plugin which has a pre-defined descriptor file for this purpose and that you could just use on the command line   mvn assembly assembly -DdescriptorId jar-with-dependencies   If you want to make this jar executable  just add the main class to be run to the plugin configuration    lt plugin gt     lt groupId gt org apache maven plugins lt  groupId gt     lt artifactId gt maven-assembly-plugin lt  artifactId gt     lt configuration gt       lt archive gt         lt manifest gt           lt mainClass gt my package to my MainClass lt  mainClass gt         lt  manifest gt       lt  archive gt     lt  configuration gt   lt  plugin gt    If you want to create that assembly as part of the normal build process  you should bind the single or directory-single goal  the assembly goal should ONLY be run from the command line  to a lifecycle phase  package makes sense   something like this    lt plugin gt     lt groupId gt org apache maven plugins lt  groupId gt     lt artifactId gt maven-assembly-plugin lt  artifactId gt     lt executions gt       lt execution gt         lt id gt create-my-bundle lt  id gt         lt phase gt package lt  phase gt         lt goals gt           lt goal gt single lt  goal gt         lt  goals gt         lt configuration gt           lt descriptorRefs gt             lt descriptorRef gt jar-with-dependencies lt  descriptorRef gt           lt  descriptorRefs gt                     lt  configuration gt       lt  execution gt     lt  executions gt   lt  plugin gt    Adapt the configuration element to suit your needs  for example with the manifest stuff as spoken

User · Answer

Have a look at this answer   I am creating an installer that runs as a Java JAR file and it needs to unpack WAR and JAR files into appropriate places in the installation directory  The dependency plugin can be used in the package phase with the copy goal and it will download any file in the Maven repository  including WAR files  and write them where ever you need them  I changed the output directory to   project build directory  classes and then end result is that the normal JAR task includes my files just fine  I can then extract them and write them into the installation directory    lt plugin gt   lt groupId gt org apache maven plugins lt  groupId gt   lt artifactId gt maven-dependency-plugin lt  artifactId gt   lt executions gt       lt execution gt           lt id gt getWar lt  id gt           lt phase gt package lt  phase gt           lt goals gt               lt goal gt copy lt  goal gt           lt  goals gt           lt configuration gt               lt artifactItems gt                   lt artifactItem gt                       lt groupId gt the group I use lt  groupId gt                       lt artifactId gt MyServerServer lt  artifactId gt                       lt version gt   env JAVA SERVER REL VER  lt  version gt                       lt type gt war lt  type gt                       lt destFileName gt myWar war lt  destFileName gt                   lt  artifactItem gt               lt  artifactItems gt               lt outputDirectory gt   project build directory  classes lt  outputDirectory gt           lt  configuration gt       lt  execution gt   lt  executions gt

User · Answer

Putting Maven aside  you can put JAR libraries inside the Main Jar but you will need to use your own classloader   Check this project  One-JAR link text

User · Answer

To make it more simple  You can use the below plugin                lt plugin gt                   lt groupId gt org springframework boot lt  groupId gt                   lt artifactId gt spring-boot-maven-plugin lt  artifactId gt                   lt executions gt                       lt execution gt                           lt goals gt                               lt goal gt repackage lt  goal gt                           lt  goals gt                           lt configuration gt                               lt classifier gt spring-boot lt  classifier gt                               lt mainClass gt                                  com nirav certificate CertificateUtility                              lt  mainClass gt                           lt  configuration gt                       lt  execution gt                   lt  executions gt               lt  plugin gt

[java] Including dependencies in a jar with Maven

Examples related to java

Examples related to maven-2

Examples related to jar

Examples related to packaging