您的位置:首页>栏目首页 > 报告 >

天天热资讯!spring-boot-maven-plugin插件详解

2023-06-25 07:36:22    来源:博客园
一、 为什么Spring Boot项目自带这个插件

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

4.0.0org.springframework.bootspring-boot-starter-parent2.7.12com.zhuangpomaven-plugin0.0.1-SNAPSHOTmaven-plugin1.8org.springframework.bootspring-boot-starterorg.springframework.bootspring-boot-starter-weborg.springframework.bootspring-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、插件标签详解
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ......                                                                                                                                                        
2、内部goals

该插件提供了7个maven goal

build-image: 将程序使用 buildpack 打包进容器镜像中。build-info:生成项目的构建信息文件 build-info.propertieshelp:显示帮助信息。调用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依赖,可以使用如下的配置:

org.springframework.bootspring-boot-maven-plugin   org.projectlombok   lombok
2、指定Mainclass类

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

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

   org.springframework.boot   spring-boot-maven-plugin       com.zhuangpo.mavenplugin.MavenPluginApplication    ZIP    

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包

第二种:通过配置

org.springframework.bootspring-boot-maven-plugintrue

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

声明: 公众号如需转载该篇文章,发表文章的头部一定要 告知是转至公众号: 后端元宇宙。同时也可以问本人要markdown原稿和原图片。其它情况一律禁止转载!

关键词:

相关阅读