Maven插件的安装及使用

maven插件主要是为maven中生命周期中的阶段服务的，maven中只是定义了3套生命周期，以及每套生命周期中有哪些阶段，具体每个阶段中执行什么操作，完全是交给插件去干的。

maven中的插件就相当于一些工具，比如编译代码的工具，运行测试用例的工具，打包代码的工具，将代码上传到本地仓库的工具，将代码部署到远程仓库的工具等等，这些都是maven中的插件。

插件可以通过mvn命令的方式调用直接运行，或者将插件和maven生命周期的阶段进行绑定，然后通过mvn 阶段的方式执行阶段的时候，会自动执行和这些阶段绑定的插件。

插件目标

maven中的插件以jar的方式存在于仓库中，和其他构件是一样的，也是通过坐标进行访问，每个插件中可能为了代码可以重用，一个插件可能包含了多个功能，比如编译代码的插件，可以编译源代码、也可以编译测试代码；插件中的每个功能就叫做插件的目标（Plugin Goal），每个插件中可能包含一个或者多个插件目标（Plugin Goal）。

目标参数

插件目标是用来执行任务的，那么执行任务肯定是有参数配的，这些就是目标的参数，每个插件目标对应于java中的一个类，参数就对应于这个类中的属性。

列出插件所有目标

上面插件前缀的先略过，我们先看第一种效果。

如：

上面列出了maven-clean-plugin这个插件所有的目标，有2个，分别是clean:clean、clean:help，分号后面的部分是目标名称，分号前面的部分是插件的前缀，每个目标的后面包含对这个目标的详细解释说明，关于前缀的后面会有详细介绍。

查看插件目标参数列表

上面命令中的-Ddetail用户输出目标详细的参数列表信息，如果没有这个，目标的参数列表不会输出出来，看效果。

如：

上面列出了clean插件的help目标的详细参数信息。

注意上面参数详细参数说明中有Expression: x x x 这 样 的 部 分 ， 这 种 表 示 给 这 个 运 行 的 目 标 传 参 ， 可 以 通 过 m v n − D x x x 这 种 方 式 传 参 ， x x x 为 {xxx}这样的部分，这个xxx有时候和目标参数的名称不一致，所以这点需要注意，运行带参数的目标，看一下效果：

上面传了一个detail=false，上面未输出目标的详细参数信息。

命令行运行插件

案例：

maven中运行测试用例使用到的插件坐标是：

我们看一下这个插件有哪些目标：

maven-surefire-plugin插件有2个目标help和test，描述中可以看出test目标是用来运行测试用例的。

我们看一下test目标对应的参数列表：

test目标对应的参数太多，我们只列出了部分参数，如下：

大家认真看一下skip这个参数说明，这个参数默认是false，如果设置为true的时候，项目将跳过测试代码的编译和测试用例的执行，可以maven.test.skip这个属性来进行命令行传参，将其传递给test目标的skip属性，这个通过-D传递的参数名称就和目标参数名称不一样了，所以需要注意-D后面并不一定是参数名称。

我们来运行一下test目标看看效果。

先看一下不加参数的效果：

加maven.skip.test=true的效果如下：

对比一下上面2个输出，下面的多了一行如下：

说明跳过了测试的执行。

插件传参的2种方式

刚才上面讲了一种通过-D后面跟用户属性的方式给用户传参，还有一种方式，在pom.xml中properties的用户自定义属性中进行配置，如下：

修改项目maven-chat06的pom.xml，properties中加入：

cmd中运行：

效果如下：

输出中也有Tests are skipped.，说明也跳过了测试，和-Dmaven.test.skip=true效果一样。

上面说的都是插件目标的东西，那么插件目标是如何和生命周期关联起来的呢？继续向下看。

获取插件目标详细描述信息的另外一种方式

上面这个命令调用的是help插件的describe这个目标，这个目标可以列出其他指定插件目标的详细信息，看效果：

可以拿这种和上面获取插件目标参数详情列表对比一下，上面这个更详细一些，参数说明中多了一行User property: 属性名称，这个属性名称可以通过两种方式传递：

• mvn命令-D属性名称的方式传递
• pom.xml中properties中定义的方式指定。

现在可以大家估计可以知道我们一直用的-Dmaven.test.skip为什么可以跳过测试代码的编译和单元测试的执行了吧。

插件前缀

运行插件的时候，可以通过指定插件坐标的方式运行，但是插件的坐标信息过于复杂，也不方便写和记忆，所以maven中给插件定义了一些简捷的插件前缀，可以通过插件前缀来运行指定的插件。

可以通过下面命令查看到插件的前缀：

示例效果：

输出中的Goal Prefix:部分对应的就是插件的前缀，上面这个插件的前缀是surefire。

我们使用前缀来运行一下插件感受一下效果：

上面通过别名来运行插件maven-surefire-plugin的test目标，是不是简洁了很多。

上面用了很多mvn help:这个命令，这个调用的是maven-help-plugin插件的功能，help是插件的前缀，它的坐标是：

插件和生命周期阶段绑定

