devbox
Cpp五条
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

spring-boot-maven-plugin插件详解

作者：Cpp五条 | 2024-03-10 00:23:23

赞

踩

spring-boot-maven-plugin

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

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

  1. <span style="color:#4b4b4b"><span style="background-color:#ffffff"><code class="language-xml"><span style="color:#75715e"><?xml version="1.0" encoding="UTF-8"?></span>
  2. <span style="color:#f8f8f2"><<span style="color:#f92672 !important">project</span> <span style="color:#f92672">xmlns</span>=<span style="color:#e6db74">"http://maven.apache.org/POM/4.0.0"</span> <span style="color:#f92672">xmlns:xsi</span>=<span style="color:#e6db74">"http://www.w3.org/2001/XMLSchema-instance"</span>
  3. 	<span style="color:#f92672">xsi:schemaLocation</span>=<span style="color:#e6db74">"http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"</span>></span>
  4. 	<span style="color:#f8f8f2"><<span style="color:#f92672 !important">modelVersion</span>></span>4.0.0<span style="color:#f8f8f2"></<span style="color:#f92672 !important">modelVersion</span>></span>
  5. 	<span style="color:#f8f8f2"><<span style="color:#f92672 !important">parent</span>></span>
  6. 		<span style="color:#f8f8f2"><<span style="color:#f92672 !important">groupId</span>></span>org.springframework.boot<span style="color:#f8f8f2"></<span style="color:#f92672 !important">groupId</span>></span>
  7. 		<span style="color:#f8f8f2"><<span style="color:#f92672 !important">artifactId</span>></span>spring-boot-starter-parent<span style="color:#f8f8f2"></<span style="color:#f92672 !important">artifactId</span>></span>
  8. 		<span style="color:#f8f8f2"><<span style="color:#f92672 !important">version</span>></span>2.7.12<span style="color:#f8f8f2"></<span style="color:#f92672 !important">version</span>></span>
  9. 		<span style="color:#f8f8f2"><<span style="color:#f92672 !important">relativePath</span>/></span>
  10. 	<span style="color:#f8f8f2"></<span style="color:#f92672 !important">parent</span>></span>
  11. 	<span style="color:#f8f8f2"><<span style="color:#f92672 !important">groupId</span>></span>com.zhuangpo<span style="color:#f8f8f2"></<span style="color:#f92672 !important">groupId</span>></span>
  12. 	<span style="color:#f8f8f2"><<span style="color:#f92672 !important">artifactId</span>></span>maven-plugin<span style="color:#f8f8f2"></<span style="color:#f92672 !important">artifactId</span>></span>
  13. 	<span style="color:#f8f8f2"><<span style="color:#f92672 !important">version</span>></span>0.0.1-SNAPSHOT<span style="color:#f8f8f2"></<span style="color:#f92672 !important">version</span>></span>
  14. 	<span style="color:#f8f8f2"><<span style="color:#f92672 !important">name</span>></span>maven-plugin<span style="color:#f8f8f2"></<span style="color:#f92672 !important">name</span>></span>
  15. 	<span style="color:#f8f8f2"><<span style="color:#f92672 !important">properties</span>></span>
  16. 		<span style="color:#f8f8f2"><<span style="color:#f92672 !important">java.version</span>></span>1.8<span style="color:#f8f8f2"></<span style="color:#f92672 !important">java.version</span>></span>
  17. 	<span style="color:#f8f8f2"></<span style="color:#f92672 !important">properties</span>></span>
  18. 	<span style="color:#f8f8f2"><<span style="color:#f92672 !important">dependencies</span>></span>
  19. 		<span style="color:#f8f8f2"><<span style="color:#f92672 !important">dependency</span>></span>
  20. 			<span style="color:#f8f8f2"><<span style="color:#f92672 !important">groupId</span>></span>org.springframework.boot<span style="color:#f8f8f2"></<span style="color:#f92672 !important">groupId</span>></span>
  21. 			<span style="color:#f8f8f2"><<span style="color:#f92672 !important">artifactId</span>></span>spring-boot-starter<span style="color:#f8f8f2"></<span style="color:#f92672 !important">artifactId</span>></span>
  22. 		<span style="color:#f8f8f2"></<span style="color:#f92672 !important">dependency</span>></span>
  23. 		<span style="color:#f8f8f2"><<span style="color:#f92672 !important">dependency</span>></span>
  24. 			<span style="color:#f8f8f2"><<span style="color:#f92672 !important">groupId</span>></span>org.springframework.boot<span style="color:#f8f8f2"></<span style="color:#f92672 !important">groupId</span>></span>
  25. 			<span style="color:#f8f8f2"><<span style="color:#f92672 !important">artifactId</span>></span>spring-boot-starter-web<span style="color:#f8f8f2"></<span style="color:#f92672 !important">artifactId</span>></span>
  26. 		<span style="color:#f8f8f2"></<span style="color:#f92672 !important">dependency</span>></span>
  27. 	<span style="color:#f8f8f2"></<span style="color:#f92672 !important">dependencies</span>></span>
  28.  
  29. 	<span style="color:#f8f8f2"><<span style="color:#f92672 !important">build</span>></span>
  30. 		<span style="color:#f8f8f2"><<span style="color:#f92672 !important">plugins</span>></span>
  31. 			<span style="color:#f8f8f2"><<span style="color:#f92672 !important">plugin</span>></span>
  32. 				<span style="color:#f8f8f2"><<span style="color:#f92672 !important">groupId</span>></span>org.springframework.boot<span style="color:#f8f8f2"></<span style="color:#f92672 !important">groupId</span>></span>
  33. 				<span style="color:#f8f8f2"><<span style="color:#f92672 !important">artifactId</span>></span>spring-boot-maven-plugin<span style="color:#f8f8f2"></<span style="color:#f92672 !important">artifactId</span>></span>
  34. 			<span style="color:#f8f8f2"></<span style="color:#f92672 !important">plugin</span>></span>
  35. 		<span style="color:#f8f8f2"></<span style="color:#f92672 !important">plugins</span>></span>
  36. 	<span style="color:#f8f8f2"></<span style="color:#f92672 !important">build</span>></span>
  37. <span style="color:#f8f8f2"></<span style="color:#f92672 !important">project</span>></span>
  38. </code></span></span>

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

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

