龙空技术网

详解Maven 构建生命周期和实际Spring Boot项目构建过程演示

软件架构 414

前言:

目前我们对“maven的java工程构建”大致比较关切,我们都需要知道一些“maven的java工程构建”的相关文章。那么小编同时在网摘上搜集了一些对于“maven的java工程构建””的相关资讯,希望小伙伴们能喜欢,朋友们快快来了解一下吧!

Maven 构建生命周期定义了一个项目构建跟发布的过程。

一、Maven构建生命周期

一个典型的 Maven 构建(build)生命周期是由以下几个阶段的序列组成的:

下面对上面几个阶段进行简单介绍,另外还有一个标准的clean(项目清理)阶段,未在上面罗列。

生命周期(lifecycle)可以理解成由各种plugin按照一定的顺序执行来完成Java项目清理、编译、打包、测试、部署等整个项目的流程的一个过程。

生命周期(lifecycle)由各个阶段组成,每个阶段由maven的插件plugin来执行完成。生命周期(lifecycle)主要包括clean、compile、package、install、testResources、testCompile等,其中带test开头的都是用于编译测试代码或运行单元测试用例的。



二、Maven构建项目示例

下面以一个实际的Spring Cloud Alibaba项目示例(来自小编的Spring Cloud技术专栏)。使用常用的mvn clean install 命令,演示整个构建过程。

以nacos-config-example 子项目示例,代码如下所示,具体代码细节可以访问小编的Spring Cloud 技术专栏。

pom.xml 文件中添加了spring-boot-maven-plugin 插件:

<build>

<pluginManagement>

<plugins>

<plugin>

<groupId>org.springframework.boot</groupId>

<artifactId>spring-boot-maven-plugin</artifactId>

</plugin>

</plugins>

</pluginManagement>

</build>


在cmd窗口,到项目的根目录,执行mvn clean install,看看输出结果。

上述构建过程中,各个插件的执行顺序为:1:clean、2:resources、3:compile、4:testResources、5:testCompile、6:test、7:jar、8:repackage、9:install。在图中标记的地方每一行都是由冒号分隔的,前半部分是对应的插件,后半部分是插件的执行目标,也就是插件执行产生的结果。

上图中,只有spring-boot-maven-plugin 插件是我们配置的,如下图所示,那其他插件呢?

上图中其他的插件没有配置,但最后项目构建成功,说明maven内置的各种插件,如果pom中没有配置就调用默认的内置插件,如果pom中配置了就调用配置的插件。

Maven构建过程就是由各种插件按照一定的顺序执行来完成项目的编译、单元测试、打包、布署的完成。各种插件的执行过程也就构成了maven的生命周期(lifecycle)。生命周期(lifecycle)各个阶段并不是独立的,可以单独执行如mvn clean,也可以一起执行如mvn clean install。而且有的mvn命令其是包括多个阶段的,如mvn compile其实包括了resources和compile两个阶段。



三、理解maven构建阶段

1. clean阶段

clean阶段是独立的一个阶段,功能就是清除工程目前下的target目录,对应的插件是 maven-clean-plugin:3.1.0,3.1.0是版本号,使用maven内置的插件。

执行clean会清除工程中的target目录:

2. resources阶段

resources阶段的插件maven-resources-plugin:3.1.0。resource插件的功能就是把项目需要的配置文件拷贝到指定的目录,默认是拷贝src\main\resources目录下的配置文件到classes目录下,当然可以自己来配置源目录和输出目录。resources插件一般不单独执行,compile插件执行时会先调用resources插件。

3. compile阶段

compile插件maven-compiler-plugin执行时先调用resouces插件,功能就是把src\main\java源码编译成字节码生成class文件,并把编译好的class文件输出到target\classes目录下。

4. testResources和testCompile 阶段

该阶段所用的compile和resources插件和main主代码是相同的,但执行的目标不同,testCompile和testResources是把src\test\java下的代码编译成字节码输出到target\test-classes,同时把src\test\resources下的配置文件拷贝到target\test-classes。

配置文件和单元测试类输出到test-classes 目录,如下所示:

5. test阶段

插件maven-surefire-plugin:2.22.2是执行单元测试类的。如果单元测试不通行,构建会失败,在编译正式的项目时可以使用mvn compile -Dmaven.test.skip=true 来跳过测试类的编译和运行过程。mvn test可以单独执行,但是这个命令其实是包括了resources、compile、testResources、testCompile、test这几个阶段。

6. jar阶段和repackage阶段

maven-jar-plugin:3.1.2 这个插件是把class文件、配置文件打成一个jar(war或其它格式)包。依赖包是不在jar里面的,需要建立lib目录,且jar和lib目录在同级目录。

spring-boot-maven-plugin插件,在mvn package之后,再次打包可执行的jar/war,同时保留mvn package生成的jar/war为*.origin。

7. install阶段

发布插件maven-install-plugin的功能就是把构建好的artifact部署到本地仓库,还有一个deploy插件是将构建好的artifact部署到远程仓库。

四、IDEA开发工具Maven工具栏

可以通过IDEA 开发工具右侧的Maven工具栏方便看到maven插件列表,如下图所示:

我们可以看到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。

spring-boot-maven-plugin最主要goal就是repackage,其在Maven的package生命周期阶段,能够将mvn package生成的jar包,再次打包为可执行的fat jar包,并将mvn package生成的jar包重命名为*.original。

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


五、maven命令package、install、deploy比较

我们在用maven构建Java项目时,最常用的打包命令有mvn package、mvn install、mvn deploy,这三个命令都可完成打jar包或war的功能,但这三个命令还是有区别的。

package命令完成了项目编译、单元测试、打包功能,将jar包放置在工程的target目录中。install命令完成了项目编译、单元测试、打包功能,同时把打好的可执行jar包(war包或其它形式的包)布署到本地maven仓库,但没有布署到远程maven私服仓库。deploy命令完成了项目编译、单元测试、打包功能,同时把打好的可执行jar包(war包或其它形式的包)布署到本地maven仓库和远程maven私服仓库。

标签: #maven的java工程构建