Maven入门实战笔记05-生命周期和插件

Maven核心概念：坐标、依赖、仓库、生命周期、插件

生命周期：抽象

插件：具体

生命周期

1.Maven生命周期：清理、初始化、编译、打包、集成测试、验证、部署和站点生成

--------------------------

2.三套生命周期：clean、default、site

clean生命周期：(1)pre-clean (2)clean (3)post-clean

default生命周期：

validate：验证
initialize：初始化配置
generate-sources：生成源代码编译目录
process-sources：处理项目主资源文件，复制资源文件到outputclasspath
generate-resources：生成资源目录
process-resources：处理资源文件
complie：编译源代码
process-classes：处理编译后文件
generate-test-sources：生成测试目录
process-test-sources：处理项目测试资源文件，复制测试资源文件到outputclasspath
generate-test-resources：生成测试资源文件
process-test-resources：处理测试资源文件
test-compile：编译测试代码
process-test-classes:处理测试代码
test：单元测试运行测试代码
prepare-package：打包前的准备
package：将编译好的代码打包成为jar或者war或者ear等等
pre-integration-test：准备整体测试
integration-test：整体测试
post-integration-test：为整体测试收尾
verify：验证
install：安装到本地Maven库
deploy：将最终包部署到远程Maven仓库

 

site生命周期：(1)pre-site (2)site (3)post-site (4)site-deploy

--------------------------

3.命令行与生命周期

mvn clean:调用clean生命周期的clean阶段，实际调用pre-clean->clean

mvn test:调用default生命周期的test阶段，实际调用validate...->test

mvn clean install:调用clean生命周期的clean阶段和default生命周期的install阶段

mvn clean deploy site-deploy:

--------------------------------------------------------------------

插件

1.插件目标

插件本身能够完成多个任务，为了代码复用

多个任务（功能）聚集在一个插件里，每个功能就是一个插件目标

插件有多个目标，每个目标对应一个功能

如：插件maven-dependency-plugin

（1）dependency:analyze    分析项目依赖

（2）dependency:tree    列出项目的依赖树

（3）dependency:list    列出项目所有已解析的依赖

...

通用写法：冒号前是插件前缀，冒号后是插件目标

类似：compiler:compile（插件maven-compiler-plugin的compile目标）

surefire:test（插件maven-surefire-plugin的test目标）

--------------------------

2.插件绑定

Maven的生命周期与插件相互绑定，有以完成实际的构建任务。

（生命周期的阶段与插件的目标相互绑定，以完成 某个具体的构建任务）

--------------------------

3.内置绑定

 

 

--------------------------

4.自定义绑定

用户自己选择将某个插件目标绑定到生命周的某个阶段

例：创建项目的源码jar包

已知maven-source-plugin的jar-no-fork目标能将项目的主代码打包成jar文件

可以将其绑定到default生命周期的verify阶段上，参照default生命周期知，执行install命令时，调用default生命周期的validate到install阶段,而verify阶段在install阶段前

（在执行完集成测试后和安装构件之前创建源码jar包）

 修改项目的pom.xml，进行自定义绑定插件目标

 

	<build>
		<plugins>
			<plugin>
				<groupId>org.apache.maven.plugins</groupId>
				<artifactId>maven-source-plugin</artifactId>
				<version>2.1.1</version>
				<executions>
					<execution>
						<id>attach-sources</id>
						<phase>verify</phase>
						<goals>
							<goal>jar-no-fork</goal>
						</goals>
					</execution>
				</executions>
			</plugin>
		</plugins>
	</build>

 在POM的build元素下的plugins子元素中声明插件的使用

 

对于自定义绑定的插件，用户总是应该声明一个非快照版本，这样可以避免由于插件版本变化造成的构建不稳定性

上述配置：插件声明、插件执行配置

executions下每个execution子元素可以用来配置执行一个任务

该例中配置了一个id为attach-sources的任务，

通过phrase配置，将其绑定到default生命周期的verify阶段上

再通过goals配置指定要执行的插件目标

可以通过对比配置前与配置后 执行mvn install命令的命令行输出

配置前执行 mvn verify

 

配置后执行 mvn verify

 

有时，即使不通过phase元素配置生命周期阶段，插件目标也能够绑定到生命周期中去

如删除上述配置中的phase一行，执行mvn verify，仍可看到maven-source-plugin:jar-no-fork的执行

原因是有很多插件的目标在编写时已经定义了默认绑定阶段

可用maven-help-plugin查看插件详细信息，了解插件目标的默认绑定阶段

 

mvn help:describe -Dplugin=org.apache.maven.plugins:maven-source-plugin:2.1.1 -Ddetail

 输出如下：

 

-X 查看出错信息

