系列文章目录
maven生命周期和插件
前言
由于在具体项目开发过程中对于maven的理解和掌握处于基本运用的阶段,了解maven过于片面,所以本篇博客是博主学习《maven实战》书籍之后对maven生命周期和插件的总结,绝大多数内容源于《maven》实战这本书籍。
一、什么是生命周期&why
maven的生命周期是为了对所有的构建过程进行抽象和统一。这个生命周期包含了项目的清理、初始化、编译、测试、打包、集成测试、验证、部署和站点生成几乎所有构建步骤。
几乎所有项目的构建,都能够映射到这样一个生命周期上。
1.三套生命周期
maven拥有三套相互独立的生命周期,它们分别是clean、default、和site
clean 生命周期的目的是清理项目
default 生命周期的目的是构建项目
site 生命周期的目的是建立项目站点
每一个生命周期包含一些阶段,这些阶段是有顺序的,并且后面的阶段依赖于前面的阶段。
以clean生命周期为例,它包含的阶段有pre-clean,clean和post-clean。当用户调用pre-clean的时候,之后又pre-clean阶段执行;当用户调用clean的时候,pre-clean和clean阶段都会得以顺序执行,相应用户调用post-clean的时候,pre-clean,clean和post-clean会得以顺序执行。
2.clean生命周期
clean生命周期的目的是清理项目,它包含三个阶段
1.pre-clean执行一些清理前需要完成的工作
2.clean清理上一次构建生成的文件
3.post-clean执行一些清理后需要完成的工作
3.default生命周期
default生命周期定义了真正构建时需要执行的所有步骤,是所有生命周期中最核心的部分。
下面列出重要的阶段:
- validate
- initialize
- generate-sources
- process-sources处理项目主资源文件,一般是对src/main/resources目录内容进行变量替换等工作之后,复制到项目输出的classpath目录中
- generate-resources
- process-resources
- compile编译项目的主源码,一般是编译src/main/java目录下的Java文件值输出的主classpath目录中
- process-classes
- generate-test-sources
- process-test-sources处理项目测试资源文件,一般是对src/test/resources目录的内容进行变量替换等工作后,复制到项目输出的测试classpath中。
- generate-test-resources
- process-test-resources
- test-compile编译项目的测试代码。一般是编译src/test/java目录中java文件至项目输出的测试classpath目录中
- process-test-classes
- test使用单元测试框架测试,测试代码不会被打包或部署
- prepare-package
- package接受编译好的代码,打包成可发布的格式,如jar
- pre-integration-test
- integration-test
- post-integration-test
- verify
- install将包安装到maven仓库,共本地其他maven项目使用
- deploy将最终的包复制到远程仓库,供其他开发人员和项目使用
- 上述可以参考官方的解释:http://maven.apach.org/guides/introduction/introduction-to-the-lifecycle.html
4.site生命周期
site生命周期的目的是建立和发布项目站点,maven能够基于POM所包含的信息,自动生成一个友好的站点,方便团队交流和发布项目信息
pre-site执行一些在生成项目站点之前需要完成的工作
site生成项目站点文档
post-site执行一些在生成项目攒点之后需要完成的工作
site-deploy将生成的站点发布到服务器上。
5.命令行与生命周期
从命令行执行Maven任务的主要方式就是调用maven的生命周期阶段。需要注意的是每个生命周期是相互独立的,而一个生命周期的阶段是有前后依赖关系的。
下面以一些常见的maven命令为例,解释其执行的生命周期阶段。
mvn clean:该命令调用clean生命周期的test阶段,实际执行的阶段为clean生命周期的pre-clean和clean阶段
mvn clean install:该命令调用clean生命周期的clean阶段和default生命周期的install阶段。实际执行的阶段为clean生命周期的pre-clean和clean阶段
以及default生命周期的从validate至install的所有阶段。
mvn clean deploy site-deploy:该命令调用clean生命周期的clean阶段和default生命周期的deploy阶段以及site生命周期的site-deploy阶段。
实际执行的阶段为clean生命周期的pre-clean和clean阶段
以及default生命周期的所有阶段,以及site生命周期的所有阶段。
二、插件目标
maven的核心仅仅定义了抽象的生命周期,具体的任务是交由插件完成的。
对于插件本身,为了能够复用代码,它往往能够完成多个任务。
例如maven-dependency-plugin,他能基于项目依赖做很多事。它能够分析项目依赖,帮助找出潜在的无用依赖;他能够列出项目的依赖树,帮助分析依赖的来源;等等。
为每个这样的功能编写一个独立的插件显然是不可取的,因为这些任务背后有很多可以复用的代码,因此这些功能聚集在一个插件里,每个功能就是一个插件目标。
maven-dependency-plugin有十多个目标,每个目标对应了一个功能,上述提到的几个功能分别对应插件目标为dependency-analyze、dependency:tree等等。
这是一种通用的写法,冒号前面是插件前缀,冒号后面是该插件的目标。
三、插件绑定
maven的生命周期与插件相互绑定,用于完成实际的构建任务。例如项目编译这一任务,它对应了default生命周期的compile这一阶段,而maven-compiler-plugin插件的compile目标能够完成该项任务,因此将他们绑定,就能实现项目编译的目的。
如图:
1.内置绑定
为了让用户几乎不用任何配置就能够构建maven项目,maven在核心为一些主要的生命周期阶段绑定了很多插件的目标。当用户通过命令行调用生命周期阶段的时候,对应的插件目标就会执行相应的任务。
如clean生命周期有pre-clean、clean、post-clean三个阶段,其中clean与maven-clean-plugin:clean绑定。maven-clean-plugin仅有clean这一个目标,其作用就是删除项目的输出目录。
site生命周期有pre-site site post-site site-deploy四个阶段,其中site和maven-site-plugin:site相互绑定,site-deploy和maven-site-plugin:deploy相互绑定。maven-site-plugin有很多目标,其中site目标用来生成项目站点,deploy目标用来将项目站点部署到远程服务器上。
site生命周期阶段与插件目标的绑定关系如图:
default生命周期的内置插件绑定关系及具体任务如图:
只列出了拥有插件绑定关系的阶段,default生命周期还有很多阶段,默认它们没有绑定任何插件。
2.自定义绑定
除了内置绑定以外,用户还能够自己选择将某个插件目标绑定到生命周期的某个阶段,这种自定义绑定方式能让maven项目在构建过程中执行更多富有特色的任务。这里不做描述。
四、插件配置
完成了插件和生命周期的绑定之后,用户还可以配置插件目标的参数,进一步调整插件目标所执行的任务,以满足项目的需求。几乎所有maven插件的目标都有一些可配置的参数,用户可以通过命令行和POM等方式来配置这些参数。
1.命令行插件配置
示例:
用户可以在maven命令中使用-D参数,并伴随一个参数键=参数值的形式,类配置插件目标的参数。
例如:maven-surefire-plugin提供了一个maven.test.skip参数,当其值为true的时候,就会跳过执行测试。
如:mven install -Dmaven.test.skip=true
参数-D是java自带的,其功能是通过命令行设置一个Java系统属性,maven简单地重用了该参数,在准备插件的时候检查系统属性,便实现了插件参数的配置。
2.POM中插件全局配置
有些参数的值从项目创建到项目发布都不会改变,或者说很少改变,对于这种情况,在POM文件中一次性配置显然比重复在命令行输入要方面的多。
用户可以在声明插件的时候,对此插件进行一个全局配置。那么所有基于该插件目标的任务,都会使用这些配置。
例如:我们通常会需要配置maven-compiler-plugin告诉他编译java1.5版本的源文件,生成与JVM1.5兼容的字节码文件。
如:
这样不管绑定到compile阶段的maven-compiler-plugin:compiler任务还是绑定到test-compiler阶段的maven-compiler-plugin:testCompiler任务,就都能使用该配置,基于java1.5版本进行编译。
3. POM中插件任务配置
除了为插件配置全局的参数,用户还可以为某个插件任务配置特定参数。
以maven-antrun-plugin为例,他有一个目标run,可以用来在Maven中调用Ant任务。用户将maven-antrun-plugin:run绑定到多个生命周期阶段上,再加以不同的配置,就可以
让maven在不同的生命阶段执行不同的任务。
上述代码中,首先,maven-antrun-plugin:run与vailate阶段绑定,从而构成一个id为ant-validate的任务。插件全局配置中的configuration元素谓语plugin元素下面,这里的configuration远足则谓语execution元素下,表示这是特定任务的配置。而非插件整体的配置
这个ant-validate任务配置了一个echo Ant任务,向命令行输出一段文字,表示该任务是绑定到validate阶段的。第二个任务的id为ant-verify,它绑定到了verify阶段,同样他也输出一段文字到命令行,告诉该任务绑定到了verify阶段。
五、获取插件信息
仅仅理解如何配置使用插件是不够的,当遇到一个构建任务的时候,用户还需要知道去哪里寻找合适的插件,以帮助完成任务。找到正确插件之后,还要详细了解该插件的配置点。
由于maven的插件非常多,而且这其中的大部分没有完善问的文档,因此,使用正确的插件并进行正确的配置,不是一件容易的事。
我们主要可以通过两种方式获取插件信息:
1.在线插件信息:
所有主要的maven插件都来自Apache和Codehaus。
插件的详细列表可以访问地址:http://maven.apache.org/plugins/index.html
插件下载地址:Central Repository: org/apache/maven/plugins
2.使用maven-help-plugin描述插件
除了访问在线的插件文档之外,可以借助maven-help-plugin来获取插件的详细信息。
如:运行如下命令来获取maven-compiler-0plugin2.1版本的信息:
mvn help:describle-Dplugin=org.apache.maven.plugins:maven-compiler-plugin:2.1
这是执行的是maven-help-plugin的describe目标,在参数plugin中输入需要描述插件的groupId、artifactId、version。
六、命令行调用插件
在命令输入mvn-h 显示mvn命令帮助,显示如下信息:
mvn命令的基本用法,options表示可用选项,mvm命令有20多个选项,除了选项之外,mvn命令后面可以添加一个或者多个goal和phase,分别指插件目标和生命周期阶段。
我们知道,可以通过mvn命令激活生命周期阶段,从而执行那些绑定在生命周期阶段上的插件目标。
但maven还支持直接从命令行调用插件目标。maven支持这种方式是因为有些任务不适合绑定在生命周期上,例如maven-help-plugin:describe,我们不需要在构建项目的时候去描述插件信息,又如maven-dependency=plugin:tree,我们也不需要构建项目显示依赖树。
因此这些插件目标应该通过如下方式使用:
mvn help:describe-Dplugin-compiler
mvn dependency:tree
这里需要注意的是,describe是maven-help-plugin的目标没错,但是冒号前的help是什么?
它既不是groupId、也不是artifactId,maven是如何根据该信息找到对应版本插件的呢?
先看如下命令:
他们的效果与之前的两条命令基本一样,但是前面的命令更为简洁,更容易记忆和使用。
为了达到该目的,maven引入了目标前缀的概念,help是maven-help-plugin的目标前缀。
dependency是maven-dependency-plugin的前缀,有了插件前缀maven就能找到对应的artifactId,不过除了artifactId,maven还需要得到groupId和version才能精确定位到某个插件。
总结
认识和理解maven的生命周期,以及为什么要有maven的生命周期对于maven的生命周期的运用有很大的帮助。
maven的核心仅仅定义了抽象的生命周期,具体的任务是交由插件完成的。
对于插件本身,为了能够复用代码,它往往能够完成多个任务,通过填写不同参数完成不同的功能。