How can I create an executable JAR with dependencies using Maven

Question

I want to package my project in a single executable JAR for distribution   How can I make a Maven project package all dependency JARs into my output JAR

User · Answer

Ken Liu has it right in my opinion  The maven dependency plugin allows you to expand all the dependencies  which you can then treat as resources  This allows you to include them in the main artifact  The use of the assembly plugin creates a secondary artifact which can be difficult to modify - in my case I wanted to add custom manifest entries  My pom ended up as    lt project gt         lt build gt     lt plugins 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 unpack-dependencies lt  id gt         lt phase gt package lt  phase gt         lt goals gt          lt goal gt unpack-dependencies lt  goal gt         lt  goals gt        lt  execution gt       lt  executions gt      lt  plugin gt     lt  plugins gt           lt resources gt      lt resource gt       lt directory gt   basedir  target dependency lt  directory gt       lt targetPath gt   lt  targetPath gt      lt  resource gt     lt  resources gt    lt  build gt        lt  project gt

User · Answer

You could combine the maven-shade-plugin and maven-jar-plugin    The maven-shade-plugin packs your classes and all dependencies in a single jar file  Configure the maven-jar-plugin to specify the main class of your executable jar  see Set Up The Classpath  chapter  Make The Jar Executable      Example POM configuration for maven-jar-plugin            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 3 2 lt  version gt               lt configuration gt                   lt archive gt                       lt manifest gt                           lt addClasspath gt true lt  addClasspath gt                           lt mainClass gt com example MyMainClass lt  mainClass gt                       lt  manifest gt                   lt  archive gt               lt  configuration gt           lt  plugin gt    Finally create the executable jar by invoking   mvn clean package shade shade

User · Answer

This could also be an option You will be able to build your jar file   lt build gt       lt plugins gt           lt plugin gt               lt  -- Build an executable JAR -- 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 mainClass gt WordListDriver lt  mainClass gt                       lt  manifest gt                   lt  archive gt               lt  configuration gt           lt  plugin gt       lt  plugins gt   lt  build gt

User · Answer

lt build gt     lt plugins gt       lt plugin gt         lt artifactId gt maven-assembly-plugin lt  artifactId gt         lt configuration 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   lt  build gt    and you run it with  mvn clean compile assembly single   Compile goal should be added before assembly single or otherwise the code on your own project is not included   See more details in comments     Commonly this goal is tied to a build phase to execute automatically  This ensures the JAR is built when executing mvn install or performing a deployment release    lt plugin gt     lt artifactId gt maven-assembly-plugin lt  artifactId gt     lt configuration 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 executions gt       lt execution gt         lt id gt make-assembly lt  id gt   lt  -- this is used for inheritance merges -- gt         lt phase gt package lt  phase gt   lt  -- bind to the packaging phase -- gt         lt goals gt           lt goal gt single lt  goal gt         lt  goals gt       lt  execution gt     lt  executions gt   lt  plugin gt

User · Answer

Another option if you really want to repackage the other JARs contents inside your single resultant JAR is the Maven Assembly plugin   It unpacks and then repacks everything into a directory via  lt unpack gt true lt  unpack gt   Then you d have a second pass that built it into one massive JAR   Another option is the OneJar plugin   This performs the above repackaging actions all in one step

User · Answer