-U 强制更新

 可以看到这样一句：

 

Bound to phase: package

 它表示该目标默认绑定的生命周期阶段是package

 

当插件目标被绑定到不同的生命周期阶段的时候，其执行顺序会由生命周期的先后顺序决定

当多个插件目标被绑定到同一个阶段的时候，这些插件声明的先后顺序决定了目标的执行顺序

 

--------------------------

 5.插件配置

完成插件和生命周期绑定后，还可配置插件目标的参数，进一步调整插件目标所执行的任务，

可通过命令行和POM等方式 配置这些参数

命令行插件配置

可以使用-D参数来配置插件目标的参数

maven-surefire-plugin提供了一个maven.test.skip参数，当其值为true时，就会跳过执行测试

mvn install -Dmaven.test.skip=true

注：-D是Java自带的，其功能是通过命令行设置一个Java系统属性，Maven简单地重用了该参数，在准备插件的时候检查系统属性，便实现了插件参数的配置

 

 POM中插件全局变量

 并不是所有的插件参数都适合从命令行配置

有些不会改变或很少改变参数的值，在POM文件中一次性配置就比重复在命令行输入要方便

用户可以在声明插件的时候，对此插件进行一个全局的配置

如：配置maven-compiler-plugin告诉它编译Java 1.5版本的源文件，生成JVM1.5兼容的字节码文件

在POM中对插件进行全局配置

 

	<build>
		<plugins>
			<plugin>
				<groupId>org.apache.maven.plugins</groupId>
				<artifactId>maven-compiler-plugin</artifactId>
				<version>2.1</version>
				<configuration>
					<source>1.5</source>
					<target>1.5</target>
				</configuration>
			</plugin>
		</plugins>
	</build>

 若从命令行指定，如下：

 

 

mvn compile -Dmaven.compiler.compilerVersion=1.5

 疑问：若默认是1.4，此时直接执行 mvn compile会出错，如上述命令，加上参数不会出错，但是执行

mvn install -Dmaven.compiler.compilerVersion=1.5

 此时设置参数无效，还是默认使用1.4，这种情况要怎样设置编译版本呢？

 POM中插件任务配置

除了为插件配置全局参数，用户还可以为某个插件任务配置特定的参数，

例：maven-antrun-plugin，它有一个目标run，可以用来在Maven中调用Ant任务。

用户将maven-antrun-plugin:run绑定到多个生命周期阶段上，再加以不同的配置，就可让Maven在不同的生命阶段执行不同任务。

在POM中对插件进行任务配置

 

	<build>
		<plugins>
			<plugin>
				<groupId>org.apache.maven.plugins</groupId>
				<artifactId>maven-antrun-plugin</artifactId>
				<version>1.3</version>
				<executions>
					<execution>
						<id>ant-validate</id>
						<phase>validate</phase>
						<goals>
							<goal>run</goal>
						</goals>
						<configuration>
							<tasks>
								<echo>I'm bound to validate phase.</echo>
							</tasks>
						</configuration>
					</execution>
					<execution>
						<id>ant-verify</id>
						<phase>verify</phase>
						<goals>
							<goal>run</goal>
						</goals>
						<configuration>
							<tasks>
								<echo>I'm bound to verify phase.</echo>
							</tasks>
						</configuration>
					</execution>
				</executions>
			</plugin>
		</plugins>
	</build>

 注：执行如下命令出错

mvn maven-antrun-plugin:run

错误信息：

