maven学习笔记--常用插件(plugins)和目标(goals)

Maven 的核心其实不做什么实际的事情，除了解析一些 XML 文档，管理生命周期与插件之外。Maven 被设计成将主要的职责委派给一组 Maven 插件，这些插件可以影响 Maven 生命周期，提供对目标的访问。绝大多数 Maven 的动作发生于Maven 插件的目标，如编译源码，打包二进制代码，发布站点和其它构建任务。

一个Maven插件是一个单个或多个目标的集合，Maven插件的例子有一些简单但核心的插件，像Jar插件，它包含了一组创建JAR文件的目标，Compiler插件，它包含了一组编译源代码和测试代码的目标，或者Surefire插件，它包含一组运行单元测试和生成测试报告的目标。

一个目标是一个明确的任务，它可以作为单独的目标运行，或者作为一个大的构建的一部分和其它目标一起运行,目标的例子包括Compiler插件中的目标，它用来编译项目中的所有目标，用来运行单元测试。目标通过配置属性进行配置，以用来定制行为。例如，Compiler插件的compile目标定义了一组配置参数，它们允许你设置目标JDK版本或者选择是否用编译优化。

1. help插件

你需要一个工具来帮助你理解一些Maven使用的模型，以及某个插件有什么可用的目标。Maven Help插件能让你列出活动的Maven Profile，显示一个实际POM（effective POM），打印实际settings（effective settings），或者列出Maven插件的属性。  Maven Help 插件有四个目标。前三个目标是—— active-profiles, effective-pom 和effective-settings —— 描述一个特定的项目，它们必须在项目的目录下运行。 最后一个目标—— describe ——相对比较复杂，展示某个插件或者插件目标的相关信息。
help:active-profiles 列出当前构建中活动的Profile（项目的，用户的，全局的）。

help:effective-pom 显示当前构建的实际POM，包含活动的Profile。

help:effective-settings 打印出项目的实际settings, 包括从全局的settings和用户级别settings继承的配置。

help:describe 描述插件的属性。它不需要在项目目录下运行。但是你必须提供你想要描述插件的 groupId 和 artifactId。
当你开始使用Maven。

你会试图获得Maven插件的信息：插件如何工作？配置参数是什么？目标是什么？ 你会经常使用 help:describe 目标来获取这些信息。通过 plugin 参数你可以指定你想要研究哪个插件，你可以传入插件的前缀（如help 插件就是 maven-help-plugin），或者可以是 groupId:artifact[:version]这里 version 是可选的。

比如， 下面的命令使用 help 插件的目标来输出Maven Help 插件的信息。

mvn help:describe -Dplugin=help

通过设置plugin参数来运行describe目标，输出为该插件的Maven坐标，目标前缀，和该插件的一个简要介绍。如果你想要 Help 插件输出完整的带有参数的目标列表，只要运行带有参数full的help:describe 目标就可以了,

mvn help:describe -Dplugin=help -Dfull

该选项能让你查看插件所有的目标及相关参数。但是有时候这些信息显得太多了。这时候你可以获取单个目标的信息，设置 mojo 参数和参数。下面的命令列出了Compiler 插件的compile目标的所有信息(在maven里一个插件目标也被认为是一个mojo)

mvn help:describe -Dplugin=compiler -Dmojo=compile -Dfull

2. archetype插件

3. exec插件

exec 插件允许你运行 Java 类和其它脚本。 它不是 Maven 核心插件，但它可以从Codehaus3 的 Mojo4 项目得到。想要查看 Exec 插件的完整描述，运行：mvn help:describe -Dplugin=exec -Dfull

这会列出所有 Maven Exec 插件可用的目标。 Help 插件同时也会列出 Exec 插件的有效参数，如果你想要定制 Exec 插件的行为，传入命令行参数，你应该使用help:describe 提供的文档作为指南。

 Exec 插件让我们能够在不往 classpath 载入适当的依赖的情况下，运行这个程序。 在任何其它的构建系统能够中，我们必须复制所有程序依赖到类似于 lib/ 的目录，这个目录包含一个 JAR 文件的集合。

4. dependency插件

maven Dependency 插件来打印出已解决依赖的列表。

mvn dependency:analyze

mvn dependency:resolve

将会打印出最终的你项目编译所基于的所有依赖的组合

mvn dependency:tree 

将打印项目的整个依赖树想要查看完整的依赖踪迹，包含那些因为冲突或者其它原因而被拒绝引入的构件，

打开 Maven 的调试标记运行mvn install -X
有一个目标比较有用，就是将maven项目的依赖jar到出来：mvn dependency:copy-dependencies

a. 导出到默认目录 targed/dependency     

从Maven项目中导出项目依赖的jar包：进入工程pom.xml 所在的目录下， 执行如下命令：

mvn dependency:copy-dependencies

或在eclipse中，选择项目的pom.xml文件， 点击右键菜单中的Run As,见下图红框中，在弹出的Configuration窗口中，

输入 dependency:copy-dependencies 后，点击运行   

