Maven插件开发(一)

今天和大家聊一聊Maven中插件开发，在实际工作中，我们经常会用到Maven的插件，但是当一些基本插件功能无法完成我们的需要时或者我们要定制某种需求时，就需要通过自定义Maven插件来完成相关需求，接下来我们便聊聊Maven插件开发。

一、什么是Maven插件

对于Java开发者而言，Maven的使用再熟悉不过了，我们通过Maven进行编译，打包，上传等操作，其实这些都是Maven插件的功能。用官方的话来说，Maven 核心框架就是一个插件的集合。换而言之，这些插件就是行为的执行者。插件是执行大部分实际操作的位置，包括创建jar文件，创建war文件，编译代码，单元测试代码，创建项目文档等。你可以想到的对项目执行的几乎所有操作都是作为Maven插件实现的。

像我们执行的“mvn clean”，其实这个就是Maven插件功能，它是Maven中最简单的插件之一：Clean Plugin。在Maven的清洁插件（Clean Plugin）是负责清除Maven项目的目标目录。它也提供了一些参数配置选项，我们可以在官方文档中查阅到相关的信息。

二、什么是Mojo

在Maven插件开发里面，都是通过Mojo来执行的，那么Mojo又是什么？根据官方的定义，Mojo实际上只是Maven中的一个目标，插件包含许多目标（Mojos）。Mojos可以定义为带注释的Java类或Beanshell脚本。一个Mojo指定的元数据为一个目标 ：一个目标名，即合适的生命周期，和一些期望参数。 简单说就是：每个插件具有一个或一个以上的目标，可以将这些插件的目标绑定到 Maven 生命周期的各个阶段中，或直接从命令行运行这些插件的目标。即：每一个Mojo就是Maven中的一个执行目标（executable goal），而插件是对单个或多个相关的Mojo做统一分发。一个Mojo就是一个简单的Java类。

三、命名规范

在进行Maven插件开发中，我们也需要遵循一些开发规范。

插件命名约定和Apache Maven商标，因此我们通常命名插件都是<yourplugin>-maven-plugin，官方建议我们不要使用maven-<yourplugin>-plugin（注释“ Maven”在插件名称的开头），因为这是由Apache Maven团队使用groupId 维护的官方Apache Maven插件的保留命名模式。使用这种命名模式是对Apache Maven商标的侵犯。org.apache.maven.plugins。

四、Maven生命周期

在开始之前，我们再讲解一下Maven的生命周期，因为在讲解Mojo时，每个目标即可绑定到Maven的生命周期当中。

在Maven有以下三个标准的生命周期：

• clean：项目清理的处理
• default(或 build)：项目部署的处理
• site：项目站点文档创建的处理

每种生命周期都包含一些阶段，clean包含了pre-clean、clean、post-clean阶段；default生命周期主要包含了validate、compile、test、package、verify、install、deploy阶段；site生命周期包含了pre-site、site、post-site、site-deploy阶段。三套生命周期是互相独立的，每种生命周期的阶段是前后依赖的。执行某个阶段，则会先依次执行该生命周期的前面阶段。

1、Clean 生命周期

当我们执行 mvn post-clean 命令时，Maven 调用 clean 生命周期，它包含以下阶段：

阶段	处理	描述
pre-clean	清除之前的操作	执行一些需要在clean之前完成的工作
clean	清除操作	移除所有上一次构建生成的文件
post-clean	清除之后的操作	执行一些需要在clean之后立刻完成的工作

2、Default (Build) 生命周期

这是Maven主要的生命周期，

阶段	处理	描述
validate	校验	校验项目是否正确并且所有必要的信息可以完成项目的构建过程
initialize	初始化	初始化构建状态，比如设置属性值
generate-sources	生成源代码	生成包含在编译阶段中的任何源代码
process-sources	处理源代码	处理源代码，比如说，过滤任意值
generate-sources	生成源代码	生成包含在编译阶段中的任何源代码
process-resources	处理资源文件	复制和处理资源到目标目录，为打包阶段最好准备
compile	编译	编译项目的源代码
process-classes	处理类文件	处理编译生成的文件，比如说对Java class文件做字节码改善优化
generate-test-sources	生成测试源代码	生成包含在编译阶段中的任何测试源代码
process-test-sources	处理测试源代码	处理测试源代码，比如说，过滤任意值
generate-test-resources	生成测试资源文件	为测试创建资源文件
process-test-resources	处理测试资源文件	复制和处理测试资源到目标目录
test-compile	编译测试源码	编译测试源代码到测试目标目录
process-test-classes	处理测试类文件	处理测试源码编译生成的文件
test	测试	使用合适的单元测试框架运行测试（Juint是其中之一）
prepare-package	准备打包	在实际打包之前，执行任何的必要的操作为打包做准备
package	打包	将编译后的代码打包成可分发格式的文件，比如JAR、WAR或者EAR文件
pre-integration-test	集成测试前	在执行集成测试前进行必要的动作。比如说，搭建需要的环境
integration-test	集成测试	处理和部署项目到可以运行集成测试环境中
post-integration-test	集成测试后	在执行集成测试完成后进行必要的动作。比如说，清理集成测试环境
verify	验证	运行任意的检查来验证项目包有效且达到质量标准
install	安装	安装项目包到本地仓库，这样项目包可以用作其他本地项目的依赖
deploy	部署	将最终的项目包复制到远程仓库中与其他开发者和项目共享