打包命令

  1. <span style="color:#4b4b4b"><span style="background-color:#ffffff"><code class="language-mvn">mvn clean package
  2. </code></span></span>

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

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

发现是可以正常启动。

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

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

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

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

  1. <span style="color:#4b4b4b"><span style="background-color:#ffffff"><code class="language-java">localhost:target xub$ java -jar maven-plugin-<span style="color:#ae81ff">0.0</span><span style="color:#ae81ff">.1</span>-SNAPSHOT.jar 
  2. maven-plugin-<span style="color:#ae81ff">0.0</span><span style="color:#ae81ff">.1</span>-SNAPSHOT.jar中没有主清单属性
  3. </code></span></span>

发现并不能启动成功，这是为什么呢？

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

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

二、插件介绍

1、插件标签详解
  1. <span style="color:#4b4b4b"><span style="background-color:#ffffff"><code class="language-xml">  <span style="color:#75715e"><!--使用的插件列表 。 --></span>
  2.             <span style="color:#f8f8f2"><<span style="color:#f92672 !important">plugins</span>></span>
  3.                 <span style="color:#75715e"><!--plugin元素包含描述插件所需要的信息。 --></span>
  4.                 <span style="color:#f8f8f2"><<span style="color:#f92672 !important">plugin</span>></span>
  5.                     <span style="color:#75715e"><!--插件在仓库里的group ID --></span>
  6.                     <span style="color:#f8f8f2"><<span style="color:#f92672 !important">groupId</span> /></span>
  7.                     <span style="color:#75715e"><!--插件在仓库里的artifact ID --></span>
  8.                     <span style="color:#f8f8f2"><<span style="color:#f92672 !important">artifactId</span> /></span>
  9.                     <span style="color:#75715e"><!--被使用的插件的版本（或版本范围） --></span>
  10.                     <span style="color:#f8f8f2"><<span style="color:#f92672 !important">version</span> /></span>
  11.                     <span style="color:#75715e"><!--是否从该插件下载Maven扩展（例如打包和类型处理器），由于性能原因，只有在真需要下载时，该元素才被设置成enabled。 --></span>
  12.                     <span style="color:#f8f8f2"><<span style="color:#f92672 !important">extensions</span> /></span>
  13.                     <span style="color:#75715e"><!--在构建生命周期中执行一组目标的配置。每个目标可能有不同的配置。 --></span>
  14.                     <span style="color:#f8f8f2"><<span style="color:#f92672 !important">executions</span>></span>
  15.                         <span style="color:#75715e"><!--execution元素包含了插件执行需要的信息 --></span>
  16.                         <span style="color:#f8f8f2"><<span style="color:#f92672 !important">execution</span>></span>
  17.                             <span style="color:#75715e"><!--执行目标的标识符，用于标识构建过程中的目标，或者匹配继承过程中需要合并的执行目标 --></span>
  18.                             <span style="color:#f8f8f2"><<span style="color:#f92672 !important">id</span> /></span>
  19.                             <span style="color:#75715e"><!--绑定了目标的构建生命周期阶段，如果省略，目标会被绑定到源数据里配置的默认阶段 --></span>
  20.                             <span style="color:#f8f8f2"><<span style="color:#f92672 !important">phase</span> /></span>
  21.                             <span style="color:#75715e"><!--配置的执行目标 --></span>
  22.                             <span style="color:#f8f8f2"><<span style="color:#f92672 !important">goals</span> /></span>
  23.                             <span style="color:#75715e"><!--配置是否被传播到子POM --></span>
  24.                             <span style="color:#f8f8f2"><<span style="color:#f92672 !important">inherited</span> /></span>
  25.                             <span style="color:#75715e"><!--作为DOM对象的配置 --></span>
  26.                             <span style="color:#f8f8f2"><<span style="color:#f92672 !important">configuration</span> /></span>
  27.                         <span style="color:#f8f8f2"></<span style="color:#f92672 !important">execution</span>></span>
  28.                     <span style="color:#f8f8f2"></<span style="color:#f92672 !important">executions</span>></span>
  29.                     <span style="color:#75715e"><!--项目引入插件所需要的额外依赖 --></span>
  30.                     <span style="color:#f8f8f2"><<span style="color:#f92672 !important">dependencies</span>></span>
  31.                         <span style="color:#75715e"><!--参见dependencies/dependency元素 --></span>
  32.                         <span style="color:#f8f8f2"><<span style="color:#f92672 !important">dependency</span>></span>
  33.                             ......
  34.                         <span style="color:#f8f8f2"></<span style="color:#f92672 !important">dependency</span>></span>
  35.                     <span style="color:#f8f8f2"></<span style="color:#f92672 !important">dependencies</span>></span>
  36.                     <span style="color:#75715e"><!--任何配置是否被传播到子项目 --></span>
  37.                     <span style="color:#f8f8f2"><<span style="color:#f92672 !important">inherited</span> /></span>
  38.                     <span style="color:#75715e"><!--作为DOM对象的配置 --></span>
  39.                     <span style="color:#f8f8f2"><<span style="color:#f92672 !important">configuration</span> /></span>
  40.                 <span style="color:#f8f8f2"></<span style="color:#f92672 !important">plugin</span>></span>
  41.             <span style="color:#f8f8f2"></<span style="color:#f92672 !important">plugins</span>></span>
  42. </code></span></span>
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依赖，可以使用如下的配置：

  1. <span style="color:#4b4b4b"><span style="background-color:#ffffff"><code class="language-xml"> <span style="color:#f8f8f2"><<span style="color:#f92672 !important">plugin</span>></span>
  2. 	<span style="color:#f8f8f2"><<span style="color:#f92672 !important">groupId</span>></span>org.springframework.boot<span style="color:#f8f8f2"></<span style="color:#f92672 !important">groupId</span>></span>
  3. 	<span style="color:#f8f8f2"><<span style="color:#f92672 !important">artifactId</span>></span>spring-boot-maven-plugin<span style="color:#f8f8f2"></<span style="color:#f92672 !important">artifactId</span>></span>
  4. 		<span style="color:#f8f8f2"><<span style="color:#f92672 !important">configuration</span>></span>
  5. 			<span style="color:#f8f8f2"><<span style="color:#f92672 !important">excludes</span>></span>
  6. 				<span style="color:#f8f8f2"><<span style="color:#f92672 !important">exclude</span>></span>
  7. 				   <span style="color:#f8f8f2"><<span style="color:#f92672 !important">groupId</span>></span>org.projectlombok<span style="color:#f8f8f2"></<span style="color:#f92672 !important">groupId</span>></span>
  8. 				   <span style="color:#f8f8f2"><<span style="color:#f92672 !important">artifactId</span>></span>lombok<span style="color:#f8f8f2"></<span style="color:#f92672 !important">artifactId</span>></span>
  9. 				<span style="color:#f8f8f2"></<span style="color:#f92672 !important">exclude</span>></span>
  10. 			<span style="color:#f8f8f2"></<span style="color:#f92672 !important">excludes</span>></span>
  11. 		<span style="color:#f8f8f2"></<span style="color:#f92672 !important">configuration</span>></span>
  12. <span style="color:#f8f8f2"></<span style="color:#f92672 !important">plugin</span>></span>
  13. </code></span></span>
