一个简单的魔力

下面列出的是一个没有参数的简单 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." );
    }
}

• 除了方法之外，该类org.apache.maven.plugin.AbstractMojo提供了实现 mojo 所需的大部分基础设施execute。
• 注释 " @Mojo" 是必需的，它控制着 mojo 的执行方式和时间。
• 该execute方法可以抛出两个异常：
  • org.apache.maven.plugin.MojoExecutionException如果出现意外问题。抛出此异常会导致显示“BUILD ERROR”消息。
  • org.apache.maven.plugin.MojoFailureException如果出现预期的问题（例如编译失败）。抛出此异常会导致显示“BUILD FAILURE”消息。
• 该getLog方法（定义在 中AbstractMojo）返回一个类似 log4j 的记录器对象，它允许插件在“调试”、“信息”、“警告”和“错误”级别创建消息。此记录器是向用户显示信息的公认方式。请查看检索 Mojo Logger部分以获取有关其正确使用的提示。

Mojo API 规范描述了所有 Mojo 注释。

缩短命令行

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

• 如果您需要运行安装在本地存储库中的插件的最新版本，则可以省略其版本号。所以只需使用“ mvn sample.plugin:hello-maven-plugin:sayhi”来运行你的插件。
• 您可以为插件分配一个缩短的前缀，例如mvn hello:sayhi. 如果您遵循使用约定${prefix}-maven-plugin（或者maven-${prefix}-plugin如果插件是 Apache Maven 项目的一部分），这将自动完成。您也可以通过额外的配置来分配一个 - 更多信息请参见Plugin Prefix Mapping 简介。
• 最后，您还可以将插件的 groupId 添加到默认搜索的 groupId 列表中。为此，您需要将以下内容添加到您的${user.home}/.m2/settings.xml文件中：

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

此时，您可以使用 " mvn hello:sayhi" 运行 mojo。

将 Mojo 附加到构建生命周期

您还可以配置插件以将特定目标附加到构建生命周期的特定阶段。这是一个例子：

  <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 绑定到生命周期中的各个阶段的更多信息，请参阅构建生命周期文档。

布尔值

这包括类型化的变量boolean和Boolean. 读取配置时，文本“ true”导致参数设置为 true，所有其他文本导致参数设置为 false。例子：

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

<myBoolean>true</myBoolean>

整数

byte这包括类型为 、Byte、int、Integer、long、Long、short和的变量Short。读取配置时，XML 文件中的文本会使用相应类Integer.parseInt()的方法或方法转换为整数值。valueOf()这意味着字符串必须是有效的十进制整数值，仅由数字 0 到 9 组成-，前面有一个可选的负值。例子：

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

<myInteger>10</myInteger>

浮点数字

double这包括类型为 、Double、float和的变量Float。valueOf()读取配置时，使用相应类的方法将 XML 文件中的文本转换为二进制形式。这意味着字符串可以采用 Java 语言规范第 3.10.2 节中指定的任何格式。一些有效值样本是1.0和6.02E+23。

    /**
     * My Double.
     */
    @Parameter
    private Double myDouble;

<myDouble>1.0</myDouble>

日期

这包括类型化的变量Date。读取配置时，XML 文件中的文本使用以下日期格式之一进行转换：“ yyyy-MM-dd HH:mm:ss.S a”（示例日期为“2005-10-06 2:22:55.1 PM”）或“ yyyy-MM-dd HH:mm:ssa”（示例日期为“2005-10-06 下午 2:22:55”）。请注意，解析是使用DateFormat.parse()which 允许格式化的一些宽大处理完成的。如果该方法可以解析指定的日期和时间，即使它与上面的模式不完全匹配，它也会这样做。例子：

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

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

文件和目录

这包括类型化的变量File。读取配置时，XML 文件中的文本用作所需文件或目录的路径。如果路径是相对的（不以 开头/或类似的驱动器C:号），则路径相对于包含 POM 的目录。例子：

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

<myFile>c:\temp</myFile>

网址

这包括类型化的变量URL。读取配置时，使用 XML 文件中的文本作为 URL。格式必须遵循 RFC 2396 指南，并且看起来像任何 Web 浏览器 URL ( scheme://host:port/path/to/file)。在转换 URL 时，对 URL 的任何部分的内容都没有限制。

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

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

纯文本

char这包括类型为 、Character、StringBuffer和的变量String。读取配置时，将 XML 文件中的文本用作要分配给参数的值。对于char和Character参数，只使用文本的第一个字符。

枚举

也可以使用枚举类型参数。首先你需要定义你的枚举类型，然后你可以在参数定义中使用枚举类型：

    public enum Color {
      GREEN,
      RED,
      BLUE
    }

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

所以让我们看看你可以在你的 pom 配置中使用这样的枚举：

<myColor>GREEN</myColor>

您还可以将枚举类型中的元素用作 defaultValues，如下所示：

    public enum Color {
      GREEN,
      RED,
      BLUE
    }

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

数组

数组类型参数是通过多次指定参数来配置的。例子：

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

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

收藏品

此类别涵盖任何实现java.util.Collection如ArrayListor的类HashSet。这些参数是通过多次指定参数来配置的，就像一个数组一样。例子：

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

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

有关各个集合元素映射的详细信息，请参阅映射列表。

地图

此类别涵盖任何实现但未实现的java.util.Map类。这些参数是通过在参数配置的表单中包含 XML 标记来配置的。例子：HashMapjava.util.Properties <key>value</key>

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

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

特性

此类别涵盖了实现的任何地图java.util.Properties。这些参数是通过 <property><name>myName</name> <value>myValue</value> </property> 在参数配置的表单中包含 XML 标记来配置的。例子：

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

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

其他项目类别

此类别涵盖任何不实现java.util.Map、java.util.Collection或的类java.util.Dictionary。例子：

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

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

有关用于配置此类参数的策略的详细信息，请参阅映射复杂对象。