spring-boot-maven-plugin插件使用及说明

 更新时间:2026年06月26日 08:35:55   作者:小猪吃老虎  
SpringBoot项目自带spring-boot-maven-plugin插件,实现依赖自动入并生成可执行jar包;介绍插件标签及goals详解;常见使用场景包括排除provided类型依赖、指定Main类及生成普通jar包方法

一、 为什么Spring Boot项目自带这个插件

当我们在SpringBoot官方下载一个脚手架时,会发现pom.xml会自带spring-boot-maven-plugin插件

那为什么会自带这个插件呢?

我们知道Spring Boot项目,是可以通过java -jar 包名启动的

打包命令

mvn clean package

打包成功后就会生成一个jar包

试下是否可以通过java -jar 包名启动项目

发现是可以正常启动。

这个时候我们去掉spring-boot-maven-plugin插件,通过 mvn clean package 再打一次包。

打包依然成功,包名也一样,只是jar包大小有着天壤之别

发现只有3KB,之前的有17.7MB。

我们通过java -jar 包名看能否启动成功。

localhost:target xub$ java -jar maven-plugin-0.0.1-SNAPSHOT.jar maven-plugin-0.0.1-SNAPSHOT.jar中没有主清单属性

发现并不能启动成功,这是为什么呢?

一般的maven项目的打包命令,不会把依赖的jar包也打包进去的,只是会放在jar包的同目录下,能够引用就可以了。

但是spring-boot-maven-plugin插件,会将依赖的jar包全部打包进去。该文件包含了所有的依赖和资源文件,可以直接在命令行或者传统的 Java Web 服务器上启动运行。

二、插件介绍

1、插件标签详解

<!--使用的插件列表 。 -->
<plugins>
<!--plugin元素包含描述插件所需要的信息。 -->
<plugin>
	<!--插件在仓库里的group ID -->
	<groupId />
	<!--插件在仓库里的artifact ID -->
	<artifactId />
	<!--被使用的插件的版本(或版本范围) -->
	<version />
	<!--是否从该插件下载Maven扩展(例如打包和类型处理器),由于性能原因,只有在真需要下载时,该元素才被设置成enabled。 -->
	<extensions />
	<!--在构建生命周期中执行一组目标的配置。每个目标可能有不同的配置。 -->
	<executions>
		<!--execution元素包含了插件执行需要的信息 -->
		<execution>
			<!--执行目标的标识符,用于标识构建过程中的目标,或者匹配继承过程中需要合并的执行目标 -->
			<id />
			<!--绑定了目标的构建生命周期阶段,如果省略,目标会被绑定到源数据里配置的默认阶段 -->
			<phase />
			<!--配置的执行目标 -->
			<goals />
			<!--配置是否被传播到子POM -->
			<inherited />
			<!--作为DOM对象的配置 -->
			<configuration />
		</execution>
	</executions>
	<!--项目引入插件所需要的额外依赖 -->
	<dependencies>
		<!--参见dependencies/dependency元素 -->
		<dependency>
			......
		</dependency>
	</dependencies>
	<!--任何配置是否被传播到子项目 -->
	<inherited />
	<!--作为DOM对象的配置 -->
	<configuration />
</plugin>
</plugins>

2、内部goals

该插件提供了7个maven goal

  • build-image: 将程序使用 buildpack 打包进容器镜像中。
  • build-info:生成项目的构建信息文件 build-info.properties
  • help:显示帮助信息。调用mvn spring-boot:help -Ddetail=true -Dgoal=以显示参数详细信息。
  • repackage:可生成可执行的jar包或war包。插件的核心goal。
  • run:运行 Spring Boot 应用
  • start:在集成测试阶段,控制生命周期
  • stop:在集成测试阶段,控制生命周期

为什么这里插件名称叫spring-boot?

原因:自定义插件如果遵循 xxx-maven-plugin 的形式,maven 默认会将 maven-plugin 前面的内容作为插件前缀。

三、该插件常见使用场景

1、排除provided类型的依赖

默认情况下,repackage命令所生成的包,会把项目中所有的依赖都打进去。

但其实在项目中scope为provided的依赖,比如 lombok、mybatis-plus等,只作用于编译阶段,编译完成就没用了。

若除去provided依赖,可以使用如下的配置:

