AI 助理
文档备案控制台
开发者社区 开发与运维 文章 正文

Java-SpringBoot-10-Spring Boot Maven Plugin-01

2022-10-21 397
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： Spring Boot Maven Plugin 是什么呢？Spring Boot Maven Plugin 是什么呢？

Spring Boot Maven Plugin 是什么呢？

       Spring Boot Maven Plugin是Apache Maven的一个Spring Boot的Maven插件，为Spring Boot应用提供了执行Maven操作的可能。

        Spring Boot Maven Plugin能够将Spring Boot应用打包为可执行的jar或war文件,并且能够以通常的方式运行执行springboot应用。


Spring Boot Maven Plugin 可以干些啥？

       Spring Boot Maven Plugin 可以将项目打包可执行的jar或war归档文件，运行Spring Boot应用程序，生成构建信息以及在运行集成测试之前启动Spring Boot应用程序。


Spring Boot Maven plugin的最主要goal就是repackage。

       Maven首先在package阶段打包生成*.jar文件，查找Manifest文件中配置的Main-Class属性，再次执行spring-boot:repackage重新打包为可执行的软件包，并将mvn package生成的软件包重命名为*.original。

可以看到生成的两个jar文件，一个是*.jar，另一个是*.jar.original。


普通jar和Spring Boot Maven Plugin 构建的jar有啥区别呢？

       springboot-maven-plugin打的jar包里包含了第三方依赖，而maven的源jar是不包含依赖的。

image.png

根据解压插件打的包结构对比看maven的源 jar的区别：

  • 源 jar 中主项目的 .class 文件被移至 fatjar 的 BOOT-INF/classes 文件夹下。
  • 新增 BOOT-INF/lib 文件夹，里面存放三方 jar 文件。
  • 新增 BOOT-INF/classpath.idx，用来记录 classpath 的加载顺序。
  • 新增 org/springframework/boot/loader 文件夹，这是 spring-boot-loader 编译后的 .class 文件。
  • 清单文件 MANIFEST.MF中新增以下属性:
  • Spring-Boot-Classpath-Index: 记录 classpath.idx 文件的地址。
  • Start-Class: 指定 Spring Boot 的启动类。
  • Spring-Boot-Classes: 记录主项目的 .class 文件存放路径。
  • Spring-Boot-Lib: 记录三方 jar 文件存放路径。
  • Spring-Boot-Version: 记录 Spring Boot 版本信息
  • Main-Class: 指定 jar 程序的入口类（可执行 jar 为 org.springframework.boot.loader.JarLauncher类）。


Spring Boot Maven plugin的5个Goals

  • spring-boot:repackage，默认goal。在mvn package之后，再次打包可执行的jar/war，同时保留mvn package生成的jar/war为.origin
  • spring-boot:run，运行Spring Boot应用
  • spring-boot:start，在mvn integration-test阶段，进行Spring Boot应用生命周期的管理
  • spring-boot:stop，在mvn integration-test阶段，进行Spring Boot应用生命周期的管理
  • spring-boot:build-info，生成Actuator使用的构建信息文件build-info.properties



使用

       1.如果POM是继承spring-boot-starter-parent的话，parant已经有了默认的配置，已经可以直接使用了。

要将您的项目配置为继承自spring-boot-starter-parent，请设置parent如下：<!--InheritdefaultsfromSpringBoot--><parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId><version>2.5.0-RC1</version></parent>

只需要为此依赖项指定Spring Boot版本号2.5.0-RC1。如果导入其他启动器，则可以安全地省略版本号。如果要是自定义的话，直接添加配置去覆盖就可以了。比如：通过覆盖自己项目中的属性来覆盖各个依赖项。

例如，要使用不同版本的SLF4J库和Spring Data发布系列，您可以将以下内容添加到您的pom.xml：

<properties><java.version>1.8</java.version><start-class>com.myproject.PortalutilApplication也就是你启动类的全类名</start-class><slf4j.version>1.7.30</slf4j.version><spring-data-releasetrain.version>Moore-SR6</spring-data-releasetrain.version></properties>

