Thực hành tốt nhất để tra cứu Java Enum

Question

Chúng tôi có một API REST nơi khách hàng có thể cung cấp các tham số đại diện cho các giá trị được xác định trên máy chủ trong Java Enums.

Vì vậy, chúng tôi có thể cung cấp lỗi mô tả, chúng tôi thêm phương thức lookup này vào mỗi Enum. Có vẻ như chúng tôi chỉ đang sao chép mã (xấu). Có cách nào tốt hơn không?

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); 
     } 
    } 
} 

Cập nhật: Các thông báo lỗi mặc định được cung cấp bởi valueOf(..) sẽ No enum const class a.b.c.MyEnum.BadValue. Tôi muốn cung cấp lỗi mô tả hơn từ API.

Answer 1

Có thể bạn có thể triển khai phương pháp tĩnh chung lookup.

Giống như rất

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; 
    } 
} 

Sau đó, bạn có thể

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

hoặc gọi một cách rõ ràng tiện ích tra cứu phương pháp lớp.

Answer 2

Tại sao chúng ta phải viết mã 5 dòng đó?

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

Nếu bạn muốn tra cứu được trường hợp nhạy cảm, bạn có thể lặp qua các giá trị làm cho nó thân thiện hơn một chút:

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

Hình như bạn có một thói quen xấu ở đây nhưng không phải là nơi bạn nghĩ.

Bắt một số IllegalArgumentException để tính lại một số RuntimeException khác với thông điệp rõ ràng hơn có thể giống như ý tưởng hay nhưng không phải. Bởi vì nó có nghĩa là bạn quan tâm đến các thông điệp trong trường hợp ngoại lệ của bạn.

Nếu bạn quan tâm đến thư trong trường hợp ngoại lệ, thì điều đó có nghĩa là người dùng của bạn bằng cách nào đó nhìn thấy ngoại lệ của bạn. Thật tệ.

Nếu bạn muốn cung cấp thông báo lỗi rõ ràng cho người dùng, bạn nên kiểm tra tính hợp lệ của giá trị enum khi phân tích cú pháp người dùng nhập và gửi thông báo lỗi thích hợp trong phản hồi nếu người dùng nhập sai.

Cái gì như:

// 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

Các thông báo lỗi trong IllegalArgumentException là đủ đã mô tả.

Phương pháp của bạn làm cho ngoại lệ chung ra khỏi một trường hợp cụ thể với cùng một thông điệp được viết lại đơn giản. Một nhà phát triển sẽ thích loại ngoại lệ cụ thể và có thể xử lý trường hợp một cách thích hợp thay vì cố gắng xử lý RuntimeException.

Nếu mục đích là làm cho thông điệp thân thiện với người dùng hơn, thì các tham chiếu đến giá trị của enums không liên quan đến chúng. Hãy để mã giao diện người dùng xác định những gì sẽ được hiển thị cho người dùng và nhà phát triển UI sẽ tốt hơn với IllegalArgumentException.

Answer 6

update: Như GreenTurtle nhận xét một cách chính xác, sau đây là sai

---

tôi sẽ chỉ cần viết

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

Đây có thể là ít performant hơn bắt một ngoại lệ thời gian chạy, nhưng làm cho mã sạch hơn . Bắt ngoại lệ như vậy luôn luôn là một ý tưởng tồi, vì nó dễ bị chẩn đoán sai. Điều gì sẽ xảy ra khi việc truy xuất giá trị so sánh chính nó gây ra một IllegalArgumentException? Điều này sau đó sẽ được xử lý như một giá trị không phù hợp cho điều tra viên.

Answer 7

Chúng tôi làm tất cả các enums của chúng tôi như thế này khi nói đến Rest/Json vv Nó có lợi thế là lỗi là con người có thể đọc được và cũng cung cấp cho bạn danh sách giá trị được chấp nhận. Chúng tôi đang sử dụng một phương pháp tùy chỉnh MyEnum.fromString thay vì MyEnum.valueOf, hy vọng nó sẽ giúp.

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; 
    } 
} 

nên ví dụ nếu bạn gọi

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

bạn sẽ nhận được một IllegalArgumentException với thông báo sau:

'X' không có giá trị tương ứng. Giá trị được chấp nhận: [A, B, C, D]

bạn có thể thay đổi IllegalArgumentException thành tùy chỉnh.