章节 VIII. 构建工具插件

要使用 Spring Boot Maven 插件，请在 pom.xml 的 plugins 部分中包含适当的 XML，如下面的示例所示：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<!-- ... -->
	<build>
		<plugins>
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
				<version>2.1.0.BUILD-SNAPSHOT</version>
				<executions>
					<execution>
						<goals>
							<goal>repackage</goal>
						</goals>
					</execution>
				</executions>
			</plugin>
		</plugins>
	</build>
</project>

前面的配置重新包装了在 Maven 生命周期的 package 阶段期间构建的 jar 或 war。下面的示例既展示了重新打包的 jar，也展示了 target 目录中的原始jar：

$ mvn package
$ ls target/*.jar
target/myproject-1.0.0.jar target/myproject-1.0.0.jar.original

如果不包含 <execution/> 配置，如前面的示例所示，你可以自己运行插件（但只有在使用打包目标的情况下），如下面的示例所示：

$ mvn package spring-boot:repackage
$ ls target/*.jar
target/myproject-1.0.0.jar target/myproject-1.0.0.jar.original

如果使用里程碑或快照版本，还需要添加适当的 pluginRepository 元素，如下面的清单所示：

<pluginRepositories>
	<pluginRepository>
		<id>spring-snapshots</id>
		<url>https://repo.spring.io/snapshot</url>
	</pluginRepository>
	<pluginRepository>
		<id>spring-milestones</id>
		<url>https://repo.spring.io/milestone</url>
	</pluginRepository>
</pluginRepositories>

一旦 spring-boot-maven-plugin 被包含在 pom.xml 中，它就会自动尝试重写归档文件，以使它们能够通过使用 spring-boot:repackage 目标来执行。你应该使用通常的 packaging 元素来配置项目来构建（适当地）jar 或 war，如下面的示例所示：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
	<!-- ... -->
	<packaging>jar</packaging>
	<!-- ... -->
</project>

在打包阶段，Spring Boot 增强了现有的存档。要启动的主类可以通过使用配置选项或通过以通常的方式向清单添加 Main-Class 属性来指定。如果未指定主类，则插件搜索具有 public static void main(String[] args) 方法的类。

若要生成并运行项目存档，可以键入以下内容：

$ mvn package
$ java -jar target/mymodule-0.0.1-SNAPSHOT.jar

为了构建既可执行又可部署到外部容器中的 war 文件，需要将嵌入式容器依赖项标记为 “provided”，如下例所示：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
	<!-- ... -->
	<packaging>war</packaging>
	<!-- ... -->
	<dependencies>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-tomcat</artifactId>
			<scope>provided</scope>
		</dependency>
		<!-- ... -->
	</dependencies>
</project>

	Tip
	请参阅 “小节 89.1, “创建可部署的 war 文件”” 部分，以了解如何创建可部署的 war 文件的更多细节。

高级配置选项和示例可在插件信息页中找到。

一旦声明了 spring-boot-antlib 命名空间，就有下列附加任务：

<spring-boot:exejar destfile="target/my-application.jar"
		classes="target/classes" start-class="com.example.MyApplication">
	<resources>
		<fileset dir="src/main/resources" />
	</resources>
	<lib>
		<fileset dir="lib" />
	</lib>
</spring-boot:exejar>

<exejar destfile="target/my-application.jar" classes="target/classes">
	<lib>
		<fileset dir="lib" />
	</lib>
</exejar>

exejar 内部使用 findmainclass 任务来定位声明 main 的类。如果需要，你也可以直接在你的构建中使用此任务。支持以下属性：

<findmainclass classesroot="target/classes" />

<findmainclass classesroot="target/classes" property="main-class" />

<findmainclass mainclass="com.example.MainClass" property="main-class" />

要重新打包现有存档，使其成为自包含的可执行存档，请使用 org.springframework.boot.loader.tools.Repackager。Repackager 类采用单个构造函数参数，引用现有的 jar 或 war 存档。使用两个可用的 repackage() 方法中的一个来替换原始文件或写入新的目的地。在运行之前，还可以在重新打包器上配置各种设置。

在重新打包归档时，可以使用 org.springframework.boot.loader.tools.Libraries 接口来包含参考的依赖文件。在这里，我们不提供任何具体的 Libraries 实现，因为它们通常是构建系统特定的。

如果你的归档已经包含了库，你可以使用 Libraries.NONE。

如果不使用 Repackager.setMainClass() 指定主类，则重新打包器使用 ASM 读取类文件，并尝试使用 public static void main(String[] args) 方法找到合适的类。如果发现一个以上的候选，则引发异常。

下面的示例显示了一个典型的重新打包实现：

Repackager repackager = new Repackager(sourceJarFile);
repackager.setBackupSource(false);
repackager.repackage(new Libraries() {
			@Override
			public void doWithLibraries(LibraryCallback callback) throws IOException {
				// Build system specific implementation, callback for each dependency
				// callback.library(new Library(nestedFile, LibraryScope.COMPILE));
			}
		});