2、指定Mainclass类

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

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

  1. <span style="color:#4b4b4b"><span style="background-color:#ffffff"><code class="language-xml"><span style="color:#f8f8f2"><<span style="color:#f92672 !important">plugin</span>></span>
  2. 	   <span style="color:#f8f8f2"><<span style="color:#f92672 !important">groupId</span>></span>org.springframework.boot<span style="color:#f8f8f2"></<span style="color:#f92672 !important">groupId</span>></span>
  3. 	   <span style="color:#f8f8f2"><<span style="color:#f92672 !important">artifactId</span>></span>spring-boot-maven-plugin<span style="color:#f8f8f2"></<span style="color:#f92672 !important">artifactId</span>></span>
  4. 	   <span style="color:#f8f8f2"><<span style="color:#f92672 !important">configuration</span>></span>
  5. 			    <span style="color:#f8f8f2"><<span style="color:#f92672 !important">mainClass</span>></span>com.zhuangpo.mavenplugin.MavenPluginApplication<span style="color:#f8f8f2"></<span style="color:#f92672 !important">mainClass</span>></span>
  6. 			    <span style="color:#f8f8f2"><<span style="color:#f92672 !important">layout</span>></span>ZIP<span style="color:#f8f8f2"></<span style="color:#f92672 !important">layout</span>></span>
  7. 	    <span style="color:#f8f8f2"></<span style="color:#f92672 !important">configuration</span>></span>
  8. <span style="color:#f8f8f2"></<span style="color:#f92672 !important">plugin</span>></span>
  9. </code></span></span>

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

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

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

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

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

