org.springframework.boot.maven.ArtifactsLibraries Maven / Gradle / Ivy
/*
* Copyright 2012-2023 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.maven;
import java.io.File;
import java.io.IOException;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.model.Dependency;
import org.apache.maven.plugin.logging.Log;
import org.apache.maven.project.MavenProject;
import org.springframework.boot.loader.tools.Libraries;
import org.springframework.boot.loader.tools.Library;
import org.springframework.boot.loader.tools.LibraryCallback;
import org.springframework.boot.loader.tools.LibraryCoordinates;
import org.springframework.boot.loader.tools.LibraryScope;
/**
* {@link Libraries} backed by Maven {@link Artifact}s.
*
* @author Phillip Webb
* @author Andy Wilkinson
* @author Stephane Nicoll
* @author Scott Frederick
* @since 1.0.0
*/
public class ArtifactsLibraries implements Libraries {
private static final Map SCOPES;
static {
Map libraryScopes = new HashMap<>();
libraryScopes.put(Artifact.SCOPE_COMPILE, LibraryScope.COMPILE);
libraryScopes.put(Artifact.SCOPE_RUNTIME, LibraryScope.RUNTIME);
libraryScopes.put(Artifact.SCOPE_PROVIDED, LibraryScope.PROVIDED);
libraryScopes.put(Artifact.SCOPE_SYSTEM, LibraryScope.PROVIDED);
SCOPES = Collections.unmodifiableMap(libraryScopes);
}
private final Set artifacts;
private final Set includedArtifacts;
private final Collection localProjects;
private final Collection unpacks;
private final Log log;
/**
* Creates a new {@code ArtifactsLibraries} from the given {@code artifacts}.
* @param artifacts the artifacts to represent as libraries
* @param localProjects projects for which {@link Library#isLocal() local} libraries
* should be created
* @param unpacks artifacts that should be unpacked on launch
* @param log the log
* @since 2.4.0
*/
public ArtifactsLibraries(Set artifacts, Collection localProjects,
Collection unpacks, Log log) {
this(artifacts, artifacts, localProjects, unpacks, log);
}
/**
* Creates a new {@code ArtifactsLibraries} from the given {@code artifacts}.
* @param artifacts all artifacts that can be represented as libraries
* @param includedArtifacts the actual artifacts to include in the uber jar
* @param localProjects projects for which {@link Library#isLocal() local} libraries
* should be created
* @param unpacks artifacts that should be unpacked on launch
* @param log the log
* @since 2.4.8
*/
public ArtifactsLibraries(Set artifacts, Set includedArtifacts,
Collection localProjects, Collection unpacks, Log log) {
this.artifacts = artifacts;
this.includedArtifacts = includedArtifacts;
this.localProjects = localProjects;
this.unpacks = unpacks;
this.log = log;
}
@Override
public void doWithLibraries(LibraryCallback callback) throws IOException {
Set duplicates = getDuplicates(this.artifacts);
for (Artifact artifact : this.artifacts) {
String name = getFileName(artifact);
File file = artifact.getFile();
LibraryScope scope = SCOPES.get(artifact.getScope());
if (scope == null || file == null) {
continue;
}
if (duplicates.contains(name)) {
this.log.debug("Duplicate found: " + name);
name = artifact.getGroupId() + "-" + name;
this.log.debug("Renamed to: " + name);
}
LibraryCoordinates coordinates = new ArtifactLibraryCoordinates(artifact);
boolean unpackRequired = isUnpackRequired(artifact);
boolean local = isLocal(artifact);
boolean included = this.includedArtifacts.contains(artifact);
callback.library(new Library(name, file, scope, coordinates, unpackRequired, local, included));
}
}
private Set getDuplicates(Set artifacts) {
Set duplicates = new HashSet<>();
Set seen = new HashSet<>();
for (Artifact artifact : artifacts) {
String fileName = getFileName(artifact);
if (artifact.getFile() != null && !seen.add(fileName)) {
duplicates.add(fileName);
}
}
return duplicates;
}
private boolean isUnpackRequired(Artifact artifact) {
if (this.unpacks != null) {
for (Dependency unpack : this.unpacks) {
if (artifact.getGroupId().equals(unpack.getGroupId())
&& artifact.getArtifactId().equals(unpack.getArtifactId())) {
return true;
}
}
}
return false;
}
private boolean isLocal(Artifact artifact) {
for (MavenProject localProject : this.localProjects) {
if (localProject.getArtifact().equals(artifact)) {
return true;
}
for (Artifact attachedArtifact : localProject.getAttachedArtifacts()) {
if (attachedArtifact.equals(artifact)) {
return true;
}
}
}
return false;
}
private String getFileName(Artifact artifact) {
StringBuilder sb = new StringBuilder();
sb.append(artifact.getArtifactId()).append("-").append(artifact.getBaseVersion());
String classifier = artifact.getClassifier();
if (classifier != null) {
sb.append("-").append(classifier);
}
sb.append(".").append(artifact.getArtifactHandler().getExtension());
return sb.toString();
}
/**
* {@link LibraryCoordinates} backed by a Maven {@link Artifact}.
*/
private static class ArtifactLibraryCoordinates implements LibraryCoordinates {
private final Artifact artifact;
ArtifactLibraryCoordinates(Artifact artifact) {
this.artifact = artifact;
}
@Override
public String getGroupId() {
return this.artifact.getGroupId();
}
@Override
public String getArtifactId() {
return this.artifact.getArtifactId();
}
@Override
public String getVersion() {
return this.artifact.getBaseVersion();
}
@Override
public String toString() {
return this.artifact.toString();
}
}
}