Spring Boot Maven 插件使用

Alan

Alan

Maintainer of blog

Spring Boot Maven 插件提供了 Maven 对 Spring Boot 的支持, 让你能打包成jar或者war包,以及原地运行应用。使用该插件需要Maven版本大于等于3.2。

pom.xml文件添加插件#

pom.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.2.0.BUILD-SNAPSHOT</version>
<executions>
<execution>
<goals>
<goal>repackage</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>

使用 Spring Initializer 创建的应用默认添加到了spring boot项目。

添加插件后,可以使用以下命令生成jar包:

mvn package
ls target/*.jar # 生成后的jar包位于项目的target目录

我们也可以通过指定Maven goal repackage 来生成jar包:

mvn package spring-boot:repackage
ls target/*.jar # 生成后的jar包位于项目的target目录

打包可执行的Jar或War文件#

一旦 spring-boot-maven-plugin 被添加到 pom.xml,就可以使用goal spring-boot:repackage 生成可执行文件。可以通过pom.xml文件的packaging配置节告诉插件生成的是jar包还是war包.

生成后的jar包#

pom.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">
<!-- ... -->
<packaging>jar</packaging>
<!-- ... -->
</project>

生成war包#

生成一个可执行和部署的war不到外部容器(意思war包需要部署在tomcat这种容器下),需要把内嵌的容器依赖的scope改成 provided

pom.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">
<!-- ... -->
<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> <!-- 改成provided之后,tomcat 就不会打包进war文件 -->
</dependency>
<!-- ... -->
</dependencies>
</project>

更多war文件部署参考Spring Boot 2 Deploy WAR file to External Tomcat

Spring Boot Maven插件更多信息#

Maven gobals 概览#

Spring boot 插件提供了以下goal:

  • spring-boot:run 运行Spring boot应用
  • spring-boot:repackage 把应用打包成可执行的 jar/war 文件
  • spring-boot:startspring-boot:stop 管理Spring boot应用生命周期 (比如 集成测试).
  • spring-boot:build-info 生成可被Actuator使用的构建信息

使用#

比如 mvn spring-boot:run 运行Spring Boot应用。

更多信息参考https://docs.spring.io/spring-boot/docs/current/maven-plugin/usage.html

原文 - Use of Spring Boot Maven Plugin with Example