Merge branch '2.4.x' into 2.5.x

Closes gh-27056

Author: philwebb

spring-boot-project/spring-boot-cli/src/main/java/org/springframework/boot/cli/command/archive/ArchiveCommand.java

@@ -198,7 +198,7 @@ private List<Library> createLibraries(List<URL> dependencies) throws URISyntaxEx
 			List<Library> libraries = new ArrayList<>();
 			for (URL dependency : dependencies) {
 				File file = new File(dependency.toURI());
-				libraries.add(new Library(file, getLibraryScope(file)));
+				libraries.add(new Library(null, file, getLibraryScope(file), null, false, false, true));
 			}
 			return libraries;
 		}
@@ -256,7 +256,7 @@ private List<Library> addClasspathEntries(JarWriter writer, List<MatchedResource
 			List<Library> libraries = new ArrayList<>();
 			for (MatchedResource entry : entries) {
 				if (entry.isRoot()) {
-					libraries.add(new Library(entry.getFile(), LibraryScope.COMPILE));
+					libraries.add(new Library(null, entry.getFile(), LibraryScope.COMPILE, null, false, false, true));
 				}
 				else {
 					writeClasspathEntry(writer, entry);

spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/buildtoolplugins/otherbuildsystems/examplerepackageimplementation/MyBuildTool.java

@@ -37,7 +37,7 @@ public void build() throws IOException {
 	private void getLibraries(LibraryCallback callback) throws IOException {
 		// Build system specific implementation, callback for each dependency
 		for (File nestedJar : getCompileScopeJars()) {
-			callback.library(new Library(nestedJar, LibraryScope.COMPILE));
+			callback.library(new Library(null, nestedJar, LibraryScope.COMPILE, null, false, false, true));
 		}
 		// ...
 	}

spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/main/java/org/springframework/boot/gradle/tasks/bundling/LayerResolver.java

@@ -24,6 +24,7 @@
 import org.springframework.boot.gradle.tasks.bundling.ResolvedDependencies.DependencyDescriptor;
 import org.springframework.boot.loader.tools.Layer;
 import org.springframework.boot.loader.tools.Library;
+import org.springframework.boot.loader.tools.LibraryCoordinates;
 
 /**
  * Resolver backed by a {@link LayeredSpec} that provides the destination {@link Layer}
@@ -77,9 +78,12 @@ Iterable<Layer> getLayers() {
 	private Library asLibrary(FileCopyDetails details) {
 		File file = details.getFile();
 		DependencyDescriptor dependency = this.resolvedDependencies.find(file);
-		return (dependency != null)
-				? new Library(null, file, null, dependency.getCoordinates(), false, dependency.isProjectDependency())
-				: new Library(file, null);
+		if (dependency == null) {
+			return new Library(null, file, null, null, false, false, true);
+		}
+		LibraryCoordinates coordinates = dependency.getCoordinates();
+		boolean projectDependency = dependency.isProjectDependency();
+		return new Library(null, file, null, coordinates, false, projectDependency, true);
 	}
 
 }

spring-boot-project/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/AbstractJarWriter.java

@@ -30,7 +30,7 @@
 import java.util.Enumeration;
 import java.util.HashSet;
 import java.util.Set;
-import java.util.function.Predicate;
+import java.util.function.Function;
 import java.util.jar.JarEntry;
 import java.util.jar.JarFile;
 import java.util.jar.JarInputStream;
@@ -89,24 +89,33 @@ public void writeManifest(Manifest manifest) throws IOException {
 	 * Write all entries from the specified jar file.
 	 * @param jarFile the source jar file
 	 * @throws IOException if the entries cannot be written
+	 * @deprecated since 2.4.8 for removal in 2.6.0
 	 */
+	@Deprecated
 	public void writeEntries(JarFile jarFile) throws IOException {
-		writeEntries(jarFile, EntryTransformer.NONE, UnpackHandler.NEVER, (name) -> false);
+		writeEntries(jarFile, EntryTransformer.NONE, UnpackHandler.NEVER, (entry) -> null);
 	}
 
 	final void writeEntries(JarFile jarFile, EntryTransformer entryTransformer, UnpackHandler unpackHandler,
-			Predicate<String> libraryPredicate) throws IOException {
+			Function<JarEntry, Library> libraryLookup) throws IOException {
 		Enumeration<JarEntry> entries = jarFile.entries();
 		while (entries.hasMoreElements()) {
-			JarArchiveEntry entry = new JarArchiveEntry(entries.nextElement());
-			setUpEntry(jarFile, entry);
-			try (ZipHeaderPeekInputStream inputStream = new ZipHeaderPeekInputStream(jarFile.getInputStream(entry))) {
-				EntryWriter entryWriter = new InputStreamEntryWriter(inputStream);
-				JarArchiveEntry transformedEntry = entryTransformer.transform(entry);
-				if (transformedEntry != null) {
-					boolean updateLayerIndex = !libraryPredicate.test(entry.getName());
-					writeEntry(transformedEntry, entryWriter, unpackHandler, updateLayerIndex);
-				}
+			JarEntry entry = entries.nextElement();
+			Library library = libraryLookup.apply(entry);
+			if (library == null || library.isIncluded()) {
+				writeEntry(jarFile, entryTransformer, unpackHandler, new JarArchiveEntry(entry), library);
+			}
+		}
+	}
+
+	private void writeEntry(JarFile jarFile, EntryTransformer entryTransformer, UnpackHandler unpackHandler,
+			JarArchiveEntry entry, Library library) throws IOException {
+		setUpEntry(jarFile, entry);
+		try (ZipHeaderPeekInputStream inputStream = new ZipHeaderPeekInputStream(jarFile.getInputStream(entry))) {
+			EntryWriter entryWriter = new InputStreamEntryWriter(inputStream);
+			JarArchiveEntry transformedEntry = entryTransformer.transform(entry);
+			if (transformedEntry != null) {
+				writeEntry(transformedEntry, library, entryWriter, unpackHandler);
 			}
 		}
 	}
@@ -160,15 +169,7 @@ public void writeNestedLibrary(String location, Library library) throws IOExcept
 		entry.setTime(getNestedLibraryTime(library));
 		new CrcAndSize(library::openStream).setupStoredEntry(entry);
 		try (InputStream inputStream = library.openStream()) {
-			writeEntry(entry, new InputStreamEntryWriter(inputStream), new LibraryUnpackHandler(library), false);
-			updateLayerIndex(entry.getName(), library);
-		}
-	}
-
-	private void updateLayerIndex(String name, Library library) {
-		if (this.layers != null) {
-			Layer layer = this.layers.getLayer(library);
-			this.layersIndex.add(layer, name);
+			writeEntry(entry, library, new InputStreamEntryWriter(inputStream), new LibraryUnpackHandler(library));
 		}
 	}
 
@@ -249,20 +250,20 @@ private boolean isClassEntry(JarEntry entry) {
 	}
 
 	private void writeEntry(JarArchiveEntry entry, EntryWriter entryWriter) throws IOException {
-		writeEntry(entry, entryWriter, UnpackHandler.NEVER, true);
+		writeEntry(entry, null, entryWriter, UnpackHandler.NEVER);
 	}
 
 	/**
 	 * Perform the actual write of a {@link JarEntry}. All other write methods delegate to
 	 * this one.
 	 * @param entry the entry to write
+	 * @param library the library for the entry or {@code null}
 	 * @param entryWriter the entry writer or {@code null} if there is no content
 	 * @param unpackHandler handles possible unpacking for the entry
-	 * @param updateLayerIndex if the layer index should be updated
 	 * @throws IOException in case of I/O errors
 	 */
-	private void writeEntry(JarArchiveEntry entry, EntryWriter entryWriter, UnpackHandler unpackHandler,
-			boolean updateLayerIndex) throws IOException {
+	private void writeEntry(JarArchiveEntry entry, Library library, EntryWriter entryWriter,
+			UnpackHandler unpackHandler) throws IOException {
 		String name = entry.getName();
 		writeParentDirectoryEntries(name);
 		if (this.writtenEntries.add(name)) {
@@ -273,16 +274,14 @@ private void writeEntry(JarArchiveEntry entry, EntryWriter entryWriter, UnpackHa
 				entry.setSize(entryWriter.size());
 			}
 			entryWriter = addUnpackCommentIfNecessary(entry, entryWriter, unpackHandler);
-			if (updateLayerIndex) {
-				updateLayerIndex(entry);
-			}
+			updateLayerIndex(entry, library);
 			writeToArchive(entry, entryWriter);
 		}
 	}
 
-	private void updateLayerIndex(JarArchiveEntry entry) {
+	private void updateLayerIndex(JarArchiveEntry entry, Library library) {
 		if (this.layers != null && !entry.getName().endsWith("/")) {
-			Layer layer = this.layers.getLayer(entry.getName());
+			Layer layer = (library != null) ? this.layers.getLayer(library) : this.layers.getLayer(entry.getName());
 			this.layersIndex.add(layer, entry.getName());
 		}
 	}
@@ -294,7 +293,7 @@ private void writeParentDirectoryEntries(String name) throws IOException {
 		while (parent.lastIndexOf('/') != -1) {
 			parent = parent.substring(0, parent.lastIndexOf('/'));
 			if (!parent.isEmpty()) {
-				writeEntry(new JarArchiveEntry(parent + "/"), null, UnpackHandler.NEVER, false);
+				writeEntry(new JarArchiveEntry(parent + "/"), null, null, UnpackHandler.NEVER);
 			}
 		}
 	}

spring-boot-project/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/JarModeLibrary.java

@@ -42,7 +42,7 @@ public class JarModeLibrary extends Library {
 	}
 
 	public JarModeLibrary(LibraryCoordinates coordinates) {
-		super(getJarName(coordinates), null, LibraryScope.RUNTIME, coordinates, false);
+		super(getJarName(coordinates), null, LibraryScope.RUNTIME, coordinates, false, false, true);
 	}
 
 	private static LibraryCoordinates createCoordinates(String artifactId) {

spring-boot-project/spring-boot-tools/spring-boot-loader-tools/src/main/java/org/springframework/boot/loader/tools/Library.java

@@ -43,11 +43,16 @@ public class Library {
 
 	private final boolean local;
 
+	private final boolean included;
+
 	/**
 	 * Create a new {@link Library}.
 	 * @param file the source file
 	 * @param scope the scope of the library
+	 * @deprecated since 2.4.8 for removal in 2.6.0 in favor of
+	 * {@link #Library(String, File, LibraryScope, LibraryCoordinates, boolean, boolean, boolean)}
 	 */
+	@Deprecated
 	public Library(File file, LibraryScope scope) {
 		this(file, scope, false);
 	}
@@ -57,7 +62,10 @@ public Library(File file, LibraryScope scope) {
 	 * @param file the source file
 	 * @param scope the scope of the library
 	 * @param unpackRequired if the library needs to be unpacked before it can be used
+	 * @deprecated since 2.4.8 for removal in 2.6.0 in favor of
+	 * {@link #Library(String, File, LibraryScope, LibraryCoordinates, boolean, boolean, boolean)}
 	 */
+	@Deprecated
 	public Library(File file, LibraryScope scope, boolean unpackRequired) {
 		this(null, file, scope, unpackRequired);
 	}
@@ -69,7 +77,10 @@ public Library(File file, LibraryScope scope, boolean unpackRequired) {
 	 * @param file the source file
 	 * @param scope the scope of the library
 	 * @param unpackRequired if the library needs to be unpacked before it can be used
+	 * @deprecated since 2.4.8 for removal in 2.6.0 in favor of
+	 * {@link #Library(String, File, LibraryScope, LibraryCoordinates, boolean, boolean, boolean)}
 	 */
+	@Deprecated
 	public Library(String name, File file, LibraryScope scope, boolean unpackRequired) {
 		this(name, file, scope, null, unpackRequired);
 	}
@@ -82,7 +93,10 @@ public Library(String name, File file, LibraryScope scope, boolean unpackRequire
 	 * @param scope the scope of the library
 	 * @param coordinates the library coordinates or {@code null}
 	 * @param unpackRequired if the library needs to be unpacked before it can be used
+	 * @deprecated since 2.4.8 for removal in 2.6.0 in favor of
+	 * {@link #Library(String, File, LibraryScope, LibraryCoordinates, boolean, boolean, boolean)}
 	 */
+	@Deprecated
 	public Library(String name, File file, LibraryScope scope, LibraryCoordinates coordinates, boolean unpackRequired) {
 		this(name, file, scope, coordinates, unpackRequired, false);
 	}
@@ -98,15 +112,37 @@ public Library(String name, File file, LibraryScope scope, LibraryCoordinates co
 	 * @param local if the library is local (part of the same build) to the application
 	 * that is being packaged
 	 * @since 2.4.0
+	 * @deprecated since 2.4.8 for removal in 2.6.0 in favor of
+	 * {@link #Library(String, File, LibraryScope, LibraryCoordinates, boolean, boolean, boolean)}
 	 */
+	@Deprecated
 	public Library(String name, File file, LibraryScope scope, LibraryCoordinates coordinates, boolean unpackRequired,
 			boolean local) {
+		this(name, file, scope, coordinates, unpackRequired, local, true);
+	}
+
+	/**
+	 * Create a new {@link Library}.
+	 * @param name the name of the library as it should be written or {@code null} to use
+	 * the file name
+	 * @param file the source file
+	 * @param scope the scope of the library
+	 * @param coordinates the library coordinates or {@code null}
+	 * @param unpackRequired if the library needs to be unpacked before it can be used
+	 * @param local if the library is local (part of the same build) to the application
+	 * that is being packaged
+	 * @param included if the library is included in the fat jar
+	 * @since 2.4.8
+	 */
+	public Library(String name, File file, LibraryScope scope, LibraryCoordinates coordinates, boolean unpackRequired,
+			boolean local, boolean included) {
 		this.name = (name != null) ? name : file.getName();
 		this.file = file;
 		this.scope = scope;
 		this.coordinates = coordinates;
 		this.unpackRequired = unpackRequired;
 		this.local = local;
+		this.included = included;
 	}
 
 	/**
@@ -172,4 +208,12 @@ public boolean isLocal() {
 		return this.local;
 	}
 
+	/**
+	 * Return if the library is included in the fat jar.
+	 * @return if the library is included
+	 */
+	public boolean isIncluded() {
+		return this.included;
+	}
+
 }