I compared the tree plugins mentioned in this post  I generated 2 jars and a directory with all the jars  I compared the results and definitely the maven-shade-plugin is the best  My challenge was that I have multiple spring resources that needed to be merged  as well as jax-rs  and JDBC services  They were all merged properly by the shade plugin in comparison with the maven-assembly-plugin  In which case the spring will fail unless you copy them to your own resources folder and merge them manually one time  Both plugins output the correct dependency tree  I had multiple scopes like test provide  compile  etc the test and provided were skipped by both plugins  They both produced the same manifest but I was able to consolidate licenses with the shade plugin using their transformer  With the maven-dependency-plugin of course you don t have those problems because the jars are not extracted  But like some other have pointed you need to carry one extra file s  to work properly  Here is a snip of the pom xml               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 prepare-package lt  phase gt                       lt goals gt                           lt goal gt copy-dependencies lt  goal gt                       lt  goals gt                       lt configuration gt                           lt outputDirectory gt   project build directory  lib lt  outputDirectory gt                           lt includeScope gt compile lt  includeScope gt                           lt excludeTransitive gt true lt  excludeTransitive gt                           lt overWriteReleases gt false lt  overWriteReleases gt                           lt overWriteSnapshots gt false lt  overWriteSnapshots gt                           lt overWriteIfNewer gt true lt  overWriteIfNewer gt                       lt  configuration gt                   lt  execution gt               lt  executions gt           lt  plugin gt           lt plugin gt               lt groupId gt org apache maven plugins lt  groupId gt               lt artifactId gt maven-assembly-plugin lt  artifactId gt               lt version gt 2 6 lt  version gt               lt configuration gt                   lt archive gt                       lt manifest gt                           lt addClasspath gt true lt  addClasspath gt                           lt mainClass gt com rbccm itf cdd poller landingzone LandingZonePoller 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 executions gt                   lt execution gt                       lt id gt make-my-jar-with-dependencies lt  id 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  plugin gt           lt plugin gt               lt groupId gt org apache maven plugins lt  groupId gt               lt artifactId gt maven-shade-plugin lt  artifactId gt               lt version gt 2 4 3 lt  version gt               lt configuration gt                   lt shadedArtifactAttached gt false lt  shadedArtifactAttached gt                   lt keepDependenciesWithProvidedScope gt false lt  keepDependenciesWithProvidedScope gt                   lt transformers gt                       lt transformer implementation  org apache maven plugins shade resource AppendingTransformer  gt                           lt resource gt META-INF services javax ws rs ext Providers lt  resource gt                       lt  transformer gt                       lt transformer implementation  org apache maven plugins shade resource AppendingTransformer  gt                           lt resource gt META-INF spring factories lt  resource gt                       lt  transformer gt                       lt transformer implementation  org apache maven plugins shade resource AppendingTransformer  gt                           lt resource gt META-INF spring handlers lt  resource gt                       lt  transformer gt                       lt transformer implementation  org apache maven plugins shade resource AppendingTransformer  gt                           lt resource gt META-INF spring schemas lt  resource gt                       lt  transformer gt                       lt transformer implementation  org apache maven plugins shade resource AppendingTransformer  gt                           lt resource gt META-INF spring tooling lt  resource gt                       lt  transformer gt                       lt transformer implementation  org apache maven plugins shade resource ServicesResourceTransformer   gt                       lt transformer implementation  org apache maven plugins shade resource ManifestResourceTransformer   gt                       lt transformer implementation  org apache maven plugins shade resource ApacheLicenseResourceTransformer  gt                       lt  transformer gt                   lt  transformers gt               lt  configuration gt               lt executions gt                   lt execution gt                       lt goals gt                           lt goal gt shade lt  goal gt                       lt  goals gt                   lt  execution gt               lt  executions gt           lt  plugin gt

User · Answer

Something that have worked for me was      lt plugin gt       lt artifactId gt maven-dependency-plugin lt  artifactId gt       lt executions gt         lt execution gt           lt id gt unpack-dependencies lt  id gt           lt phase gt prepare-package lt  phase gt           lt goals gt             lt goal gt unpack-dependencies lt  goal gt           lt  goals gt           lt configuration gt             lt outputDirectory gt   project build directory  classes lt  outputDirectory gt           lt  configuration gt         lt  execution gt        lt  executions gt     lt  plugin gt       lt plugin gt       lt groupId gt org apache maven plugins lt  groupId gt       lt artifactId gt maven-jar-plugin lt  artifactId gt       lt executions gt         lt execution gt           lt id gt unpack-dependencies lt  id gt           lt phase gt package lt  phase gt         lt  execution gt       lt  executions 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 mainClass gt SimpleKeyLogger lt  mainClass gt           lt  manifest gt         lt  archive gt       lt  configuration gt     lt  plugin gt    I had extraordinary case because my dependency was system one    lt dependency gt          lt scope gt system lt  scope gt     lt systemPath gt   project basedir  lib myjar jar lt  systemPath gt   lt  dependency gt    I have changed the code provided by  user189057 with changes  1  maven-dependency-plugin is executed in  prepare-package  phase 2  I am extracting unpacked classess directly to  target classes

User · Answer

To resolve this issue we will use Maven Assembly Plugin that will create the JAR together with its dependency JARs into a single executable JAR file  Just add below plugin configuration in your pom xml file    lt build gt      lt pluginManagement gt         lt plugins gt            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 addClasspath gt true lt  addClasspath gt                        lt mainClass gt com your package 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 executions gt                  lt execution gt                     lt id gt make-my-jar-with-dependencies lt  id 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  plugin gt         lt  plugins gt      lt  pluginManagement gt   lt  build gt    After doing this don   t forget to run MAVEN tool with this command mvn clean compile assembly single  http   jkoder com maven-creating-a-jar-together-with-its-dependency-jars-into-a-single-executable-jar-file