spring-boot-starter-parent项目配置的默认值提供以下功能：

  • Java 1.8是默认的编译器级别。
  • UTF-8源编码。
  • 从spring-boot-dependenciesPOM继承的依赖性管理部分，用于管理常见依赖性的版本。这种依赖性管理使您可以在自己的POM中使用时省略那些依赖性的标签。
  • 具有执行ID的repackage目标的repackage执行。
  • 明智的资源过滤。
  • 明智的插件配置（Git commit ID和shade）。
  • 针对application.properties和application.yml包括特定于配置文件的文件（例如application-dev.properties和application-dev.yml）进行明智的资源过滤

嗯 不如直接看一眼2.4.5版本源码：

<?xmlversion="1.0"encoding="UTF-8"?><projectxmlns="http://maven.apache.org/POM/4.0.0"xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><modelVersion>4.0.0</modelVersion><parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-dependencies</artifactId><version>2.4.5</version></parent><artifactId>spring-boot-starter-parent</artifactId><packaging>pom</packaging><name>spring-boot-starter-parent</name><description>ParentpomprovidingdependencyandpluginmanagementforapplicationsbuiltwithMaven</description><properties><java.version>1.8</java.version><resource.delimiter>@</resource.delimiter><maven.compiler.source>${java.version}</maven.compiler.source><maven.compiler.target>${java.version}</maven.compiler.target><project.build.sourceEncoding>UTF-8</project.build.sourceEncoding><project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding></properties><url>https://spring.io/projects/spring-boot</url><licenses><license><name>ApacheLicense, Version2.0</name><url>https://www.apache.org/licenses/LICENSE-2.0</url></license></licenses><developers><developer><name>Pivotal</name><email>info@pivotal.io</email><organization>PivotalSoftware, Inc.</organization><organizationUrl>https://www.spring.io</organizationUrl></developer></developers><scm><url>https://github.com/spring-projects/spring-boot</url></scm><build><resources><resource><directory>${basedir}/src/main/resources</directory><filtering>true</filtering><includes><include>**/application*.yml</include><include>**/application*.yaml</include><include>**/application*.properties</include></includes></resource><resource><directory>${basedir}/src/main/resources</directory><excludes><exclude>**/application*.yml</exclude><exclude>**/application*.yaml</exclude><exclude>**/application*.properties</exclude></excludes></resource></resources><pluginManagement><plugins><plugin><groupId>org.jetbrains.kotlin</groupId><artifactId>kotlin-maven-plugin</artifactId><version>${kotlin.version}</version><configuration><jvmTarget>${java.version}</jvmTarget><javaParameters>true</javaParameters></configuration><executions><execution><id>compile</id><phase>compile</phase><goals><goal>compile</goal></goals></execution><execution><id>test-compile</id><phase>test-compile</phase><goals><goal>test-compile</goal></goals></execution></executions></plugin><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-compiler-plugin</artifactId><configuration><parameters>true</parameters></configuration></plugin><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-failsafe-plugin</artifactId><executions><execution><goals><goal>integration-test</goal><goal>verify</goal></goals></execution></executions><configuration><classesDirectory>${project.build.outputDirectory}</classesDirectory></configuration></plugin><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-jar-plugin</artifactId><configuration><archive><manifest><mainClass>${start-class}</mainClass><addDefaultImplementationEntries>true</addDefaultImplementationEntries></manifest></archive></configuration></plugin><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-war-plugin</artifactId><configuration><archive><manifest><mainClass>${start-class}</mainClass><addDefaultImplementationEntries>true</addDefaultImplementationEntries></manifest></archive></configuration></plugin><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-resources-plugin</artifactId><configuration><propertiesEncoding>${project.build.sourceEncoding}</propertiesEncoding><delimiters><delimiter>${resource.delimiter}</delimiter></delimiters><useDefaultDelimiters>false</useDefaultDelimiters></configuration></plugin><plugin><groupId>pl.project13.maven</groupId><artifactId>git-commit-id-plugin</artifactId><executions><execution><goals><goal>revision</goal></goals></execution></executions><configuration><verbose>true</verbose><dateFormat>yyyy-MM-dd'T'HH:mm:ssZ</dateFormat><generateGitPropertiesFile>true</generateGitPropertiesFile><generateGitPropertiesFilename>${project.build.outputDirectory}/git.properties</generateGitPropertiesFilename></configuration></plugin><plugin><groupId>org.springframework.boot</groupId><artifactId>spring-boot-maven-plugin</artifactId><executions><execution><id>repackage</id><goals><goal>repackage</goal></goals></execution></executions><configuration><mainClass>${start-class}</mainClass></configuration></plugin><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-shade-plugin</artifactId><configuration><keepDependenciesWithProvidedScope>true</keepDependenciesWithProvidedScope><createDependencyReducedPom>true</createDependencyReducedPom><filters><filter><artifact>*:*</artifact><excludes><exclude>META-INF/*.SF</exclude><exclude>META-INF/*.DSA</exclude><exclude>META-INF/*.RSA</exclude></excludes></filter></filters></configuration><dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-maven-plugin</artifactId><version>2.4.5</version></dependency></dependencies><executions><execution><phase>package</phase><goals><goal>shade</goal></goals><configuration><transformers><transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer"><resource>META-INF/spring.handlers</resource></transformer><transformer implementation="org.springframework.boot.maven.PropertiesMergingResourceTransformer"><resource>META-INF/spring.factories</resource></transformer><transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer"><resource>META-INF/spring.schemas</resource></transformer><transformer implementation="org.apache.maven.plugins.shade.resource.ServicesResourceTransformer"/><transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer"><mainClass>${start-class}</mainClass></transformer></transformers></configuration></execution></executions></plugin></plugins></pluginManagement></build></project>

