快速开始

一个简单的Mojo

下面列出的是一个没有参数的简单mojo类。下面是对源的各个部分的描述。

package sample.plugin;

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

/**
 * Says "Hi" to the user.
 *
 */
@Mojo( name = "sayhi")
public class GreetingMojo extends AbstractMojo
{
    public void execute() throws MojoExecutionException
    {
        getLog().info( "Hello, world." );
    }
}

• 除了execute方法之外，org.apache.maven.plugin.AbstractMojo类提供了实现mojo所需的大部分基础结构。
• 注释@Mojo是必需的，并控制执行mojo的方式和时间。
• execute方法可以抛出两个异常：
  • 如果发生意外问题抛出org.apache.maven.plugin.MojoExecutionException异常会导致显示BUILD ERROR消息。
  • 如果发生预期问题（例如编译失败），抛出org.apache.maven.plugin.MojoFailureException异常会导致显示BUILD FAILURE消息。
• getLog方法（在AbstractMojo中定义）返回一个类似log4j的logger对象，它允许插件以debug，info，warn和error的级别创建消息。该记录器被用于向用户显示信息。可查看检索Mojo Logger部分了解其正确用法。

所有Mojo注解都由Mojo API规范描述。

短命令模式

有几种方法可以减少命令所需的输入量：

• 如果需要运行本地存储库中安装最新版本的插件，则可以省略其版本号。所以只需使用mvn sample.plugin:hello-maven-plugin:sayhi来运行你的插件。
• 你可以为插件指定一个缩短的前缀，例如mvn hello:sayhi。如果你遵循使用${prefix}-maven-plugin 或 maven-${prefix}-plugin（插件是Apache Maven项目的一部分）的约定，则会自动完成此操作。你还可以通过其他配置分配一个特定前缀 - 有关更多信息，请参阅插件前缀映射简介。

• 最后，你还可以将插件的groupId添加到默认搜索的groupId列表中。为此，你需要将以下内容添加到${user.home}/.m2/settings.xml文件中:

  <pluginGroups>
    <pluginGroup>sample.plugin</pluginGroup>
  </pluginGroups>
  

将Mojo附加到构建生命周期

你还可以配置插件以将特定goal附加到构建生命周期的特定phase。这是一个例子：

  <build>
    <plugins>
      <plugin>
        <groupId>sample.plugin</groupId>
        <artifactId>hello-maven-plugin</artifactId>
        <version>1.0-SNAPSHOT</version>
        <executions>
          <execution>
            <phase>compile</phase>
            <goals>
              <goal>sayhi</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>

这导致在编译Java代码时执行简单的mojo。有关将mojo绑定到生命周期中的阶段的更多信息，请参阅Build Lifecycle文档。

在Mojo中定义参数

定义参数就像在mojo中创建实例变量并添加适当的注释一样简单。下面列出的是简单mojo的参数示例：

    /**
     * The greeting to display.
     */
    @Parameter(property = "sayhi.greeting", defaultValue = "Hello World!")
    private String greeting;

注释之前的部分是参数的描述。参数注解将变量标识为mojo参数，注解的defaultValue参数定义变量的默认值。该值可以包括引用项目的表达式，例如${project.version}（更多表达式可以在“参数表达式”文档中找到）。property参数可用于允许通过引用用户通过-D选项设置的系统属性从命令行配置mojo参数。

配置项目中的参数

配置插件的参数值是在Maven项目中的pom.xml文件中完成的，作为在项目中定义插件的一部分。配置插件的示例：

<plugin>
  <groupId>sample.plugin</groupId>
  <artifactId>hello-maven-plugin</artifactId>
  <version>1.0-SNAPSHOT</version>
  <configuration>
    <greeting>Welcome</greeting>
  </configuration>
</plugin>

在配置部分中，元素名称（greeting）是参数名称，元素的内容（Welcome）是要分配给参数的值。

注意：可以在配置插件指南中找到更多详细信息。

具有一个值的参数类型

下面列出了各种类型的简单变量，它们可以用作mojos中的参数，以及有关如何解释POM中的值的任何规则。

    /**
     * My boolean.
     */
    @Parameter
    private boolean myBoolean;

<myBoolean>true</myBoolean>

    /**
     * My Integer.
     */
    @Parameter
    private Integer myInteger;

<myInteger>10</myInteger>

    /**
     * My Date.
     */
    @Parameter
    private Date myDate;

<myDate>2005-10-06 2:22:55.1 PM</myDate>

    /**
     * My File.
     */
    @Parameter
    private File myFile;

<myFile>c:\temp</myFile>

    /**
     * My URL.
     */
    @Parameter
    private URL myURL;

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

    public enum Color {
      GREEN,
      RED,
      BLUE
    }

    /**
     * My Enum
     */
    @Parameter
    private Color myColor;

<myColor>GREEN</myColor>

    public enum Color {
      GREEN,
      RED,
      BLUE
    }

    /**
     * My Enum
     */
    @Parameter(defaultValue = "GREEN")
    private Color myColor;

具有多个值的参数类型

下面列出了各种类型的复合对象，它们可以用作mojos中的参数，以及有关如何解释POM中的值的任何规则。通常，为保存参数值而创建的对象的类（以及参数值中每个元素的类）的确定如下（产生有效类的第一步）：

1. 如果XML元素包含implementation提示属性，则使用该属性
2. 如果XML标记包含.，请将其作为完全限定的类名称
3. 尝试将XML标记（带大写的第一个字母）作为与正在配置的mojo/object相同的包中的类
4. 对于数组，请使用数组的组件类型（例如，对String []参数使用String）;对于集合和映射，使用mojo配置中为集合或映射指定的类;将String用于集合中的条目和映射中的值

一旦定义了元素的类型，XML文件中的文本就会转换为适当类型的对象

    /**
     * My Array.
     */
    @Parameter
    private String[] myArray;

<myArray>
  <param>value1</param>
  <param>value2</param>
</myArray>

    /**
     * My List.
     */
    @Parameter
    private List myList;

<myList>
  <param>value1</param>
  <param>value2</param>
</myList>

    /**
     * My Map.
     */
    @Parameter
    private Map myMap;

<myMap>
  <key1>value1</key1>
  <key2>value2</key2>
</myMap>

    /**
     * My Properties.
     */
    @Parameter
    private Properties myProperties;

<myProperties>
  <property>
    <name>propertyName1</name>
    <value>propertyValue1</value>
  <property>
  <property>
    <name>propertyName2</name>
    <value>propertyValue2</value>
  <property>
</myProperties>

    /**
     * My Object.
     */
    @Parameter
    private MyObject myObject;

<myObject>
  <myField>test</myField>
</myObject>