User · Answer

Taking Unanswered s answer and reformatting it  we have    lt build 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 fully qualified MainClass lt  mainClass gt                       lt  manifest gt                   lt  archive gt               lt  configuration gt           lt  plugin gt           lt plugin gt               lt artifactId gt maven-assembly-plugin lt  artifactId 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    Next  I would recommend making this a natural part of your build  rather than something to call explicitly   To make this a integral part of your build  add this plugin to your pom xml and bind it to the package lifecycle event   However  a gotcha is that you need to call the assembly single goal if putting this in your pom xml  while you would call  assembly assembly  if executing it manually from the command line    lt project gt             lt build gt         lt plugins gt             lt plugin gt                 lt artifactId gt maven-assembly-plugin lt  artifactId gt                 lt configuration gt                     lt archive gt                         lt manifest gt                             lt addClasspath gt true lt  addClasspath 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 executions gt                     lt execution gt                         lt id gt make-my-jar-with-dependencies lt  id 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  plugin gt                     lt  plugins gt               lt  build gt   lt  project gt

User · Answer

To create an executable JAR from command line itself just run the below command from the project path   mvn assembly assembly

User · Answer

You can use maven-shade plugin to build a uber jar like below   lt plugin gt       lt groupId gt org apache maven plugins lt  groupId gt       lt artifactId gt maven-shade-plugin lt  artifactId gt       lt executions gt           lt execution gt               lt phase gt package lt  phase gt               lt goals gt                   lt goal gt shade lt  goal gt               lt  goals gt           lt  execution gt       lt  executions gt   lt  plugin gt

User · Answer

The maven-assembly-plugin worked great for me  I spent hours with the maven-dependency-plugin and couldn t make it work  The main reason was that I had to define in the configuration section explicitly the artifact items which should be included as it is described in the documentation   There is an example there for the cases when you want to use it like  mvn dependency copy  where there are not included any artifactItems but it doesn t work

User · Answer

Use the maven-shade-plugin to package all dependencies into one uber-jar  It can also be used to build an executable jar by specifying the main class  After trying to use maven-assembly and maven-jar   I found that this plugin best suited my needs    I found this plugin particularly useful as it merges content of specific files instead of overwriting them  This is needed when there are resource files that are have the same name across the jars and the plugin tries to package all the resource files  See example below          lt plugins gt       lt  -- This plugin provides the capability to package the artifact in an uber-jar  including its dependencies and to shade - i e  rename - the packages of some of the dependencies  -- gt           lt plugin gt               lt groupId gt org apache maven plugins lt  groupId gt               lt artifactId gt maven-shade-plugin lt  artifactId gt               lt version gt 1 4 lt  version gt               lt executions gt                   lt execution gt                       lt phase gt package lt  phase gt                       lt goals gt                           lt goal gt shade lt  goal gt                       lt  goals gt                       lt configuration gt                           lt artifactSet gt                           lt  -- signed jars-- gt                               lt excludes gt                                   lt exclude gt bouncycastle bcprov-jdk15 lt  exclude gt                               lt  excludes gt                           lt  artifactSet gt                             lt transformers gt                               lt transformer                                 implementation  org apache maven plugins shade resource ManifestResourceTransformer  gt                                   lt  -- Main class -- gt                                   lt mainClass gt com main MyMainClass lt  mainClass gt                               lt  transformer gt                               lt  -- Use resource transformers to prevent file overwrites -- gt                               lt transformer                                   implementation  org apache maven plugins shade resource AppendingTransformer  gt                                   lt resource gt properties properties lt  resource gt                               lt  transformer gt                               lt transformer                                 implementation  org apache maven plugins shade resource XmlAppendingTransformer  gt                                   lt resource gt applicationContext xml lt  resource gt                               lt  transformer gt                               lt transformer                                 implementation  org apache maven plugins shade resource AppendingTransformer  gt                                   lt resource gt META-INF cxf cxf extension lt  resource gt                               lt  transformer gt                               lt transformer                                 implementation  org apache maven plugins shade resource XmlAppendingTransformer  gt                                   lt resource gt META-INF cxf bus-extensions xml lt  resource gt                               lt  transformer gt                        lt  transformers gt                       lt  configuration gt                   lt  execution gt               lt  executions gt           lt  plugin gt        lt  plugins gt

