Building an uberjar with Gradle

Question

I want to build an uberjar (AKA fatjar) that includes all the transitive dependencies of the project. What lines do I need to add to build.gradle?

This is what I currently have:

task uberjar(type: Jar) {
    from files(sourceSets.main.output.classesDir)

    manifest {
        attributes 'Implementation-Title': 'Foobar',
                'Implementation-Version': version,
                'Built-By': System.getProperty('user.name'),
                'Built-Date': new Date(),
                'Built-JDK': System.getProperty('java.version'),
                'Main-Class': mainClassName
    }
}

You may want to try using the [application plug-in](http://www.gradle.org/docs/current/userguide/application_plugin.html) instead. — Scott, Feb 04 '14 at 21:15
This will work as long as you do not have any dependencies. But once your project has dependencies those won't get bundled into the uberjar. — Stefan Neuhaus, Mar 15 '17 at 21:02

score 42 · Answer 1 · answered Jun 11 '12 at 20:05

42

I replaced the task uberjar(.. with the following:

jar {
    from(configurations.compile.collect { it.isDirectory() ? it : zipTree(it) }) {
        exclude "META-INF/*.SF"
        exclude "META-INF/*.DSA"
        exclude "META-INF/*.RSA"
    }

    manifest {
        attributes 'Implementation-Title': 'Foobar',
                'Implementation-Version': version,
                'Built-By': System.getProperty('user.name'),
                'Built-Date': new Date(),
                'Built-JDK': System.getProperty('java.version'),
                'Main-Class': mainClassName
    }
}

The exclusions are needed because in their absence you will hit this issue.

answered Jun 11 '12 at 20:05

missingfaktor

90,905
62
285
365

5

I think it should use `configurations.runtime` to include all runtime dependencies – lyomi Sep 12 '14 at 06:46
i needed to add `with jar` below manifest to get the files in `java/main/resources` in the uberjar – gladiator Dec 30 '14 at 12:15
That worked for me! Without the exclude part it was killing me with SecurityException and with this fix it works! – techcraver Apr 02 '18 at 20:49
1

Best to even use the `sourceSets.getByName('main').runtimeClasspath` – mkobit Jul 31 '18 at 15:17
anybody know what this would look like in kotlin (for the build.gradle,kts file) ? – user64141 Dec 16 '19 at 21:25

tim_yates · Accepted Answer · 2015-04-07T06:04:06.147

37

~~Have you tried the fatjar example in the gradle cookbook?~~

What you're looking for is the shadow plugin for gradle

edited Apr 07 '15 at 06:04

answered Jun 11 '12 at 19:29

tim_yates

167,322
27
342
338

Thank you for the pointer. It helped. Though I hit another issue which was solved by a bit of googling. I'll add another answer expanding on that. – missingfaktor Jun 11 '12 at 20:02
It looks like the cookbook now requires a login. As this is exactly what I am looking for, could you paste the recipe in here please? – oarsome Apr 07 '15 at 03:42
1

@tarzan three years later, and I'd now use the shadow plugin https://github.com/johnrengelman/shadow – tim_yates Apr 07 '15 at 06:03
this is very simple and worked the first time (after trying many other "answers": http://stackoverflow.com/questions/23738676/how-to-specify-main-class-when-using-fatjar-plugin-in-gradle-build – Hugo Zaragoza Apr 29 '15 at 21:56
Things change in 3 years. And I'd still use the shadow plugin ;-) – tim_yates Apr 29 '15 at 21:58
shadowjar isn't very well-maintained. See https://github.com/johnrengelman/shadow/issues/476 and other critical issues that have gone unfixed for months. – Gili Jun 27 '19 at 17:28

score 8 · Answer 3 · answered Nov 26 '16 at 04:45

8

Simply add this to your java module's build.gradle.

mainClassName = "my.main.Class"

jar {
  manifest { 
    attributes "Main-Class": "$mainClassName"
  }  

  from {
    configurations.compile.collect { it.isDirectory() ? it : zipTree(it) }
  }
}

This will result in [module_name]/build/libs/[module_name].jar file.

answered Nov 26 '16 at 04:45

Bao Le

16,643
9
65
68

but what is that code? What does configurations.compile.collect { it.isDirectory() ? it : zipTree(it) } do? – Sam Redway Apr 21 '17 at 20:41
1

@SamRedway `configurations.compile.collect` collects stuff from `compile` The ternary lets it pull in both folders and zip-files (like jars) as if they were also folders – pal Jul 03 '17 at 17:10
I haven't tried the other versions posted here, but this one works nicely and is nice and simple. – chris Jul 18 '17 at 15:52
This answer excludes any `runtime` or `runtimeOnly` declared dependencies, which will cause the application to break at runtime. – mkobit Jul 31 '18 at 15:16
1

@mkobit You can replace `compile` with `runtimeClasspath` as specified in [this answer](https://stackoverflow.com/questions/49278063/how-do-i-create-an-executable-fat-jar-with-gradle-with-implementation-dependenci/49284432#49284432). – Franklin Yu Mar 01 '19 at 14:58

boechat107 · Answer 4 · 2016-03-14T15:12:37.420

5

I found this project very useful. Using it as a reference, my Gradle uberjar task would be

task uberjar(type: Jar, dependsOn: [':compileJava', ':processResources']) {
    from files(sourceSets.main.output.classesDir)
    from configurations.runtime.asFileTree.files.collect { zipTree(it) }

    manifest {
        attributes 'Main-Class': 'SomeClass'
    }
}

edited Mar 14 '16 at 15:12

answered Sep 24 '14 at 16:34

boechat107

1,654
14
24

i get `Invalid signature file digest for Manifest main attributes` when i try this – Nicholas DiPiazza Aug 31 '17 at 16:01
you need `exclude "META-INF/*.SF"` `exclude "META-INF/*.DSA"` `exclude "META-INF/*.RSA"` like missingfaktor's answer – Nicholas DiPiazza Aug 31 '17 at 16:03
Does not seem to work with Gradle 5.3.1: "Could not get unknown property 'classesDir' for main classes of type org.gradle.api.internal.tasks.DefaultSourceSetOutput." – lathspell Apr 05 '19 at 22:47
it gives me java.lang.UnsupportedOperationException – aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa Mar 19 '20 at 09:49

Building an uberjar with Gradle

4 Answers4

Linked