66. Spring Boot Maven 插件
Spring Boot Maven 插件在 Maven 中提供了 Spring Boot 支持,使您可以打包可执行 jar 或 war 归档文件并“就地”运行应用程序。要使用它,您必须使用 Maven 3.2(或更高版本)。
Note
有关完整的插件文档,请参阅Spring Boot Maven 插件网站。
66.1 引入插件
要使用 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>1.5.9.RELEASE</version>
<executions>
<execution>
<goals>
<goal>repackage</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>
此配置将重新包装在 Maven 生命周期的package
阶段构建的 jar 或 war。下面的示例在target
目录中显示了重新打包的 jar 和原始 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>http://repo.spring.io/snapshot</url>
</pluginRepository>
<pluginRepository>
<id>spring-milestones</id>
<url>http://repo.spring.io/milestone</url>
</pluginRepository>
</pluginRepositories>
66.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
阶段增强您现有的存档。您可以使用配置选项来指定要启动的主类,也可以通过以常规方式向清单添加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 文件的更多详细信息,请参见“ 第 85.1 节“创建可部署的 war 文件””部分。
插件信息页面中提供了高级配置选项和示例。