<plugin>
	<groupId>org.springframework.boot</groupId>
	<artifactId>
		spring-boot-maven-plugin
	</artifactId>
	<configuration>
		<excludes>
			<exclude>
				<groupId>org.projectlombok</groupId>
				<artifactId>lombok</artifactId>
			</exclude>
		</excludes>
	</configuration>
</plugin>

2、指定Mainclass类

如果未指定,main将使用找到的第一个包含方法的编译类。

也就是说如果只有一个main方法,那不需要去指定,如果你这个模块存在两个主类,那么就需要在插件中指定具体哪个启动类了。

<plugin>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-maven-plugin</artifactId>
       <configuration>
                <mainClass>com.can.mavenplugin.MavenPluginApplication</mainClass>
                <layout>ZIP</layout>
        </configuration>
</plugin>

layout 属性用来指定打成 jar 还是war 文件,可用的值包括:ZIP 、JAR 、WAR、 NONE 。默认JAR

3、在使用spring-boot-maven-plugin的下生成普通的jar包

前面说了,如果使用该插件,那么打出来的包是一个可执行的jar包,这样的jar包,在被别的项目引用的时候,可能会出问题。

那如何打成一个普通的jar包。

当然你可以把这个插件注释掉,重新打包。不过这样做未必太愚蠢啦。

解决办法

  • 第一种:通过命令
mvn clean package -D spring-boot.repackage.skip=true

加上-Dspring-boot.repackage.skip=true参数即可,此时只会生成一个普通的jar包

  • 第二种:通过配置
<plugin>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-maven-plugin</artifactId>
	<configuration>
		<skip>true</skip>
	</configuration>
</plugin>

这两种方式打出来的包就是没有依赖jar的普通包了。

总结

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • 详解Kotlin:forEach也能break和continue

    详解Kotlin:forEach也能break和continue

    这篇文章主要介绍了详解Kotlin:forEach也能break和continue的相关资料,需要的朋友可以参考下
    2017-06-06
  • java通过snmp协议获取物理设备信息

    java通过snmp协议获取物理设备信息

    这篇文章主要介绍了java通过snmp协议获取物理设备信息,snmp中文含义是简单网络管理协议,可用完成对计算机、路由器和其他网络设备的远程管理和监视,本文我们是通过java程序来获取,需要的朋友可以参考下
    2023-07-07
  • Java中的垃圾收集器详解

    Java中的垃圾收集器详解

    这篇文章主要介绍了Java中的垃圾收集器详解,垃圾收集机制是 Java 的招牌能力,极大地提高了开发效率,如今垃圾收集几乎成为现代语言的标配,需要的朋友可以参考下
    2023-07-07
  • Java日常练习题,每天进步一点点(58)

    Java日常练习题,每天进步一点点(58)

    下面小编就为大家带来一篇Java基础的几道练习题(分享)。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧,希望可以帮到你
    2021-08-08
  • Java猴子吃桃问题

    Java猴子吃桃问题

    这篇文章主要介绍了Java猴子吃桃问题,采取逆向思维的方法,从后往前推断,需要的朋友可以参考下
    2017-02-02
  • Java实现QQ第三方登录的示例代码

    Java实现QQ第三方登录的示例代码

    这篇文章主要介绍了Java实现QQ第三方登录的示例代码,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-11-11
  • java request.getHeader(

    java request.getHeader("user-agent")获取浏览器信息的方法

    这篇文章主要介绍了java request.getHeader("user-agent")获取浏览器信息的方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-03-03
  • 基于Java实现图形验证码工具类

    基于Java实现图形验证码工具类

    这篇文章主要为大家详细介绍了如何基于Java实现图形验证码工具类,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下
    2024-11-11
  • Java四大常用JSON解析工具性能对比(Hutool、Fastjson2、Gson与Jackson)

    Java四大常用JSON解析工具性能对比(Hutool、Fastjson2、Gson与Jackson)

    JSON 是现代软件开发中常用的数据交换格式,尤其在微服务和前后端分离的架构中更是必不可少,本文将对 Java 中四大主流 JSON 解析库进行性能测试和对比分析,希望对大家有所帮助
    2025-05-05
  • java  中MyBatis注解映射的实例详解

    java 中MyBatis注解映射的实例详解

    这篇文章主要介绍了java 中MyBatis注解映射的实例详解的相关资料,这里提供实例帮助大家理解这部分内容,需要的朋友可以参考下
    2017-09-09

最新评论