SpringBoot（27） - SpringBoot Maven插件（1） - 插件简介及打包

参考：https://docs.spring.io/spring-boot/docs/1.5.17.RELEASE/reference/htmlsingle/#build-tool-plugins-maven-plugin

SpringBoot Maven插件：https://docs.spring.io/spring-boot/docs/1.5.17.RELEASE/maven-plugin/

 

SpringBoot Maven插件

SpringBoot Maven插件在Maven中提供了对SpringBoot的支持，允许打包可执行jar或war并直接运行应用程序。 要使用它，需要使用Maven 3.2（或更新的版本）。参考SpringBoot Maven插件网站获取更多文档。

1. 插件

（1）插件目标：

目标	描述
spring-boot:build-info	根据当前MavenProject的内容生成build-info.properties文件。
spring-boot:help	显示有关spring-boot-maven-plugin的帮助信息。调用mvn spring-boot:help -Ddetail=true -Dgoal=<goal-name>显示参数详细信息。
spring-boot:repackage	重新打包现有的JAR和WAR归档，以便可以使用java -jar从命令行执行它们。 使用layout=NONE也可以简单地用于打包具有嵌套依赖项的JAR（没有主类，因此不可执行）。
spring-boot:run	运行可执行归档应用程序
spring-boot:start	启动spring应用程序。 与'run'目标相反，这不会阻止并允许其他目标在应用程序上运行。 此目标通常用于集成测试场景，其中应用程序在测试套件之前启动并在之后停止。
spring-boot:stop	停止已由“start”目标启动的spring应用程序。 通常在测试套件完成后调用。

（2）示例

具体可以参考插件官网的示例。

 

2. 添加插件

要使用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.17.RELEASE</version>
                <executions>
                    <execution>
                        <goals>
                            <!-- repackage目标 -->
                            <goal>repackage</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
</project>

此配置将重新打包在Maven生命周期的打包阶段构建的jar或war。 以下示例显示目标目录中的重新打包的jar以及原始jar：

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

如果不包含上述<execution />配置，则可以单独运行插件（但仅在使用package目标时）。 例如：

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

 

3. 打包成可执行jar或war文件

只要在pom.xml中添加了spring-boot-maven-plugin，将自动尝试使用spring-boot:repackage目标重写存档以使它们可执行。 使用通常的打包元素将项目配置为构建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>