查找Java枚舉的最佳實踐

Question

我們有一個REST API，其中客戶端可以提供表示Java Enums中服務器上定義的值的參數。

所以我們可以提供一個描述性錯誤，我們將這個lookup方法添加到每個枚舉。好像我們只是複製代碼（壞）。有更好的做法嗎？

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 a.b.c.MyEnum.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

爲什麼我們要寫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 3

如果您想查詢是不區分大小寫的，你可以通過做多一點友好的數值循環：

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

     public static MyEnum lookup(String id) { 
     boolean found = false; 
     for(MyEnum enum: values()){ 
      if(enum.toString().equalsIgnoreCase(id)) found = true; 
     } 
     if(!found) throw new RuntimeException("Invalid value for my enum: " +id); 
     } 
} 

Answer 4

看起來你在這裏有一個不好的做法，但不是你想的。

抓住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 5

IllegalArgumentException異常的錯誤消息是已經有足夠的描述。

你的方法使用相同的消息只是重寫了一個特定的異常。開發人員更喜歡特定的異常類型，並且可以適當地處理這種情況，而不是嘗試處理RuntimeException。

如果意圖是使消息更加用戶友好，那麼對枚舉值的引用無論如何都與它們無關。讓UI代碼確定應向用戶顯示的內容，並且UI開發人員最好使用IllegalArgumentException。

Answer 6

更新：由於GreenTurtle正確地指出，下列哪項是錯誤

---

我只想寫

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

這可能是比捕捉運行時異常少高性能，反而使得對於更清潔代碼。捕捉這樣的例外總是一個壞主意，因爲它很容易誤診。 當檢索比較值本身會導致IllegalArgumentException時會發生什麼？然後這將被處理爲與枚舉器不匹配的值。

Answer 7

當涉及到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更改爲自定義一個。