如何在Maven Mojo参数中使用Java枚举？

问题描述 #

我正在构建一个自定义Maven插件，希望将Mojo的某个配置参数设置为Java枚举类型。网上搜索大量资料后，仅看到MNG-4292工单暗示该功能可行，但未找到具体实现方法。

我创建了如下枚举：

public enum MyEnum {
    NONE,
    DIRECT,
    INCREMENT
}

随后在@Parameter注解中使用该枚举：

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 org.apache.maven.plugins.annotations.Parameter;
import java.util.Enumeration;
import java.util.Properties;

/**
 * My Mojo.
 */
@Mojo(name = "sync", defaultPhase = LifecyclePhase.GENERATE_RESOURCES, threadSafe = true)
public class MyMojo extends AbstractMojo {

  @Parameter(defaultValue = MyEnum.DIRECT)
  private MyEnum pickOne;

  // ... 其他代码
}

IDE报错：

Type mismatch: cannot convert from MyEnum to String

请问是否可以在Maven Mojo参数中使用Java枚举？若可以，正确的实现方式是什么？

解决方案 #

可以在Maven Mojo参数中使用Java枚举，问题出在@Parameter注解的defaultValue属性——它要求传入字符串类型的值，而你直接传递了枚举实例。

正确实现方式如下：

1. 修正defaultValue的写法
   将枚举常量的名称（字符串形式）传给defaultValue，Maven会自动完成字符串到枚举实例的转换：

   @Parameter(defaultValue = "DIRECT")
   private MyEnum pickOne;
   

2. 在pom.xml中配置参数
   配置时同样直接填写枚举常量的名称字符串即可（大小写敏感）：

   <plugin>
     <groupId>你的插件groupId</groupId>
     <artifactId>你的插件artifactId</artifactId>
     <version>插件版本</version>
     <executions>
       <execution>
         <goals>
           <goal>sync</goal>
         </goals>
       </execution>
     </executions>
     <configuration>
       <pickOne>INCREMENT</pickOne>
     </configuration>
   </plugin>
   

Maven内部的类型转换器会自动处理字符串到枚举的转换，只要字符串与枚举常量名称完全一致就能正常工作。

内容的提问来源于stack exchange，提问作者robross0606