User · Answer

lt build gt       lt plugins gt           lt plugin gt               lt groupId gt org apache maven plugins lt  groupId gt               lt artifactId gt maven-assembly-plugin lt  artifactId gt               lt version gt 2 4 1 lt  version gt               lt configuration gt                   lt  -- get all project dependencies -- gt                   lt descriptorRefs gt                       lt descriptorRef gt jar-with-dependencies lt  descriptorRef gt                   lt  descriptorRefs gt               lt  configuration gt               lt executions gt                   lt execution gt                       lt id gt make-assembly lt  id gt                       lt  -- bind to the packaging phase -- 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  plugin gt       lt  plugins gt   lt  build gt

User · Answer

There are millions of answers already  I wanted to add you don t need  lt mainClass gt  if you don t need to add entryPoint to your application  For example APIs may not have necessarily have main method   maven plugin config     lt build gt       lt finalName gt log-enrichment lt  finalName gt       lt plugins gt         lt plugin gt           lt artifactId gt maven-assembly-plugin lt  artifactId 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    build  mvn clean compile assembly single   verify  ll target  total 35100 drwxrwx--- 1 root vboxsf     4096 Sep 29 16 25    drwxrwx--- 1 root vboxsf     4096 Sep 29 16 25     drwxrwx--- 1 root vboxsf        0 Sep 29 16 08 archive-tmp  drwxrwx--- 1 root vboxsf        0 Sep 29 16 25 classes  drwxrwx--- 1 root vboxsf        0 Sep 29 16 25 generated-sources  drwxrwx--- 1 root vboxsf        0 Sep 29 16 25 generated-test-sources  -rwxrwx--- 1 root vboxsf 35929841 Sep 29 16 10 log-enrichment-jar-with-dependencies jar  drwxrwx--- 1 root vboxsf        0 Sep 29 16 08 maven-status

User · Answer

You can use the dependency-plugin to generate all dependencies in a separate directory before the package phase and then include that in the classpath of the manifest    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 prepare-package lt  phase gt               lt goals gt                   lt goal gt copy-dependencies lt  goal gt               lt  goals gt               lt configuration gt                   lt outputDirectory gt   project build directory  lib lt  outputDirectory gt                   lt overWriteReleases gt false lt  overWriteReleases gt                   lt overWriteSnapshots gt false lt  overWriteSnapshots gt                   lt overWriteIfNewer gt true lt  overWriteIfNewer gt               lt  configuration gt           lt  execution gt       lt  executions gt   lt  plugin 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 classpathPrefix gt lib  lt  classpathPrefix gt                   lt mainClass gt theMainClass lt  mainClass gt               lt  manifest gt           lt  archive gt       lt  configuration gt   lt  plugin gt    Alternatively use   project build directory  classes lib as OutputDirectory to integrate all jar-files into the main jar  but then you will need to add custom classloading code to load the jars

User · Answer

You can use maven-dependency-plugin  but the question was how to create an executable JAR  To do that requires the following alteration to Matthew Franglen s response  btw  using the dependency plugin takes longer to build when starting from a clean target     lt build gt       lt plugins gt           lt plugin gt               lt artifactId gt maven-jar-plugin lt  artifactId gt               lt configuration gt                   lt archive gt                       lt manifest gt                           lt mainClass gt fully qualified MainClass lt  mainClass gt                       lt  manifest gt                   lt  archive gt               lt  configuration gt           lt  plugin gt           lt plugin gt               lt artifactId gt maven-dependency-plugin lt  artifactId gt               lt executions gt                   lt execution gt                       lt id gt unpack-dependencies lt  id gt                       lt phase gt package lt  phase gt                       lt goals gt                           lt goal gt unpack-dependencies lt  goal gt                       lt  goals gt                   lt  execution gt               lt  executions gt           lt  plugin gt       lt  plugins gt       lt resources gt           lt resource gt               lt directory gt   basedir  target dependency lt  directory gt           lt  resource gt       lt  resources gt   lt  build gt

User · Answer

I won t answer directly the question as other have already done that before  but I really wonder if it s a good idea to embed all the dependencies in the project s jar itself   I see the point  ease of deployment   usage  but it depends of the use case of your poject  and there may be alternatives  see below     If you use it fully standalone  why not   But if you use your project in other contexts  like in a webapp  or dropped in a folder where other jars are sitting   you may have jar duplicates in your classpath  the ones in the folder  the one in the jars   Maybe not a bid deal but i usually avoid this   A good alternative     deploy your application as a  zip    war   the archive contains your project s jar and all dependent jars   use a dynamic classloader mechanism  see Spring  or you can easily do this yourself  to have a single entry point of your project  a single class to start - see the Manifest mechanism on another answer   which will add  dynamically  to the current classpath all the other needed jars    Like this  with in the end just a manifest and a  special dynamic classloader main   you can start your project with    java -jar ProjectMainJar jar com stackoverflow projectName MainDynamicClassLoaderClass

