-
Notifications
You must be signed in to change notification settings - Fork 40.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Exclude starter jars when running and packaging with Gradle
This commit updates the Gradle Plugin to filter dependencies based on the Spring-Boot-Jar-Type entry in their manifest. Jars with a Spring-Boot-Jar-Type of dependencies-starter are excluded. Unlike the Maven plugin, jars with a type of annotation-processor are not excluded. It is not necessary with Gradle as use of the annotationProcessor configuration for such dependencies already ensures that they are not included. See gh-22036
- Loading branch information
1 parent
e743d5f
commit 143d197
Showing
8 changed files
with
187 additions
and
3 deletions.
There are no files selected for viewing
52 changes: 52 additions & 0 deletions
52
...t-gradle-plugin/src/main/java/org/springframework/boot/gradle/plugin/JarTypeFileSpec.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
/* | ||
* Copyright 2012-2020 the original author or authors. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* https://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
package org.springframework.boot.gradle.plugin; | ||
|
||
import java.io.File; | ||
import java.util.Collections; | ||
import java.util.Set; | ||
import java.util.jar.JarFile; | ||
|
||
import org.gradle.api.file.FileCollection; | ||
import org.gradle.api.specs.Spec; | ||
|
||
/** | ||
* A {@link Spec} for {@link FileCollection#filter(Spec) filtering} {@code FileCollection} | ||
* to remove jar files based on their {@code Spring-Boot-Jar-Type} as defined in the | ||
* manifest. Jars of type {@code dependencies-starter} are excluded. | ||
* | ||
* @author Andy Wilkinson | ||
*/ | ||
class JarTypeFileSpec implements Spec<File> { | ||
|
||
private static final Set<String> EXCLUDED_JAR_TYPES = Collections.singleton("dependencies-starter"); | ||
|
||
@Override | ||
public boolean isSatisfiedBy(File file) { | ||
try (JarFile jar = new JarFile(file)) { | ||
String jarType = jar.getManifest().getMainAttributes().getValue("Spring-Boot-Jar-Type"); | ||
if (jarType != null && EXCLUDED_JAR_TYPES.contains(jarType)) { | ||
return false; | ||
} | ||
} | ||
catch (Exception ex) { | ||
// Continue | ||
} | ||
return true; | ||
} | ||
|
||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
25 changes: 25 additions & 0 deletions
25
...ework/boot/gradle/tasks/bundling/BootJarIntegrationTests-jarTypeFilteringIsApplied.gradle
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
plugins { | ||
id 'java' | ||
id 'org.springframework.boot' version '{version}' | ||
} | ||
|
||
bootJar { | ||
mainClassName = 'com.example.Application' | ||
} | ||
|
||
repositories { | ||
flatDir { | ||
dirs 'repository' | ||
} | ||
} | ||
|
||
dependencies { | ||
implementation(name: "standard") | ||
implementation(name: "starter") | ||
} | ||
|
||
bootJar { | ||
layered { | ||
enabled = false | ||
} | ||
} |
19 changes: 19 additions & 0 deletions
19
...ework/boot/gradle/tasks/bundling/BootWarIntegrationTests-jarTypeFilteringIsApplied.gradle
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
plugins { | ||
id 'war' | ||
id 'org.springframework.boot' version '{version}' | ||
} | ||
|
||
bootWar { | ||
mainClassName = 'com.example.Application' | ||
} | ||
|
||
repositories { | ||
flatDir { | ||
dirs 'repository' | ||
} | ||
} | ||
|
||
dependencies { | ||
implementation(name: "standard") | ||
implementation(name: "starter") | ||
} |
15 changes: 15 additions & 0 deletions
15
...t/gradle/tasks/run/BootRunIntegrationTests-jarTypeFilteringIsAppliedToTheClasspath.gradle
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
plugins { | ||
id 'java' | ||
id 'org.springframework.boot' version '{version}' | ||
} | ||
|
||
repositories { | ||
flatDir { | ||
dirs 'repository' | ||
} | ||
} | ||
|
||
dependencies { | ||
implementation(name: "standard") | ||
implementation(name: "starter") | ||
} |