maven只是定义了生命周期中的阶段，而没有定义每个阶段中具体的实现，这些实现是由插件的目标来完成的，所以需要将阶段和插件目标进行绑定，来让插件目标帮助生命周期的阶段做具体的工作，生命周期中的每个阶段支持绑定多个插件的多个目标。

当我们将生命周期中的阶段和插件的目标进行绑定的时候，执行mvn 阶段就可以执行和这些阶段绑定的插件目标。

maven内置插件以及绑定

maven为了让我们不用做任何配置就可以实现一些项目的构建操作，比如运行mvn clean就可以帮我们清理代码，运行mvn install就可以将构件安装到本地仓库，所以maven帮我们做了一些事情，maven内部已经提供了很多默认的插件，而将一些阶段默认和这些插件阶段绑定好了，所以我们不用做任何配置就可以执行清理代码、编译代码、测试、打包、安装到本地仓库、上传到远程仓库等阶段的操作，是因为maven已经默认给这些阶段绑定好了插件目标，所以不需要我们再去配置，就直接可以运行，这些都是maven内置绑定帮我们做的事情，我们来看看maven有哪些内置绑定。

maven内置绑定
clean生命周期阶段与插件绑定关系

clean周期中只有clean阶段默认绑定了maven-clean-plugin插件的clean目标。maven-clean-plugin插件的clean目标作用就是删除项目的输出目录。

default生命周期阶段与插件绑定关系
default生命周期中有23个阶段，我只列出有默认绑定的，其他的没有列出的没有绑定任何插件，因此没有任何实际的行为。

site生命周期阶段与插件绑定关系

来几个案例解说一下。

mvn clean
该命令是调用clean生命周期的clean阶段，实际执行的阶段为clean生命周期中的pre-clean和clean阶段，从上面内置绑定表格中找一下，可以看到只有clean阶段绑定了maven-clean-plugin插件的clean目标，所以运行mvn clean的时候，实际上会调用maven-clean-plugin插件的clean目标来清理代码。

运行一下看一下效果：

上面有一行输出如下：

这个表示调用的插件是：maven-clean-plugin，版本是：2.5，插件的目标是：clean

该命令调用default生命周期的test阶段，实际上会从default生命周期的第一个阶段（validate）开始执行一直到test阶段结束。这里面包含了代码的编译，运行测试用例。还是和上面的分析过程一样，对照上面表格中的绑定关系，可以得到mvn test会调用下面一些插件的目标：

我们来验证一下，看看是不是和我们分析的一样：

从上面输出中可以看到调用了5个插件的目标，和分析的一样。

再来看一个跳过测试的例子，如下：

上面这个是不是很熟悉，经常用到的跳过测试，为什么这么写，我想大家都知道了吧。

其他几个mvn compile、mvn install、mvn deploy建议大家也自己去玩玩，加深理解。

自定义绑定

除了默认绑定的一些操作，我们自己也可以将一些阶段绑定到指定的插件目标上来完成一些操作，这种自定义绑定让maven项目在构件的过程中可以执行更多更丰富的操作。

常见的一个案例是：创建项目的源码jar包，将其安装到仓库中，内置插件绑定关系中没有涉及到这一步的任务，所以需要用户自己配置。

插件maven-source-plugin的jar-no-fork可以帮助我们完成该任务，我们将这个目标绑定在default生命周期的verify阶段上面，这个阶段没有任何默认绑定，verify是在测试完成之后并将构件安装到本地仓库之前执行的阶段，在这个阶段我们生成源码，配置如下：

在maven-chat06中的pom.xml加入如下配置：

注意上面配置的attach-source，后面输出中会有。

id：任务的id，需唯一，如果不指定，默认为default。

每个插件的配置在pom.xml的plugins元素中只能写一次，否则会有警告。

最终pom.xml如下：

运行下面命令：

效果：

上面有个输出如下：

可以看出调用了我们配置的插件生成源码jar，上面的括号中的attach-source就是pom.xml中配置的任务id。

最后有个输出：

可以看到将源码安装到本地仓库了。

有些插件的目标默认会绑定到一些生命周期的阶段中，那么如果刚好插件默认绑定的阶段和上面配置的一致，那么上面phase元素可以不写了，那么怎么查看插件的默认绑定呢？

我们看一下插件source的jar-no-fork目标默认的绑定：

上面输出中有个Bound to phase: package，表示默认绑定在了package阶段上。

我们知道3套生命周期的运行时没有依赖的，但是每套中的阶段是有先后顺序的，运行某个阶段的时候，会先执行他前面所有的阶段。清理代码使用的是clean周期中的clean阶段，编译代码用的是default周期中的compile阶段，当直接运行mvn compile编译代码的时候并不会去清理代码，编译代码的时候若发现文件没有变动，会跳过没有变化的文件进行编译。如果我们想每次编译之前强制先清理代码，我们经常这么写：

上面的写法是不是很熟悉，运行一下看看效果：

还有其他方式么？

我们刚才学了自定义绑定，我们可以在default生命周期的第一个阶段validate绑定清理代码的插件，那我们来通过自定义绑定来实现一下，project->build->plugins元素中加入下面配置：