User · Answer

This blog post shows another approach with combining the maven-jar and maven-assembly plugins  With the assembly configuration xml from the blog post it can also be controlled if dependencies will be expanded or just be collected in a folder and referenced by a classpath entry in the manifest      The ideal solution is to include the jars in a lib folder and the manifest mf file of the main jar include all the jars in classpath    And exactly that one is described here  https   caffebig wordpress com 2013 04 05 executable-jar-file-with-dependent-jars-using-maven

User · Answer

For anyone looking for options to exclude specific dependencies from the uber-jar  this is a solution that worked for me    lt project    gt   lt dependencies gt           lt dependency gt               lt groupId gt org apache spark lt  groupId gt               lt artifactId gt spark-core 2 11 lt  artifactId gt               lt version gt 1 6 1 lt  version gt               lt scope gt provided lt  scope gt   lt                        lt  dependency gt   lt  dependencies gt   lt build gt           lt plugins gt               lt plugin gt                   lt artifactId gt maven-assembly-plugin lt  artifactId gt                   lt configuration gt                       lt descriptorRefs gt                           lt descriptorRef gt jar-with-dependencies lt  descriptorRef gt                       lt  descriptorRefs gt                       lt archive gt                           lt manifest gt                               lt mainClass gt     lt  mainClass gt                           lt  manifest gt                       lt  archive gt                   lt  configuration gt                   lt executions gt                       lt execution gt                           lt id gt make-assembly lt  id 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  plugin gt           lt  plugins gt       lt  build gt   lt  project gt    So it s not a configuration of the mvn-assembly-plugin but a property of the dependency

User · Answer

Add to pom xml      lt dependency gt               lt groupId gt com jolira lt  groupId gt               lt artifactId gt onejar-maven-plugin lt  artifactId gt               lt version gt 1 4 4 lt  version gt     lt  dependency gt    and   lt plugin gt          lt groupId gt com jolira lt  groupId gt          lt artifactId gt onejar-maven-plugin lt  artifactId gt          lt version gt 1 4 4 lt  version gt          lt executions gt                 lt execution gt                        lt goals gt                            lt goal gt one-jar lt  goal gt                        lt  goals gt                 lt  execution gt          lt  executions gt   lt  plugin gt    Thats it  Next mvn package will also create one fat jar additionally  including all dependency jars

User · Answer

I hope my experience can help somebody  I want to migrate my app Spring  using cas client  to Spring Boot  1 5 not 2 4 yet   I stucked with many problem like    no main manifest attribute  in target cas-client-web jar  I want to make one unique jar with all dependencies  After some days in searching on the Internet  I can do my job with theses lines             lt plugin gt               lt groupId gt org springframework boot lt  groupId gt               lt artifactId gt spring-boot-maven-plugin lt  artifactId gt               lt configuration gt                   lt fork gt true lt  fork gt                   lt mainClass gt   start-class  lt  mainClass gt               lt  configuration gt               lt executions gt                   lt execution gt                       lt goals gt                           lt goal gt repackage lt  goal gt                       lt  goals gt                   lt  execution gt               lt  executions gt           lt  plugin 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 archive gt                       lt manifest gt                           lt addClasspath gt true lt  addClasspath gt                           lt mainClass gt   start-class  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   with start-class is your main class  lt properties gt       lt java version gt 1 8 lt  java version gt       lt start-class gt com test Application lt  start-class gt   lt  properties gt   And my Application is like   package com test   import java util Arrays   import com test TestProperties  import org springframework boot CommandLineRunner  import org springframework boot SpringApplication  import org springframework boot autoconfigure EnableAutoConfiguration  import org springframework boot autoconfigure SpringBootApplication  import org springframework boot context properties EnableConfigurationProperties  import org springframework context ApplicationContext  import org springframework context annotation Bean     SpringBootApplication  EnableAutoConfiguration  EnableConfigurationProperties  TestProperties class   public class Application    public static void main String   args        SpringApplication run Application class  args       Bean public CommandLineRunner commandLineRunner ApplicationContext ctx        return args - gt             System out println  quot Let s inspect the beans provided by Spring Boot  quot             String   beanNames   ctx getBeanDefinitionNames            Arrays sort beanNames           for  String beanName   beanNames                System out println beanName