解决办法

第一种:通过命令

  1. <span style="color:#4b4b4b"><span style="background-color:#ffffff"><code class="language-mvn">mvn clean package -D spring-boot.repackage.skip=true 
  2. </code></span></span>

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

第二种：通过配置

  1. <span style="color:#4b4b4b"><span style="background-color:#ffffff"><code class="language-xml"><span style="color:#f8f8f2"><<span style="color:#f92672 !important">plugin</span>></span>
  2. 	<span style="color:#f8f8f2"><<span style="color:#f92672 !important">groupId</span>></span>org.springframework.boot<span style="color:#f8f8f2"></<span style="color:#f92672 !important">groupId</span>></span>
  3. 	<span style="color:#f8f8f2"><<span style="color:#f92672 !important">artifactId</span>></span>spring-boot-maven-plugin<span style="color:#f8f8f2"></<span style="color:#f92672 !important">artifactId</span>></span>
  4. 		<span style="color:#f8f8f2"><<span style="color:#f92672 !important">configuration</span>></span>
  5. 			<span style="color:#f8f8f2"><<span style="color:#f92672 !important">skip</span>></span>true<span style="color:#f8f8f2"></<span style="color:#f92672 !important">skip</span>></span>
  6. 		<span style="color:#f8f8f2"></<span style="color:#f92672 !important">configuration</span>></span>
  7. <span style="color:#f8f8f2"></<span style="color:#f92672 !important">plugin</span>></span>
  8. </code></span></span>

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

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/Cpp五条/article/detail/216792
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号