[ERROR] No plugin found for prefix 'maven-antrun-plugin' in the current project and in the plugin groups [org.apache.maven.plugins, org.codehaus.mojo] available from the repositories [local (D:\data\win_user\win7_ydc\.m2\repository), central (http://repo.maven.apache.org/maven2)] -> [Help 1]
[ERROR]
[ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
[ERROR] Re-run Maven using the -X switch to enable full debug logging.
[ERROR]
[ERROR] For more information about the errors and possible solutions, please read the following articles:
[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/NoPluginFoundForPrefixException
D:\WorkStation\maven\hello-world>

  --------------------------

6.获取插件信息

 

在线插件信息

主要Maven插件都来自Apache和Codehaus

Apache官方插件

列表：http://maven.apache.org/plugins/index.html

下载：http://repo1.maven.org/maven2/org/apache/maven/plugins/

托管于Codehaus上的Mojo项目也提供了大量Maven插件

列表：http://mojo.codehaus.org/plugins.html

下载：http://repository.codehaus.org/org/codehaus/mojo/

使用maven-help-plugin描述插件

获取插件maven-compiler-plugin 2.1版本的信息

 

mvn help:describe -Dplugin=org.apache.maven.plugins:maven-compiler-plugin:2.1

 截图如下：

 

 

还可以加参数-Ddetail了解更详细

 

mvn help:describe -Dplugin=org.apache.maven.plugins:maven-compiler-plugin:2.1 -Ddetail

 主要包括该插件的坐标、目标前缀各目标

 

目标前缀（Goal Prefix），作用方便在命令行直接运行插件

maven-compiler-plugin的目标前缀是compiler

可以简化命令

 

mvn help:describe -Dplugin=compiler

 如果仅仅描述某个插件的目标信息，加上goal参数

 

 

mvn help:describe -Dplugin=compiler -Dgoal=compile

 如果想输出更详细信息，加上detail参数

 

 

mvn help:describe -Dplugin=compiler -Ddetail

 不明白：此时用目标前缀获取的是最新版本或最新稳定版本，但是用目标前缀查看指定版本是不行的，就只能用全称

 

 

mvn help:describe -Dplugin=org.apache.maven.plugins:maven-compiler-plugin:2.1

 该命令正确

 

 

mvn help:describe -Dplugin=compiler:2.1

 该命令错误

 

--------------------------

7.从命令行调用插件

 

mvn -h

 该命令显示mvn命令帮助

 

可以通过mvn命令激活生命周期阶段，从而执行那些绑定在生命周期阶段上的插件目标

Maven还支持直接从命令行调用插件目标

（因为有些任务不适合绑定在生命周期上，

如maven-help-plugin:describe,maven-dependency-plugin:tree）

 

mvn help:describe -Dplugin=compiler

mvn dependency:tree

 问：help是什么？为什么不是maven-dependency-plugin:tree？

 

 

mvn org.apache.maven.plugins:maven-help-plugin:2.1:describe -Dplugin=complier

mvn org.apache.maven.plugins:maven-dependency-plugin:2.1:tree

 注：上面第一条出错，不知为啥？

 

后两条命令的效果也前两条基本是一样的，显然前两条命令更简洁，更容易记忆和使用

为了达到该目的，Maven引入了目标前缀的概念

格式：

mvn orgId:artifactId:version:goal

 简化为：

 

 

mvn 目标前缀:goal

 

 

--------------------------

8.插件解析机制

插件仓库

与依赖构件一样，插件构件同样基于坐标存储在Maven仓库中

Maven会区别对待依赖的远程仓库与插件的远程仓库（Maven需要的插件在本地仓库不存在时， 它就不会去这些远程仓库查找）

不同于repositories及其repository子元素，插件的远程仓库使用pluginRepositories和pluginRepository配置

如Maven内置了如下的插件远程仓库配置

%M2_HOME%/lib/maven-model-builder-3.0.5.jar中

org\apache\maven\model\pom-4.0.0.xml文件

 

  <pluginRepositories>
    <pluginRepository>
      <id>central</id>
      <name>Central Repository</name>
      <url>http://repo.maven.apache.org/maven2</url>
      <layout>default</layout>
      <snapshots>
        <enabled>false</enabled>
      </snapshots>
      <releases>
        <updatePolicy>never</updatePolicy>
      </releases>
    </pluginRepository>
  </pluginRepositories>

 配置其他的插件仓库，在POM或者settings.xml中加入其他的插件仓库配置

 

插件的默认groupId

在POM中配置插件时，如果该插件是Maven的官方插件（即groupId为org.apache.maven.plugins）,就可以省略goupId配置，如：

	<build>
		<plugins>
			<plugin>
				<artifactId>maven-compiler-plugin</artifactId>
				<version>2.1</version>
				<configuration>
					<source>1.7</source>
					<target>1.7</target>
				</configuration>
			</plugin>
		</plugins>
	</build>

 不推荐

 

解析插件版本

为了简化插件的配置和使用，在用户没有提供插件版本的情况下，Maven会自动解析插件版本

1.Maven在超级POM中为所有核心插件设定了版本，这些插件包括clean、compiler、surefire

2.若使用某个插件时没有设定版本，而这个插件以不属于核心插件范畴，Maven会检查所有仓库中可用版本（Maven2解析机制：最新版本，也可能是快照版；Maven3解析机制：不解析至latest，而使用release），两种机制都有潜在风险

使用插件的时候，应该一直显式地设定版本

解析插件前缀

Maven在解析插件仓库元数据时，会默认使用org.apache.maven.plugins和org.codehaus.jojo两个groupId。

可以通过设置settings.xml让Maven检查其他groupId上的插件仓库元数据

 

<settings>
	<pluginGroups>
		<pluginGroup>com.your.plugins</pluginGroup>
	</pluginGroups>
</settings>

 

 

--------------------------------------------------------------------------------

@author Free Coding http://ln-ydc.iteye.com/