注意：当一个阶段通过 Maven 命令调用时，例如 mvn compile，只有该阶段之前以及包括该阶段在内的所有阶段会被执行。

Default (Build) 生命周期里面比较重要的主要包括：validate、compile、test、package、verify、install、deploy阶段。

3、Site 生命周期

Maven Site 插件一般用来创建新的报告文档、部署站点等。

阶段	处理	描述
pre-site	部署前的操作	执行一些需要在生成站点文档之前完成的工作
site	部署操作	生成项目的站点文档
post-site	部署后的操作	执行一些需要在生成站点文档之后完成的工作，并且为部署做准备
site-deploy	部署上传	将生成的站点文档部署到特定的服务器上

五、实战

纸上得来终觉浅，绝知此事要躬行。讲了那么多，我们还是来实际操作一下。

这里我们通过IDEA来创建，更加快捷方便，实际这个就是一个Java的Maven项目工程，只是需要注意package方式为maven-plugin。

在IDEA中依次点击New -> Project -> Maven，勾选Create from archetype，选择maven-archetype-mojo，填写好相关信息，即可创建一个简单的Mojo工程。

这里我创建了一个file-maven-plugin示例，然后生成了一个很简单demo样例。但是生成的样例比较简单是基于JavaDoc的，因为Mojo的配置有两种方式，一种是JavaDoc + Tag，即连接示例代码所使用的方式。另一种是注解，使用@Mojo, @Parameter等annotation来配置。

现在我们都基于注解来实现，所以需要添加注解依赖：

    <!-- dependencies to annotations -->
    <dependency>
        <groupId>org.apache.maven.plugin-tools</groupId>
        <artifactId>maven-plugin-annotations</artifactId>
        <version>3.4</version>
        <scope>provided</scope>
    </dependency>

同时还需要添加plugin依赖，如下：

   <build>
       <plugins>
           <plugin>
               <groupId>org.apache.maven.plugins</groupId>
               <artifactId>maven-plugin-plugin</artifactId>
               <version>3.5</version>
           </plugin>
       </plugins>
   </build>

主要注解就是@Mojo，通过这个注解我们来指定命令名称和绑定周期。

具体代码如下：

package net.anumbrella;


import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;

import java.io.*;


@Mojo(name = "file", defaultPhase = LifecyclePhase.COMPILE)
public class MyMojo extends AbstractMojo {


    public void execute() throws MojoExecutionException, MojoFailureException {
        readFile();
    }

    private void readFile() throws MojoFailureException {
        try {

            InputStreamReader reader = new InputStreamReader(this.getClass().getResourceAsStream("/file.txt"), "utf-8");
            //创建字符流缓冲区
            BufferedReader bufr = new BufferedReader(reader);
            String line;
            while ((line = bufr.readLine()) != null) {
                getLog().info(line);
            }
            reader.close();

        } catch (Exception e) {
            throw new MojoFailureException("读取file信息出错", e);
        }
    }
}

具体的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/maven-v4_0_0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>net.anumbrella</groupId>
    <artifactId>file-maven-plugin</artifactId>

    <packaging>maven-plugin</packaging>

    <version>1.0-SNAPSHOT</version>

    <name>file-maven-plugin Maven Mojo</name>

    <url>http://maven.apache.org</url>

    <dependencies>
        <dependency>
            <groupId>org.apache.maven</groupId>
            <artifactId>maven-plugin-api</artifactId>
            <version>3.0</version>
        </dependency>

        <!-- dependencies to annotations -->
        <dependency>
            <groupId>org.apache.maven.plugin-tools</groupId>
            <artifactId>maven-plugin-annotations</artifactId>
            <version>3.4</version>
            <scope>provided</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-plugin-plugin</artifactId>
                <version>3.5</version>
            </plugin>
        </plugins>
    </build>
</project>

这里做的非常的简单，仅仅是读取resources文件下的file.txt文件并打印出来。

file.txt的内容也非常简单，如下：

接着我们安装到本地mvn clean install，然后我们执行按下面的规范执行命令即可。

mvn groupId:artifactId:version:goal

转换为刚才新建的file-maven-plugin即为：

mvn net.anumbrella:file-maven-plugin:1.0-SNAPSHOT:file

可以看到最后输出了结果如下：

在具体项目中我们引入插件

   <plugin>
       <groupId>net.anumbrella</groupId>
       <artifactId>file-maven-plugin</artifactId>
       <version>1.0-SNAPSHOT</version>
   </plugin>

因为是按规范开发的，所以我们能够按照简写执行命令：

mvn file:file

到这里我们Maven插件的开发算是入门了，但是这只是最基本的demo功能，下一篇我将介绍一下maven插件开发的高级功能，包括如何传参，调试，并扩展分析一下maven-compiler-plugin插件的功能。

代码实例：Chapter1

参考

• http://maven.apache.org/plugin-developers/index.html
• Maven 构建生命周期