User · Answer

It should be like that    lt plugin gt       lt artifactId gt maven-dependency-plugin lt  artifactId gt       lt executions gt           lt execution gt               lt id gt unpack-dependencies lt  id gt               lt phase gt generate-resources lt  phase gt               lt goals gt                   lt goal gt unpack-dependencies lt  goal gt               lt  goals gt           lt  execution gt       lt  executions gt   lt  plugin gt    Unpacking have to be in generate-resources phase because  if in package phase  will not be included as resources  Try clean package and you ll see

User · Answer

Problem with locating shared assembly file with maven-assembly-plugin-2 2 1   Try using descriptorId configuration parameter instead of descriptors descriptor or descriptorRefs descriptorRef parameters   Neither of them do what you need  look for the file on classpath  Of course you need adding the package where the shared assembly resides on maven-assembly-plugin s classpath  see below   If you re using Maven 2 x  not Maven 3 x   you may need adding this dependency in top-most parent pom xml in pluginManagement section   See this for more details   Class  org apache maven plugin assembly io DefaultAssemblyReader  Example            lt  -- Use the assembly plugin to create a zip file of all our dependencies  -- gt           lt plugin gt               lt artifactId gt maven-assembly-plugin lt  artifactId gt               lt version gt 2 2 1 lt  version gt               lt executions gt                   lt execution gt                       lt id gt make-assembly 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 descriptorId gt assembly-zip-for-wid lt  descriptorId gt                       lt  configuration gt                   lt  execution gt               lt  executions gt               lt dependencies gt                   lt dependency gt                       lt groupId gt cz ness ct ip assemblies lt  groupId gt                       lt artifactId gt TEST SharedAssemblyDescriptor lt  artifactId gt                       lt version gt 1 0 0-SNAPSHOT lt  version gt                   lt  dependency gt               lt  dependencies gt           lt  plugin gt

User · Answer

This is the best way i found      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 mainClass gt com myDomain etc MainClassName lt  mainClass gt           lt classpathPrefix gt dependency-jars  lt  classpathPrefix gt           lt  manifest 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 version gt 2 5 1 lt  version 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 configuration gt               lt outputDirectory gt                   project build directory  dependency-jars               lt  outputDirectory gt           lt  configuration gt         lt  execution gt       lt  executions gt     lt  plugin gt    With this configuration  all dependencies will be located in  dependency-jars  My application has no Main class  just context ones  but one of my dependencies do have a Main class  com myDomain etc MainClassName  that starts the JMX server  and receives a start or a stop parameter  So with this i was able to start my application like this   java -jar   lib TestApp-1 0-SNAPSHOT jar start   I wait it be useful for you all

User · Answer

