Awesome
Gradle FatJar Plugin
WARNING: This plugin is no longer under active development. Please, migrate to Gradle Shadow Plugin which provides similar functionality.
Gradle FatJar Plugin allows you to create JAR file with all dependencies bundled inside. It handles files in META-INF/services
directory gracefully by merging them. It also allows you to create slim WAR file which contains only JAR with dependencies.
Classes are also bundled into the JAR instead of putting them into WEB-INF/classes
.
Plugin is hosted on Bintray. You can easily add plugin to your build script using following configuration
Installation
buildscript {
repositories {
jcenter()
}
dependencies {
classpath 'eu.appsatori:gradle-fatjar-plugin:0.3'
}
}
apply plugin: 'eu.appsatori.fatjar'
Tasks
Note: regular
jar
andwar
tasks are not replaced by this plugin. You can still use them. Don't forget that you need to configurefatJar
andslimWar
tasks if you want to modify generated manifest or exclude files notjar
orwar
ones.
fatJarPrepareFiles
Explodes all JARs into the stage directory and merges all files needed such as those in META-INF/services
.
fatJar
Creates the JAR with all dependencies bundled.
This is regular Jar
task so you can e.g. customize the manifest as
described in Jar Task DSL.
You can for example exclude files from being jared.
fatJar {
exclude 'META-INF/*.DSA'
}
slimWar
Bundles all output classes into JAR with dependencies and place it into WEB-INF/lib
directory of the newly created
WAR file.
This is regular War
task so you can e.g. customize the web.xml
file as
described in War Task DSL.
You can for example exclude files which you don't want to copy into the final WAR.
slimWar {
exclude('WEB-INF/gtpl/', 'WEB-INF/groovy/')
}
Customization
File Merge
You can specify additional files to be merged using Ant-style pattern and include
method on fatJarPrepareFiles
task.
fatJarPrepareFiles {
include 'META-INF/spring.handlers'
include 'META-INF/spring.schemas'
}
Excluding files
You can specify files which should not be copied to fat jar using Ant-style pattern and exclude
method on fatJarPrepareFiles
task.
fatJarPrepareFiles {
exclude 'META-INF/my.properties'
}
Exclude JARs
If you need to keep some JARs out of the JAR with dependencies you can specify extended property fatJarExclude
on
particular dependency. All excluded JARs will be placed in WEB-INF\lib
directory if slimWar
task is called.
dependencies {
compile 'eu.appsatori:pipes:0.6.1', {
ext {
fatJarExclude = true
}
}
}
Create executable jar
Adapted from http://stackoverflow.com/questions/23738676/how-to-specify-main-class-when-using-fatjar-plugin-in-gradle-build
Replace
apply plugin: 'eu.appsatori.fatjar'
with
task fatJar(type: Jar) {
baseName = project.name + '-all'
from { configurations.compile.collect { it.isDirectory() ? it : zipTree(it) } }
with jar
manifest {
attributes 'Implementation-Title': 'Gradle Quickstart', 'Implementation-Version': version
attributes 'Main-Class': 'com.organization.project.package.mainClassName'
}
}