运行下面命令看效果：

输出中有：

这个表示运行了代码清理的功能，进行了代码清理，是不是感觉很爽，不用每次都写clean了。

POM.xml插件配置详解

插件目标共享参数配置

build->plugins->plugin中配置：

configuration节点下配置目标参数的值，节点名称为目标的参数名称，上面这种配置对当前插件的所有目标起效，也就是说这个插件中所有的目标共享此参数配置。

案例：
将案例中的pom.xml中的build元素修改成下面这样。

运行下面命令，看效果：

可以看到Test are skipped，说明跳过了测试，到此为止，跳过测试已经讲了3种了：

上面这个配置参数方式对当前插件的所有目标有效，如果想对指定的目标进行配置呢，用下面的方式。

插件目标参数配置

project->build->plugins->plugin->executions->execution元素中进行配置，如下：

上面这种配置常用于自定义插件绑定，只对当前任务有效。

感受一下效果，将pom.xml中的build元素改为下面内容：

上面自定义了一个绑定，在clean周期的pre-clean阶段绑定了插件maven-surefire-plugin的两个目标test和help，execution元素没有指定id，所以默认id是default。

运行下面命令，见效果：

可以看到上面输出中运行了插件的两个目标，和预期结果一致。

获取maven插件信息

上面我们介绍了，可以通过下面命令获取插件详细介绍信息

更多maven插件的帮助文档可以参考maven的官方网站，上面有详细的介绍，建议大家去看看，地址：http://maven.apache.org/plugins/

插件解析机制

为了方便用户使用和配置插件，maven不需要用户提供完整的插件坐标信息，就可以解析到正确的插件，不过我建议使用插件配置的时候最好还是配置完整的坐标信息，不然不利于新人的理解和问题的排查。

插件仓库

与其他maven构件一样，插件构件也是基于坐标存储在maven仓库中，有需要的时候，maven会从本地查找插件，如果不存在，则到远程仓库查找，找到了以后下载到本地仓库，然后使用。

大家回忆一下，上一章讲过的，pom.xml中可以配置依赖的构件的仓库地址，如下：

但是插件仓库的配置和这个有一点不一样，插件的是在pluginRepositories->pluginRepository元素中配置的，如下：

看一下上面2段配置，repository中的配置和pluginRepository中的子元素是一样的，这个主意下就可以了。

插件的默认groupId

在pom.xml中配置插件的时候，如果是官方的插件，可以省略groupId。

案例：

修改本篇示例中的pom.xml，如下：

上面用到了maven-compiler-plugin，这个插件是编译代码的，是maven官方提供的插件，我们省略了groupId。

上面这个插件用于编译代码的，编译代码的时候需要指定编译器的版本，源码的版本，目标代码的版本，都是用的是1.8。

大家回头去看一下，文章最开始的时候，在properties中有几个属性值是1.8的配置，这几个值默认会被maven-compiler-plugin这个插件的上面3个参数获取，具体可以去看一下这个插件compile目标的参数说明。

运行下面命令：

可以看到可以正常运行。

上面pom.xml省略了插件的groupId配置，如下：

maven在解析该插件的时候，会自动给这个插件补上默认的官方的groupId，所以可以正常运行，但是不建议大家这么使用，容易让新手比较懵逼。

插件前缀的解析

前面说过了使用mvn命令调用插件的时候，可以使用插件的前缀来代替繁琐的插件坐标的方式，那么maven是如何根据插件的前缀找到对应的插件的呢？

插件前缀与插件groupId:artifactId是一一对应的关系，这个关系的配置存储在仓库的元数据中，元数据位于下面2个xml中：

接几个图，大家感受一下：

也可以通过在settings.xml中配置，让maven检查其他grouId上的插件元数据中前缀和插件关系的配置，如下：

pluginGroups中有多个pluginGroup，可以配置你自己插件的元数据所在的groupId，然后可以通过前缀来访问你自己的插件元数据目录，此处先不细说，这个后面文章中讲自定义插件的时候会再次说明。

查看项目最终pom.xml文件

我们的pom.xml默认会继承maven顶级的一个父类pom.xml，顶级的pom.xml中指定了很多默认的配置，如生命周期中的阶段和很多插件的绑定，这些如果我们想看到，到哪里看呢？

mvn命令在项目中执行的时候，我们的pom.xml和父类的pom.xml最终会进行合并，当我们的pom.xml写的比较复杂的时候，最终合并之后是什么效果呢，我们可以通过下面这个命令查看：

效果：

上面我们将命令产生的结果输出到项目的1.xml文件中了，我们看一下项目的1.xml的内容：

上面这个文件，大家一定要认真多看几遍，理解一下，里面包含太多东西，再重复一下，上面的文件多看几遍！多看几遍！多看几遍！要理解！

到此这篇关于Maven插件的安装及使用的文章就介绍到这了,更多相关Maven插件内容请搜索服务器之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持服务器之家！

原文链接：https://blog.csdn.net/m0_47157676/article/details/108506546