See executable-jar-with-maven-example  GitHub  Notes Those pros and cons are provided by Stephan   For Manual Deployment  Pros Cons  Dependencies are out of the final jar     Copy Dependencies to a specific 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 copy-dependencies lt  id gt         lt phase gt prepare-package lt  phase gt         lt goals gt           lt goal gt copy-dependencies lt  goal gt         lt  goals gt         lt configuration gt           lt outputDirectory gt   project build directory    project build finalName  lib lt  outputDirectory gt         lt  configuration gt       lt  execution gt     lt  executions gt   lt  plugin gt   Make the Jar Executable and Classpath Aware  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 classpathPrefix gt   project build finalName  lib  lt  classpathPrefix gt           lt mainClass gt   fully qualified main class  lt  mainClass gt         lt  manifest gt       lt  archive gt     lt  configuration gt   lt  plugin gt   At this point the jar is actually executable with external classpath elements    java -jar target   project build finalName  jar  Make Deployable Archives The jar file is only executable with the sibling    lib  directory  We need to make archives to deploy with the directory and its content   lt plugin gt     lt groupId gt org apache maven plugins lt  groupId gt     lt artifactId gt maven-antrun-plugin lt  artifactId gt     lt executions gt       lt execution gt         lt id gt antrun-archive lt  id gt         lt phase gt package lt  phase gt         lt goals gt           lt goal gt run lt  goal gt         lt  goals gt         lt configuration gt           lt target gt             lt property name  quot final name quot  value  quot   project build directory    project build finalName  quot   gt             lt property name  quot archive includes quot  value  quot   project build finalName    project packaging    project build finalName  lib   quot   gt             lt property name  quot tar destfile quot  value  quot   final name  tar quot   gt             lt zip basedir  quot   project build directory  quot  destfile  quot   final name  zip quot  includes  quot   archive includes  quot    gt             lt tar basedir  quot   project build directory  quot  destfile  quot   tar destfile  quot  includes  quot   archive includes  quot    gt             lt gzip src  quot   tar destfile  quot  destfile  quot   tar destfile  gz quot    gt             lt bzip2 src  quot   tar destfile  quot  destfile  quot   tar destfile  bz2 quot    gt           lt  target gt         lt  configuration gt       lt  execution gt     lt  executions gt   lt  plugin gt   Now you have target   project build finalName   zip tar tar bz2 tar gz  which each contains the jar and lib     Apache Maven Assembly Plugin  Pros Cons  No class relocation support  use maven-shade-plugin if class relocation is needed       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 phase gt package lt  phase gt         lt goals gt           lt goal gt single lt  goal gt         lt  goals gt         lt configuration gt           lt archive gt             lt manifest gt               lt mainClass gt   fully qualified main class  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  execution gt     lt  executions gt   lt  plugin gt   You have target   project bulid finalName -jar-with-dependencies jar   Apache Maven Shade Plugin  Pros Cons   lt plugin gt     lt groupId gt org apache maven plugins lt  groupId gt     lt artifactId gt maven-shade-plugin lt  artifactId gt     lt executions gt       lt execution gt         lt goals gt           lt goal gt shade lt  goal gt         lt  goals gt         lt configuration gt           lt shadedArtifactAttached gt true lt  shadedArtifactAttached gt           lt transformers gt             lt transformer implementation  quot org apache maven plugins shade resource ManifestResourceTransformer quot  gt               lt mainClass gt   fully qualified main class  lt  mainClass gt             lt  transformer gt           lt  transformers gt         lt  configuration gt       lt  execution gt     lt  executions gt   lt  plugin gt   You have target   project build finalName -shaded jar   onejar-maven-plugin  Pros Cons  Not actively supported since 2012      lt plugin gt     lt  --groupId gt org dstovall lt  groupId-- gt   lt  -- not available on the central -- gt     lt groupId gt com jolira lt  groupId gt     lt artifactId gt onejar-maven-plugin lt  artifactId gt     lt executions gt       lt execution gt         lt configuration gt           lt mainClass gt   fully qualified main class  lt  mainClass gt           lt attachToBuild gt true lt  attachToBuild gt           lt  -- https   code google com p onejar-maven-plugin issues detail id 8 -- gt           lt  --classifier gt onejar lt  classifier-- gt           lt filename gt   project build finalName -onejar   project packaging  lt  filename gt         lt  configuration gt         lt goals gt           lt goal gt one-jar lt  goal gt         lt  goals gt       lt  execution gt     lt  executions gt   lt  plugin gt    Spring Boot Maven Plugin  Pros Cons  Add potential unecessary Spring and Spring Boot related classes      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   fully qualified main class  lt  mainClass gt         lt  configuration gt       lt  execution gt     lt  executions gt   lt  plugin gt   You have target   project bulid finalName -spring-boot jar

User · Answer

I went through every one of these responses looking to make a fat executable jar containing all dependencies and none of them worked right   The answer is the shade plugin  its very easy and straightforward        lt plugin gt         lt groupId gt org apache maven plugins lt  groupId gt         lt artifactId gt maven-shade-plugin lt  artifactId gt         lt version gt 2 3 lt  version gt         lt executions gt            lt  -- Run shade goal on package phase -- gt           lt execution gt           lt phase gt package lt  phase gt           lt goals gt               lt goal gt shade lt  goal gt           lt  goals gt           lt configuration gt             lt transformers gt                lt transformer implementation  org apache maven plugins shade resource ManifestResourceTransformer  gt                   lt mainClass gt path to MainClass lt  mainClass gt                lt  transformer gt             lt  transformers gt           lt  configuration gt             lt  execution gt         lt  executions gt       lt  plugin gt    Be aware that your dependencies need to have a scope of compile or runtime for this to work properly   This example came from mkyong com

User · Answer

