71. Spring Boot Maven 插件

Spring Boot Maven 插件在 Maven 中提供 Spring Boot 支持,使您可以打包可执行 jar 或 war 归档文件并“就地”运行应用程序。要使用它,必须使用 Maven 3.2(或更高版本)。

Note

有关完整的插件文档,请参见Spring Boot Maven 插件网站

71.1 包含插件

要使用 Spring Boot Maven 插件,请在pom.xmlplugins部分中包含适当的 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.1.RELEASE</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元素,如以下 Lists 所示:

<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>

71.2 包装可执行的 Jar 和 War 文件

spring-boot-maven-plugin包含在pom.xml中后,它会自动尝试重写 Files,以使 Files 可以通过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 在package阶段会增强您现有的存档。可以通过使用配置选项或通过以常规方式向 Lists 添加Main-Class属性来指定要启动的主类。如果未指定主类,则插件将使用public static void main(String[] args)方法搜索一个类。

要构建和运行项目工件,可以键入以下内容:

$ mvn package
$ java -jar target/mymodule-0.0.1-SNAPSHOT.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>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

有关如何创建可部署的 war 文件的更多详细信息,请参见“ 第 92.1 节“创建可部署的 War 文件””部分。

插件信息页面中提供了高级配置选项和示例。