org.springframework.boot.maven.RepackageMojo Maven / Gradle / Ivy
/*
* Copyright 2012-2024 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.nio.file.attribute.FileTime;
import java.util.List;
import java.util.Properties;
import java.util.regex.Pattern;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.model.Dependency;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.plugins.annotations.ResolutionScope;
import org.springframework.boot.loader.tools.DefaultLaunchScript;
import org.springframework.boot.loader.tools.LaunchScript;
import org.springframework.boot.loader.tools.LayoutFactory;
import org.springframework.boot.loader.tools.Libraries;
import org.springframework.boot.loader.tools.LoaderImplementation;
import org.springframework.boot.loader.tools.Repackager;
import org.springframework.util.StringUtils;
/**
* Repackage existing JAR and WAR archives so that they can be executed from the command
* line using {@literal java -jar}. With layout=NONE can also be used simply
* to package a JAR with nested dependencies (and no main class, so not executable).
*
* @author Phillip Webb
* @author Dave Syer
* @author Stephane Nicoll
* @author Björn Lindström
* @author Scott Frederick
* @since 1.0.0
*/
@Mojo(name = "repackage", defaultPhase = LifecyclePhase.PACKAGE, requiresProject = true, threadSafe = true,
requiresDependencyResolution = ResolutionScope.COMPILE_PLUS_RUNTIME,
requiresDependencyCollection = ResolutionScope.COMPILE_PLUS_RUNTIME)
public class RepackageMojo extends AbstractPackagerMojo {
private static final Pattern WHITE_SPACE_PATTERN = Pattern.compile("\\s+");
/**
* Directory containing the generated archive.
* @since 1.0.0
*/
@Parameter(defaultValue = "${project.build.directory}", required = true)
private File outputDirectory;
/**
* Name of the generated archive.
* @since 1.0.0
*/
@Parameter(defaultValue = "${project.build.finalName}", readonly = true)
private String finalName;
/**
* Skip the execution.
* @since 1.2.0
*/
@Parameter(property = "spring-boot.repackage.skip", defaultValue = "false")
private boolean skip;
/**
* Classifier to add to the repackaged archive. If not given, the main artifact will
* be replaced by the repackaged archive. If given, the classifier will also be used
* to determine the source archive to repackage: if an artifact with that classifier
* already exists, it will be used as source and replaced. If no such artifact exists,
* the main artifact will be used as source and the repackaged archive will be
* attached as a supplemental artifact with that classifier. Attaching the artifact
* allows to deploy it alongside to the original one, see the Maven documentation for more details.
* @since 1.0.0
*/
@Parameter
private String classifier;
/**
* Attach the repackaged archive to be installed into your local Maven repository or
* deployed to a remote repository. If no classifier has been configured, it will
* replace the normal jar. If a {@code classifier} has been configured such that the
* normal jar and the repackaged jar are different, it will be attached alongside the
* normal jar. When the property is set to {@code false}, the repackaged archive will
* not be installed or deployed.
* @since 1.4.0
*/
@Parameter(defaultValue = "true")
private boolean attach = true;
/**
* A list of the libraries that must be unpacked from uber jars in order to run.
* Specify each library as a {@code } with a {@code } and a
* {@code } and they will be unpacked at runtime.
* @since 1.1.0
*/
@Parameter
private List requiresUnpack;
/**
* Make a fully executable jar for *nix machines by prepending a launch script to the
* jar.
*
* Currently, some tools do not accept this format so you may not always be able to
* use this technique. For example, {@code jar -xf} may silently fail to extract a jar
* or war that has been made fully-executable. It is recommended that you only enable
* this option if you intend to execute it directly, rather than running it with
* {@code java -jar} or deploying it to a servlet container.
* @since 1.3.0
*/
@Parameter(defaultValue = "false")
private boolean executable;
/**
* The embedded launch script to prepend to the front of the jar if it is fully
* executable. If not specified the 'Spring Boot' default script will be used.
* @since 1.3.0
*/
@Parameter
private File embeddedLaunchScript;
/**
* Properties that should be expanded in the embedded launch script.
* @since 1.3.0
*/
@Parameter
private Properties embeddedLaunchScriptProperties;
/**
* Timestamp for reproducible output archive entries, either formatted as ISO 8601
* (yyyy-MM-dd'T'HH:mm:ssXXX) or an {@code int} representing seconds
* since the epoch.
* @since 2.3.0
*/
@Parameter(defaultValue = "${project.build.outputTimestamp}")
private String outputTimestamp;
/**
* The type of archive (which corresponds to how the dependencies are laid out inside
* it). Possible values are {@code JAR}, {@code WAR}, {@code ZIP}, {@code DIR},
* {@code NONE}. Defaults to a guess based on the archive type.
* @since 1.0.0
*/
@Parameter(property = "spring-boot.repackage.layout")
private LayoutType layout;
/**
* The loader implementation that should be used.
* @since 3.2.0
*/
@Parameter
private LoaderImplementation loaderImplementation;
/**
* The layout factory that will be used to create the executable archive if no
* explicit layout is set. Alternative layouts implementations can be provided by 3rd
* parties.
* @since 1.5.0
*/
@Parameter
private LayoutFactory layoutFactory;
/**
* Return the type of archive that should be packaged by this MOJO.
* @return the value of the {@code layout} parameter, or {@code null} if the parameter
* is not provided
*/
@Override
protected LayoutType getLayout() {
return this.layout;
}
@Override
protected LoaderImplementation getLoaderImplementation() {
return this.loaderImplementation;
}
/**
* Return the layout factory that will be used to determine the
* {@link AbstractPackagerMojo.LayoutType} if no explicit layout is set.
* @return the value of the {@code layoutFactory} parameter, or {@code null} if the
* parameter is not provided
*/
@Override
protected LayoutFactory getLayoutFactory() {
return this.layoutFactory;
}
@Override
public void execute() throws MojoExecutionException, MojoFailureException {
if (this.project.getPackaging().equals("pom")) {
getLog().debug("repackage goal could not be applied to pom project.");
return;
}
if (this.skip) {
getLog().debug("skipping repackaging as per configuration.");
return;
}
repackage();
}
private void repackage() throws MojoExecutionException {
Artifact source = getSourceArtifact(this.classifier);
File target = getTargetFile(this.finalName, this.classifier, this.outputDirectory);
Repackager repackager = getRepackager(source.getFile());
Libraries libraries = getLibraries(this.requiresUnpack);
try {
LaunchScript launchScript = getLaunchScript();
repackager.repackage(target, libraries, launchScript, parseOutputTimestamp());
}
catch (IOException ex) {
throw new MojoExecutionException(ex.getMessage(), ex);
}
updateArtifact(source, target, repackager.getBackupFile());
}
private FileTime parseOutputTimestamp() throws MojoExecutionException {
try {
return new MavenBuildOutputTimestamp(this.outputTimestamp).toFileTime();
}
catch (IllegalArgumentException ex) {
throw new MojoExecutionException("Invalid value for parameter 'outputTimestamp'", ex);
}
}
private Repackager getRepackager(File source) {
return getConfiguredPackager(() -> new Repackager(source));
}
private LaunchScript getLaunchScript() throws IOException {
if (this.executable || this.embeddedLaunchScript != null) {
return new DefaultLaunchScript(this.embeddedLaunchScript, buildLaunchScriptProperties());
}
return null;
}
private Properties buildLaunchScriptProperties() {
Properties properties = new Properties();
if (this.embeddedLaunchScriptProperties != null) {
properties.putAll(this.embeddedLaunchScriptProperties);
}
putIfMissing(properties, "initInfoProvides", this.project.getArtifactId());
putIfMissing(properties, "initInfoShortDescription", this.project.getName(), this.project.getArtifactId());
putIfMissing(properties, "initInfoDescription", removeLineBreaks(this.project.getDescription()),
this.project.getName(), this.project.getArtifactId());
return properties;
}
private String removeLineBreaks(String description) {
return (description != null) ? WHITE_SPACE_PATTERN.matcher(description).replaceAll(" ") : null;
}
private void putIfMissing(Properties properties, String key, String... valueCandidates) {
if (!properties.containsKey(key)) {
for (String candidate : valueCandidates) {
if (StringUtils.hasLength(candidate)) {
properties.put(key, candidate);
return;
}
}
}
}
private void updateArtifact(Artifact source, File target, File original) {
if (this.attach) {
attachArtifact(source, target, original);
}
else if (source.getFile().equals(target) && original.exists()) {
String artifactId = (this.classifier != null) ? "artifact with classifier " + this.classifier
: "main artifact";
getLog().info(String.format("Updating %s %s to %s", artifactId, source.getFile(), original));
source.setFile(original);
}
else if (this.classifier != null) {
getLog().info("Creating repackaged archive " + target + " with classifier " + this.classifier);
}
}
private void attachArtifact(Artifact source, File target, File original) {
if (this.classifier != null && !source.getFile().equals(target)) {
getLog().info("Attaching repackaged archive " + target + " with classifier " + this.classifier);
this.projectHelper.attachArtifact(this.project, this.project.getPackaging(), this.classifier, target);
}
else {
String artifactId = (this.classifier != null) ? "artifact with classifier " + this.classifier
: "main artifact";
getLog()
.info(String.format("Replacing %s %s with repackaged archive, adding nested dependencies in BOOT-INF/.",
artifactId, source.getFile()));
getLog().info("The original artifact has been renamed to " + original);
source.setFile(target);
}
}
}