You can add the following to your pom xml    lt build gt   lt defaultGoal gt install lt  defaultGoal gt   lt plugins gt     lt plugin gt       lt artifactId gt maven-compiler-plugin lt  artifactId gt       lt version gt 2 3 2 lt  version gt       lt configuration gt         lt source gt 1 6 lt  source gt         lt target gt 1 6 lt  target gt       lt  configuration gt     lt  plugin 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 3 1 lt  version gt       lt configuration gt         lt archive gt           lt manifest gt             lt addClasspath gt true lt  addClasspath gt             lt mainClass gt com mycompany package MainClass lt  mainClass gt           lt  manifest gt         lt  archive gt       lt  configuration gt     lt  plugin gt     lt plugin gt       lt artifactId gt maven-assembly-plugin lt  artifactId gt       lt configuration gt         lt descriptorRefs gt           lt descriptorRef gt jar-with-dependencies lt  descriptorRef gt         lt  descriptorRefs gt         lt archive gt           lt manifest gt             lt mainClass gt com mycompany package MainClass lt  mainClass gt           lt  manifest gt         lt  archive gt       lt  configuration gt       lt executions gt         lt execution gt           lt id gt make-my-jar-with-dependencies lt  id 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  plugin gt   lt  plugins gt   lt  build gt    Afterwards you have to switch via the console to the directory  where the pom xml is located  Then you have to execute mvn assembly single and then your executable JAR file with dependencies will be hopefully build  You can check it when switching to the output  target  directory with cd   target and starting your jar with a command similiar to java -jar mavenproject1-1 0-SNAPSHOT-jar-with-dependencies jar    I tested this with Apache Maven 3 0 3

User · Answer

Okay  so this is my solution  I know it s not using the pom xml file  But I had the problem my programmme compiling and running on Netbeans but it failing when I tried Java -jar MyJarFile jar  Now  I don t fully understand Maven and I think this why was having trouble getting Netbeans 8 0 2 to include my jar file in a library to put them into a jar file  I was thinking about how I used to use jar files with no Maven in Eclipse    It s Maven that can compile all the dependanices and plugins  Not Netbeans   If you can get Netbeans and be able to use java  jar to do this please tell me how      v     Solved - for Linux  by opening a terminal    Then  cd  MyRootDirectoryForMyProject   Next  mvn org apache maven plugins maven-compiler-plugin compile   Next  mvn install   This will create jar file in the target directory   MyJarFile-1 0-jar-with-dependencies jar   Now  cd target    You may need to run  chmod  x MyJarFile-1 0-jar-with-dependencies jar   And finally  java -jar MyJarFile-1 0-jar-with-dependencies jar   Please see   https   cwiki apache org confluence display MAVEN LifecyclePhaseNotFoundException  I ll post this solution in on a couple of other pages with a similar problem  Hopefully I can save somebody from a week of frustration

User · Answer

Long used the maven assembly plugin  but I could not find a solution to the problem with  already added  skipping   Now  I m using another plugin - onejar-maven-plugin  Example below  mvn package build jar     lt plugin gt       lt groupId gt org dstovall lt  groupId gt       lt artifactId gt onejar-maven-plugin lt  artifactId gt       lt version gt 1 3 0 lt  version gt       lt executions gt           lt execution gt               lt configuration gt                   lt mainClass gt com company MainClass lt  mainClass gt               lt  configuration gt               lt goals gt                   lt goal gt one-jar lt  goal gt               lt  goals gt           lt  execution gt       lt  executions gt   lt  plugin gt    You need to add repository for that plugin    lt pluginRepositories gt       lt pluginRepository gt           lt id gt onejar-maven-plugin googlecode com lt  id gt           lt url gt http   onejar-maven-plugin googlecode com svn mavenrepo lt  url gt       lt  pluginRepository gt   lt  pluginRepositories gt

User · Answer

I tried the most up-voted answer here  and was able to get the jar runnable  But the program didn t run correctly  I do not know what the reason was  When I try to run from Eclipse  I get a different result but when I run the jar from command-line I get a different result  it crashes with a program-specific runtime error    I had a similar requirement as the OP just that I had too many  Maven  dependencies for my project  Fortunately  the only solution that worked for me was that using Eclipse  Very simple and very straightforward  This is not a solution to the OP but is a solution for someone who has a similar requirement but with many Maven dependencies   1  Just right-click on your project folder  in Eclipse  and select Export  2  Then select Java -  Runnable Jar  3  You will be asked to choose the location of the jar file  4  Finally  select the class that has the Main method that you want to run and choose Package dependencies with the Jar file and click Finish

[java] How can I create an executable JAR with dependencies using Maven?

Examples related to java

Examples related to maven-2

Examples related to build-process

Examples related to build-automation

Examples related to executable-jar