查找 Java Enum 的最佳实践

Question

我们有一个 REST API，客户端可以提供代表服务器上 Java 枚举中定义的值的参数。

因此我们可以提供一个描述性错误，我们将这个 lookup 方法添加到每个 Enum 中。看起来我们只是在复制代码（不好）。有更好的做法吗？

public enum MyEnum {
    A, B, C, D;

    public static MyEnum lookup(String id) {
        try {
            return MyEnum.valueOf(id);
        } catch (IllegalArgumentException e) {
            throw new RuntimeException("Invalid value for my enum blah blah: " + id);
        }
    }
}

更新：valueOf(..) 提供的默认错误消息为No enum const class abcMyEnum.BadValue。我想从 API 中提供更具描述性的错误。

Answer 1

也许您可以实现通用静态lookup方法。

像这样

public class LookupUtil {
   public static <E extends Enum<E>> E lookup(Class<E> e, String id) {   
      try {          
         E result = Enum.valueOf(e, id);
      } catch (IllegalArgumentException e) {
         // log error or something here

         throw new RuntimeException(
           "Invalid value for enum " + e.getSimpleName() + ": " + id);
      }

      return result;
   }
}

然后你可以

public enum MyEnum {
   static public MyEnum lookup(String id) {
       return LookupUtil.lookup(MyEnum.class, id);
   }
}

或显式调用实用程序类查找方法。

Answer 2

看起来你在这里的做法很糟糕，但不是你想象的那样。

捕获 IllegalArgumentException 来重新抛出另一个带有更清晰消息的 RuntimeException 可能看起来是个好主意，但事实并非如此。因为这意味着您关心异常中的消息。

如果您关心异常中的消息，则意味着您的用户以某种方式看到了您的异常。这很糟糕。

如果要向用户提供明确的错误消息，则应在解析用户输入时检查枚举值的有效性，并在用户输入不正确时在响应中发送相应的错误消息。

像这样的东西：

// This code uses pure fantasy, you are warned!
class MyApi
{
    // Return the 24-hour from a 12-hour and AM/PM

    void getHour24(Request request, Response response)
    {
        // validate user input
        int nTime12 = 1;
        try
        {
            nTime12 = Integer.parseInt(request.getParam("hour12"));
            if( nTime12 <= 0 || nTime12 > 12 )
            {
                throw new NumberFormatException();
            }
        }
        catch( NumberFormatException e )
        {
            response.setCode(400); // Bad request
            response.setContent("time12 must be an integer between 1 and 12");
            return;
        }

        AMPM pm = null;
        try
        {
            pm = AMPM.lookup(request.getParam("pm"));
        }
        catch( IllegalArgumentException e )
        {
            response.setCode(400); // Bad request
            response.setContent("pm must be one of " + AMPM.values());
            return;
        }

        response.setCode(200);
        switch( pm )
        {
            case AM:
                response.setContent(nTime12);
                break;
            case PM:
                response.setContent(nTime12 + 12);
                break;
        }
        return;
    }
}

Answer 3

当涉及到 Rest/Json 等时，我们所有的枚举都是这样的。
它的优点是错误是人类可读的，并且还为您提供了可接受的值列表。我们使用自定义方法 MyEnum.fromString 而不是 MyEnum.valueOf，希望它有所帮助。

public enum MyEnum {

    A, B, C, D;

    private static final Map<String, MyEnum> NAME_MAP = Stream.of(values())
            .collect(Collectors.toMap(MyEnum::toString, Function.identity()));

    public static MyEnum fromString(final String name) {
        MyEnum myEnum = NAME_MAP.get(name);
        if (null == myEnum) {
            throw new IllegalArgumentException(String.format("'%s' has no corresponding value. Accepted values: %s", name, Arrays.asList(values())));
        }
        return myEnum;
    }
}

例如，如果您调用，

MyEnum value = MyEnum.fromString("X");

您将收到一个 IllegalArgumentException 并显示以下消息：

“X”没有对应的值。接受的值：[A、B、C、D]

您可以将 IllegalArgumentException 更改为自定义异常。

Answer 4

Guava 还提供了这样的函数，如果找不到枚举，它将返回一个 Optional 。

Enums.getIfPresent(MyEnum.class, id).toJavaUtil()
            .orElseThrow(()-> new RuntimeException("Invalid enum blah blah blah.....")))

Answer 5

Apache Commons Lang 3 包含 EnumUtils 类。如果您没有在项目中使用 Apache Commons，那么您就做错了。你正在重新发明轮子！

我们可以使用许多很酷的方法而不会引发异常。例如：

获取类的枚举，如果未找到则返回 null。

此方法与 Enum.valueOf 的不同之处在于它不会抛出异常
无效枚举名称的异常并执行不区分大小写的操作
名称匹配。

EnumUtils.getEnumIgnoreCase(SeasonEnum.class, season);

Answer 6

如果您希望查找不区分大小写，您可以循环遍历这些值，使其更加友好：

 public enum MyEnum {
   A, B, C, D;

      public static MyEnum lookup(final String id) {
        for(MyEnum enumValue: values()){
           if(enumValue.name().equalsIgnoreCase(id)){
              return enumValue;
           }
        }  
        throw new RuntimeException("Invalid value for my enum: " + id);
       }
}

Answer 7

为什么我们必须写那 5 行代码？

public class EnumTest {
public enum MyEnum {
    A, B, C, D;
}

@Test
public void test() throws Exception {
    MyEnum.valueOf("A"); //gives you A
    //this throws ILlegalargument without having to do any lookup
    MyEnum.valueOf("RADD"); 
}
}

Answer 8

IllegalArgumentException 中的错误消息已经具有足够的描述性。

您的方法从特定例外中产生了一般例外，并简单地改写了相同的消息。开发人员更喜欢特定的异常类型，并且可以适当地处理这种情况，而不是尝试处理 RuntimeException。

如果目的是使消息对用户更加友好，那么对枚举值的引用无论如何都与它们无关。让 UI 代码决定应该向用户显示什么，UI 开发人员最好使用 IllegalArgumentException。

Answer 9

更新：正如 GreenTurtle 正确评论的那样，以下内容是错误的，

---

我只会写

boolean result = Arrays.asList(FooEnum.values()).contains("Foo");

这可能比捕获运行时异常的性能要差，但可以使代码更清晰。捕获此类异常总是一个坏主意，因为它很容易误诊。
当比较值的检索本身导致 IllegalArgumentException 时会发生什么？然后，这将被视为枚举器的不匹配值。

Answer 10

您可以使用静态查找映射来避免异常并返回 null，然后根据需要抛出：

public enum Mammal {
    COW,
    MOUSE,
    OPOSSUM;

    private static Map<String, Mammal> lookup = 
            Arrays.stream(values())
                  .collect(Collectors.toMap(Enum::name, Function.identity()));

    public static Mammal getByName(String name) {
        return lookup.get(name);
    }
}