三分钟快速掌握 maven 插件
老铁昨天下午问我什么时候讲讲 Maven 插件：
于是老田搞到大半夜终于写了一篇 maven 的插件，今天分享给大家。
想进一步详聊了请加我微信 tj20120622，进群和大家一起聊技术。
Maven 是一个执行插件的框架，每一个任务实际上是由插件完成的。那么我们今天就来聊聊 Maven 插件。
什么是 Maven 插件？
Maven 实际上只是 Maven 插件集合的核心框架。换句话说，插件是执行大部分实际操作的地方。
插件用于：
创建 jar 文件，
创建 war 文件，
编译代码，
单元测试代码，
创建项目文档等。
插件是 Maven 的核心功能，它允许在多个项目中重用通用的构建逻辑。他们通过在项目描述（项目对象模型（POM））的上下文中执行“操作”（即创建 WAR 文件或编译单元测试）来实现此目的。可以通过一组唯一的参数来自定义插件的行为，这些参数通过每个插件目标（或 Mojo）的描述公开。
一个插件通常提供了一组目标，可使用以下语法来执行：
`mvn [plugin-name]:[goal-name]
`
例如：一个 Java 项目可以使用 Maven 编译器插件来编译目标，通过运行以下命令编译
`mvn compiler:compile
`
插件有哪些类型
Maven 提供以下两种类型插件：
以下是一些常见的插件列表：
例如
我们使用 maven-antrun-plugin 插件在例子中来在控制台打印数据。现在在 C:MVNproject 文件夹 创建一个 pom.xml 文件，内容如下:
`<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
http://maven.apache.org/xsd/m...d">
<modelVersion>4.0.0</modelVersion>
<groupId>com.companyname.projectgroup</groupId>
<artifactId>project</artifactId>
<version>1.0</version>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-antrun-plugin</artifactId>
<version>1.1</version>
<executions>
<execution>
<id>id.clean</id>
<phase>clean</phase>
<goals>
<goal>run</goal>
</goals>
<configuration>
<tasks>
<echo>clean phase</echo>
</tasks>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>
`
接下来，打开命令终端跳转到 pom.xml 所在的目录，并执行下面的 mvn 命令。
`mvn clean
`
Maven 将开始处理并显示 clean 生命周期的 clean 阶段。
`[INFO] Scanning for projects...
[INFO] ------------------------------------------------------------------
[INFO] Building Unnamed - com.companyname.projectgroup:project:jar:1.0
[INFO] task-segment: [post-clean]
[INFO] ------------------------------------------------------------------
[INFO] [clean:clean {execution: default-clean}]
[INFO] [antrun:run {execution: id.clean}]
[INFO] Executing tasks [echo] clean phase
[INFO] Executed tasks
[INFO] ------------------------------------------------------------------
[INFO] BUILD SUCCESSFUL
[INFO] ------------------------------------------------------------------
[INFO] Total time: < 1 second
[INFO] Finished at: Sat Jul 07 13:38:59 IST 2020
[INFO] Final Memory: 4M/44M
[INFO] --------
`
上面的例子展示了以下关键概念：
插件是在 pom.xml 中使用 plugins 元素定义的。
每个插件可以有多个目标。
你可以定义阶段，插件会使用它的 phase 元素开始处理。我们已经使用了 clean 阶段。
你可以通过绑定到插件的目标的方式来配置要执行的任务。我们已经绑定了 echo 任务到 maven-antrun-plugin 的 run 目标。
就是这样，Maven 将处理剩下的事情。它将下载本地仓库中获取不到的插件，并开始处理。
插件与目标
一个插件通常可以完成多个任务，每一个任务就叫做插件的一个目标。如执行mvn install命令时，调用的插件和执行的插件目标如下 ：
将插件绑定到生命周期
Maven 的生命周期是抽象的，实际需要插件来完成任务，这一过程是通过将插件的目标（goal）绑定到生命周期的具体阶段（phase）来完成的。如：将maven-compiler-plugin插件的 compile 目标绑定到 default 生命周期的 compile 阶段，完成项目的源代码编译：
内置绑定
Maven 对一些生命周期的阶段（phase）默认绑定了插件目标，因为不同的项目有 jar、war、pom 等不同的打包方式，因此对应的有不同的绑定关系，其中针对 default 生命周期的 jar 包打包方式的绑定关系如下：
在第二列中，冒号前面是插件的前缀（prefix），是配置和使用插件的一种简化方式；冒号后面即是绑定的插件目标。
你的仓库中有哪些 maven 插件？
`存放目录=%本地仓库 %orgapachemavenplugins
`
Maven 官网上有更详细的官方插件列表：
自定义插件
在前面我们提到了一个 Mojo，Mojo 实际上是一个 Maven 的目标，插件包含任意数量的目标（Mojos）。Mojos 可以定义为带注释的 java 类或 Beanshell 脚本。Mojo 指定有关目标的元数据：目标名称，它适合生命周期的哪个阶段，以及它期望的参数。
Mojo 术语是在 maven2 中引入，它是对如何编写插件的完整重写。Mojo 是对 Pojo（plain-old-java-object）的一种改进，它将 maven 替换为 plain。
一个 Mojo 包含一个简单的 Java 类。插件中多个类似 Mojo 的通用之处可以使用抽象父类来封装。Maven 插件项目的打包方式 packaging 必须为 maven-plugin。
实现自定义插件
创建 maven 项目，添加依赖：
`<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven...d">
<modelVersion>4.0.0</modelVersion>
<groupId>com.tian.maven</groupId>
<artifactId>my-maven-plugin</artifactId>
<packaging>maven-plugin</packaging>
<version>1.0-SNAPSHOT</version>
<name>my-maven-plugin</name>
<url>http://maven.apache.org</url>
<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>3.8.1</version>
<scope>test</scope>
</dependency>
<!--api 依赖-->
<dependency>
<groupId>org.apache.maven</groupId>
<artifactId>maven-plugin-api</artifactId>
<version>3.0</version>
</dependency>
<!--注解支持-->
<dependency>
<groupId>org.apache.maven.plugin-tools</groupId>
<artifactId>maven-plugin-annotations</artifactId>
<version>3.4</version>
<scope>provided</scope>
</dependency>
</dependencies>
</project>
`
TianMojo 继承了 AbstractMojo 这个抽象类，并实现了 execute() 方法，该方法就是用来定义这个 Mojo 具体操作内容，我们只需要根据自己的需要来编写自己的实现即可。
`//自定义插件类
//name 就是后面使用该插件的时候 excuation 里面的
@Mojo(name = "tian")
public class TianMojo extends AbstractMojo
{
// 配置的是本 maven 插件的配置，在 pom 使用 configration 标签进行配置 property 就是名字，
// 在配置里面的标签名字。在调用该插件的时候会看到，还可以设置默认值
@Parameter(property = "userName",defaultValue = "田哥你好")
private String userName;
@Parameter(property = "pwd",defaultValue = "000000")
private String pwd;
@Override
public void execute() throws MojoExecutionException, MojoFailureException {
System.out.println("userm=" + userName + " pwd=" + pwd);
System.out.println("my plugin is running");
}
}
`
然后在执行mvn clean install命令。
使用自定义插件
在我们的 maven 项目添加我们自定义的插件：
`<build>
<plugins>
<plugin>
<groupId>com.tian.maven</groupId>
<artifactId>my-maven-plugin</artifactId>
<version>1.0-SNAPSHOT</version>
<executions>
<execution>
<!-- 表示我们在执行 mvn install 时候就会执行我们自定义的插件 tian-->
<phase>install</phase>
<goals>
<!-- 目标 -->
<goal>tian</goal>
</goals>
</execution>
</executions>
<!-- 我们自定义的 Mojo 中定义的属性 -->
<configuration>
<userName>田维常</userName>
<pwd>123456</pwd>
</configuration>
</plugin>
</plugins>
</build>
`
然后就可以在我们的 IDEA 中看到：
双击my:tian：
还可以使用命令的方式：mvn my:tian
my 是前缀，是 my-maven 的缩写。后缀 tian 就是插件绑定的目标。
到此，我们的自定义 Maven 插件就搞定了。
总结
Maven 插件是 Maven 的核心功能，插件类型有构建类型和报告类型，插件可以有多个目标也就是可以理解为多个功能。自定义插件主要两步：依赖相关 jar 包和重写 Mojo。自定义的插件的使用和我们用其他插件使用一样，只要在 pom 中配置相关<plugin>配置即可。
只有真正理解了插件实现原理后，才能慢慢去体会猜测我们平时使用的那些 mvn...命令背后是如何实现的。
[ 学习是一个人对这个神奇世界不断认识的一个过程]
推荐阅读
版权声明: 本文为 InfoQ 作者【田维常】的原创文章。
原文链接:【http://xie.infoq.cn/article/ab056a47da78d28569ef141f9】。文章转载请联系作者。
关注公众号:Java后端技术全栈,领500G资料 2020.10.24 加入
关注公众号:Java后端技术全栈,领500G资料
评论