Exclude a specific dependency from springBoots `bootJar` gradle task

Question

I need to exclude a specific dependency from springBoots bootJar gradle task (similar to the provided scope in maven).

I tried a custom configuration, but the dependency-which-should-not-be-in-bootJar is still included in the resulting jar.

configurations{
    provided
    implementation.extendsFrom provided
}

dependencies {
    // ...
    provided "dependency-which-should-not-be-in-bootJar"
}

jar {
    from configurations.compile - configurations.provided
    from configurations.runtime
}

bootJar {
    from configurations.compile - configurations.provided
    from configurations.runtime
    launchScript()
}

Woodshed

bootJar includes the runtime classpath by default. It inherits from implementation which you've configured to extend from provided As a result, the runtime classpath includes your provided dependency so it's include in the fat jar. – Serrato

I also tried to change my provided to providedRuntime and let it extend from runtime after that I tried to configure the bootJar to override the runtime include with from configurations.runtime - configurations.providedRuntime which I thought should work but it doesn't. Can you point me to the right direction how to exclude a dependency properly from being packaged with the jar. – Woodshed

Answer 1

You can actually use compileOnly for your dependency with gradle > 2.12

dependencies {
     // ...
     compileOnly "dependency-which-should-not-be-in-bootJar"
}

You will still have it for test + runtime, but not in the final built jar.

Polito

In my case I also had to add testRuntime but otherwise it worked perfectly thx. – Woodshed

Answer 2

I also got an answer from Andy Wilkinson in the spring boot gitter channel which works slightly different but manages to achieve similar.

configurations {
    custom
    runtime.extendsFrom custom
}

dependencies {
    compile 'org.springframework.boot:spring-boot-starter-web'
    custom 'com.h2database:h2'
}

bootJar {
    exclude {
        configurations.custom.resolvedConfiguration.files.contains(it.file)
    }
}

Thank you Andy =)

Woodshed

It doesn't work for classpath folders: resolvedConfiguration.files still contains the folder java.io.File itself while it.file is a child of that folder – Jobey

This worked for me: configurations.custom.resolvedConfiguration.files.find { customEntry -> it.file.toPath().startsWith(customEntry.toPath()) } != null – Jobey