maven项目所依赖的jar包会导出到targed/dependency目录中。

b.导出到自定义目录中

在maven项目下创建lib文件夹，输入以下命令：即可将maven项目所依赖的jar包都会复制到项目目录下的lib目录下

mvn dependency:copy-dependencies -DoutputDirectory=lib

同时 设 置依赖级别，通常使用compile级别

mvn dependency:copy-dependencies -DoutputDirectory=lib   -DincludeScope=compile

5. surefire插件 

Maven Surefire 插件有一个 test 目标，该目标被绑定在了 test 阶段。 

test 目标执行项目中所有能在 src/test/java 找到的并且文件名与 **/Test*.java， **/*Test.java 匹配的所有单元测试 ,

在 Maven Surefire 插件执行 JUnit 测试的时候，它同时也在 /target/surefire-reports 

目录下生成 XML 和常规文本报告。 

如果你的测试失败了，你可以去查看这个目录，里面有你单元测试生成的异常堆栈信息和错误信息。

当Maven 遇到一个测试失败，它默认的行为是停止当前的构建。 如果你希望继续构建项目，即使 Surefire 插件

遇到了失败的单元测试，你就需要设置 Surefire 的testFailureIgnore 这个配置属性为 true。

<project>
	[...]
	<build>
		<plugins>
			<plugin>
				<groupId>org.apache.maven.plugins</groupId>
				<artifactId>maven-surefire-plugin</artifactId>
				<configuration>
					<testFailureIgnore>true</testFailureIgnore>
				</configuration>
			</plugin>
		</plugins>
	</build>
	[...]
</project>

这个表达式可以从命令行通过 -D 参数设置。mvn test -Dmaven.test.failure.ignore=true

Maven 提供了跳过单元测试的能力，只需要使用 Surefire 插件的 skip 参数。 在命令行，只要简单的给任何目标添加
maven.test.skip 属性就能跳过测试：mvn install -Dmaven.test.skip=true

另一种配置 Maven 跳过单元测试的方法是给你项目的 pom.xml 添加这个配置

<project>
	[...]
	<build>
		<plugins>
			<plugin>
				<groupId>org.apache.maven.plugins</groupId>
				<artifactId>maven-surefire-plugin</artifactId>
				<configuration>
					<skip>true</skip>
				</configuration>
			</plugin>
		</plugins>
	</build>
	[...]
</project>

6. assembly插件

Maven Assembly 插件是一个用来创建你应用程序特有分发包的插件。 你可以使用 Maven Assembly 插件

以你希望的任何形式来装配输出，只需定义一个自定义的装配描述符,即可生成一个可分发的JAR文件，该文件包含

了项目的二进制文件和所有的依赖。

要配置 Maven Assembly 插件， 需要在 pom.xml 中的build 配置中添加如下的 plugin 配置。如下图所示

<project>
	[...]
	<build>
		<plugins>
			<plugin>
				<artifactId>maven-assembly-plugin</artifactId>
				<configuration>
					<descriptorRefs>
						<descriptorRef>jar-with-dependencies</descriptorRef>
					</descriptorRefs>
				</configuration>
			</plugin>
		</plugins>
	</build>
	[...]
</project>

添加好这些配置以后，你可以通过运行 mvn assembly:assembly来构建这个装配。 将工程依赖的jar包和工程都打成一个jar打包

在 target/***-1.0-jar-with-dependencies.jar 装配好之后， 我们可以在命令行重新运行 Main 类

java -cp **-1.0-jar-with-dependencies.jar *.*.Main

7. jetty插件

8. tomcat插件

9. source插件

10. compiler插件

用于编译源代码，默认在compile阶段被调用。两个goal，compiler:compile/compiler:testCompile

windows平台默认使用GBK编码，如果工程编码为utf8，也需要在compiler插件中指出，否则按GBK编码，也会出问题

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-compiler-plugin</artifactId>
    <version>3.3</version>
    <configuration>
        <!--源码的Java版本-->
        <source>1.7</source>
        <!--运行环境的Java版本-->
        <target>1.7</target>
	<encoding>UTF8</encoding>
    </configuration>
</plugin>

11、Resource插件

<filters>
			<filter>${user.home}/asssd.properties</filter>
		</filters>
		<resources>
			<resource>
				<directory>src/main/resources</directory>
				<filtering>true</filtering>
				<includes>
					<include>**/*</include>
				</includes>
			</resource>
			<resource>
				<directory>src/main/java</directory>
				<includes>
					<include>**.xml</include>
				</includes>
			</resource>
		</resources>

运行打包命令时，将src/main/resources中的所有文件和src/main/java目录下的所有.xml文件打到jar包中。
其中filters过滤器的作用是将所有引用文件中的${变量名称}，替换成antx.properties文件中的变量值。要使用过滤器时，首先需要设置过滤器：
<filters>    
       <filter>${user.home}/antx.properties</filter>
</filters>
然后再启动过滤器, true需要过滤，false不需要过滤：
<filtering>true</filtering>