2.可能需要使用自己的公司标准父级，或者可能希望显式声明所有Maven配置，那么就不继承spring-boot-starter-parentPOM。要使用Spring Boot Maven插件，就得自己在XML pom.xml的plugins部分中包含以下示例所示：

<project><modelVersion>4.0.0</modelVersion><artifactId>getting-started</artifactId><!-- ... --><build><plugins><plugin><groupId>org.springframework.boot</groupId><artifactId>spring-boot-maven-plugin</artifactId></plugin></plugins></build></project>

这样直接对项目进行打包的时候，就会使用配置好的spring-boot-maven-plugin来打包构建了。

      下期见！

文章标签：
Java
开发工具
测试技术
Apache
Spring
git
Maven
数据格式
XML
编译器
关键词：
Spring Boot Maven
Spring Maven
Java maven
Spring boot
Java boot
兴化
目录
相关文章
Quan_Chen
|
11月前
|
Java Maven 微服务
微服务——SpringBoot使用归纳——Spring Boot集成 Swagger2 展现在线接口文档——Swagger2 的 maven 依赖
在项目中使用Swagger2工具时，需导入Maven依赖。尽管官方最高版本为2.8.0，但其展示效果不够理想且稳定性欠佳。实际开发中常用2.2.2版本，因其稳定且界面友好。以下是围绕2.2.2版本的Maven依赖配置，包括`springfox-swagger2`和`springfox-swagger-ui`两个模块。
Quan_Chen
496 0
啦啦啦191
|
9月前
|
Java 测试技术 项目管理
【JavaEE】从 0 到 1 掌握 Maven 构建 Java 项目核心技巧 解锁 Java 项目高效管理实用实例
本文从Maven基础概念讲起，涵盖安装配置、核心概念（如POM与依赖管理）及优化技巧。结合Java Web项目实例，演示如何用Maven构建和管理项目，解决常见问题，助你高效掌握这一强大工具，提升Java开发与项目管理能力。适合初学者及进阶开发者学习。资源链接：[点此获取](https://pan.quark.cn/s/14fcf913bae6)。
啦啦啦191
321 6
2G冲浪词条
|
XML Java 应用服务中间件
Spring Boot 两种部署到服务器的方式
本文介绍了Spring Boot项目的两种部署方式：jar包和war包。Jar包方式使用内置Tomcat，只需配置JDK 1.8及以上环境，通过`nohup java -jar`命令后台运行，并开放服务器端口即可访问。War包则需将项目打包后放入外部Tomcat的webapps目录，修改启动类继承`SpringBootServletInitializer`并调整pom.xml中的打包类型为war，最后启动Tomcat访问应用。两者各有优劣，jar包更简单便捷，而war包适合传统部署场景。需要注意的是，war包部署时，内置Tomcat的端口配置不会生效。
2G冲浪词条
2943 17
Spring Boot 两种部署到服务器的方式
Quan_Chen
|
11月前
|
Java 数据库 微服务
微服务——SpringBoot使用归纳——Spring Boot中的项目属性配置——指定项目配置文件
在实际项目中，开发环境和生产环境的配置往往不同。为简化配置切换，可通过创建 `application-dev.yml` 和 `application-pro.yml` 分别管理开发与生产环境配置，如设置不同端口（8001/8002）。在 `application.yml` 中使用 `spring.profiles.active` 指定加载的配置文件，实现环境快速切换。本节还介绍了通过配置类读取参数的方法，适用于微服务场景，提升代码可维护性。课程源码可从 [Gitee](https://gitee.com/eson15/springboot_study) 下载。
Quan_Chen
501 0
潜意识Java
|
前端开发 JavaScript Java
Java构建工具-maven的复习笔记【适用于复习】
这篇文档由「潜意识Java」创作，主要介绍Maven的相关知识。内容涵盖Maven的基本概念、作用、项目导入步骤、依赖管理（包括依赖配置、代码示例、总结）、依赖传递、依赖范围以及依赖的生命周期等七个方面。作者擅长前端开发，秉持“得之坦然，失之淡然”的座右铭。期待您的点赞、关注和收藏，这将是作者持续创作的动力！ [个人主页](https://blog.csdn.net/weixin_73355603?spm=1000.2115.3001.5343)
潜意识Java
405 3
2的n次方_
|
Java 关系型数据库 MySQL
Maven——创建 Spring Boot项目
Maven 是一个项目管理工具，通过配置 `pom.xml` 文件自动获取所需的 jar 包，简化了项目的构建和管理过程。其核心功能包括项目构建和依赖管理，支持创建、编译、测试、打包和发布项目。Maven 仓库分为本地仓库和远程仓库，远程仓库包括中央仓库、私服和其他公共库。此外，文档还介绍了如何创建第一个 SpringBoot 项目并实现简单的 HTTP 请求响应。
2的n次方_
1131 1
Maven——创建 Spring Boot项目
2的n次方_
|
Java 关系型数据库 MySQL
如何使用 maven 创建一个 Spring Boot项目
Maven 是一个强大的项目管理工具，通过配置 `pom.xml` 文件自动获取所需的 jar 包，提高开发效率。其核心功能包括项目构建和依赖管理。项目构建支持编译、测试、打包和发布等流程，而依赖管理则通过中央仓库、本地仓库和私有服务器获取和管理项目依赖。示例中展示了如何创建第一个 SpringBoot 项目并实现简单接口。
2的n次方_
484 1
如何使用 maven 创建一个 Spring Boot项目
蓝易云
|
存储 运维 安全
Spring运维之boot项目多环境(yaml 多文件 proerties)及分组管理与开发控制
通过以上措施，可以保证Spring Boot项目的配置管理在专业水准上，并且易于维护和管理，符合搜索引擎收录标准。
蓝易云
961 2
路边两盏灯
|
Java Maven Android开发
【Azure Developer】VS Code打包Java maven Project 遇见 BUILD FAILURE
Unknown lifecycle phase "lean". You must specify a valid lifecycle phase or a goal in the format <plugin-prefix>:<goal> or <plugin-group-id>:<plugin-artifact-id>[:<plugin-version>]:<goal>
路边两盏灯
433 5
龙大吉
|
Java 持续交付 项目管理
使用Maven进行项目管理：提高Java Web开发的效率
Maven 是一款强大的项目管理和构建自动化工具，广泛应用于Java社区。它通过依赖管理、构建生命周期管理、插件机制和多模块项目支持等功能，简化了项目的构建过程，提高了开发效率。本文将介绍Maven的核心功能及其在Java Web开发中的应用。
龙大吉
402 0