用好Java中的枚舉,真的沒有那麼簡單!

最近重看 Java 枚舉，看到這篇覺得還不錯的文章，於是簡單翻譯和完善了一些內容，分享給大家，希望你們也能有所收穫。另外，不要忘了文末還有補充哦！

ps: 這裏發一篇枚舉的文章，也是因爲後面要發一篇非常實用的關於 SpringBoot 全局異常處理的比較好的實踐，裏面就用到了枚舉。

這篇文章由 JavaGuide 翻譯，公衆號: JavaGuide,原文地址：https://www.baeldung.com/a-guide-to-java-enums 。

轉載請註明上面這段文字。

1.概覽

在本文中，我們將看到什麼是 Java 枚舉，它們解決了哪些問題以及如何在實踐中使用 Java 枚舉實現一些設計模式。

enum關鍵字在 java5 中引入，表示一種特殊類型的類，其總是繼承java.lang.Enum類，更多內容可以自行查看其官方文檔。

枚舉在很多時候會和常量拿來對比，可能因爲本身我們大量實際使用枚舉的地方就是爲了替代常量。那麼這種方式由什麼優勢呢？

以這種方式定義的常量使代碼更具可讀性，允許進行編譯時檢查，預先記錄可接受值的列表，並避免由於傳入無效值而引起的意外行爲。

下面示例定義一個簡單的枚舉類型 pizza 訂單的狀態，共有三種 ORDERED, READY, DELIVERED狀態:

package shuang.kou.enumdemo.enumtest;

public enum PizzaStatus {
    ORDERED,
    READY, 
    DELIVERED; 
}

簡單來說，我們通過上面的代碼避免了定義常量，我們將所有和 pizza 訂單的狀態的常量都統一放到了一個枚舉類型裏面。

System.out.println(PizzaStatus.ORDERED.name());//ORDERED
System.out.println(PizzaStatus.ORDERED);//ORDERED
System.out.println(PizzaStatus.ORDERED.name().getClass());//class java.lang.String
System.out.println(PizzaStatus.ORDERED.getClass());//class shuang.kou.enumdemo.enumtest.PizzaStatus

2.自定義枚舉方法

現在我們對枚舉是什麼以及如何使用它們有了基本的瞭解，讓我們通過在枚舉上定義一些額外的API方法，將上一個示例提升到一個新的水平：

public class Pizza {
    private PizzaStatus status;
    public enum PizzaStatus {
        ORDERED,
        READY,
        DELIVERED;
    }
 
    public boolean isDeliverable() {
        if (getStatus() == PizzaStatus.READY) {
            return true;
        }
        return false;
    }
     
    // Methods that set and get the status variable.
}

3.使用 == 比較枚舉類型

由於枚舉類型確保JVM中僅存在一個常量實例，因此我們可以安全地使用“ ==”運算符比較兩個變量，如上例所示；此外，“ ==”運算符可提供編譯時和運行時的安全性。

首先，讓我們看一下以下代碼段中的運行時安全性，其中“ ==”運算符用於比較狀態，並且如果兩個值均爲null 都不會引發 NullPointerException。相反，如果使用equals方法，將拋出 NullPointerException：

if(testPz.getStatus().equals(Pizza.PizzaStatus.DELIVERED)); 
if(testPz.getStatus() == Pizza.PizzaStatus.DELIVERED);

對於編譯時安全性，我們看另一個示例，兩個不同枚舉類型進行比較，使用equal方法比較結果確定爲true，因爲getStatus方法的枚舉值與另一個類型枚舉值一致，但邏輯上應該爲false。這個問題可以使用==操作符避免。因爲編譯器會表示類型不兼容錯誤：

if(testPz.getStatus().equals(TestColor.GREEN));
if(testPz.getStatus() == TestColor.GREEN);

4.在 switch 語句中使用枚舉類型

public int getDeliveryTimeInDays() {
    switch (status) {
        case ORDERED: return 5;
        case READY: return 2;
        case DELIVERED: return 0;
    }
    return 0;
}

5.枚舉類型的屬性,方法和構造函數

文末有我(JavaGuide)的補充。

你可以通過在枚舉類型中定義屬性,方法和構造函數讓它變得更加強大。

下面，讓我們擴展上面的示例，實現從比薩的一個階段到另一個階段的過渡，並瞭解如何擺脫之前使用的if語句和switch語句：

public class Pizza {
 
    private PizzaStatus status;
    public enum PizzaStatus {
        ORDERED (5){
            @Override
            public boolean isOrdered() {
                return true;
            }
        },
        READY (2){
            @Override
            public boolean isReady() {
                return true;
            }
        },
        DELIVERED (0){
            @Override
            public boolean isDelivered() {
                return true;
            }
        };
 
        private int timeToDelivery;
 
        public boolean isOrdered() {return false;}
 
        public boolean isReady() {return false;}
 
        public boolean isDelivered(){return false;}
 
        public int getTimeToDelivery() {
            return timeToDelivery;
        }
 
        PizzaStatus (int timeToDelivery) {
            this.timeToDelivery = timeToDelivery;
        }
    }
 
    public boolean isDeliverable() {
        return this.status.isReady();
    }
 
    public void printTimeToDeliver() {
        System.out.println("Time to delivery is "   
          this.getStatus().getTimeToDelivery());
    }
     
    // Methods that set and get the status variable.
}

下面這段代碼展示它是如何 work 的：

@Test
public void givenPizaOrder_whenReady_thenDeliverable() {
    Pizza testPz = new Pizza();
    testPz.setStatus(Pizza.PizzaStatus.READY);
    assertTrue(testPz.isDeliverable());
}

6.EnumSet and EnumMap

6.1. EnumSet

EnumSet 是一種專門爲枚舉類型所設計的 Set 類型。

與HashSet相比，由於使用了內部位向量表示，因此它是特定 Enum 常量集的非常有效且緊湊的表示形式。

它提供了類型安全的替代方法，以替代傳統的基於int的“位標誌”，使我們能夠編寫更易讀和易於維護的簡潔代碼。

EnumSet 是抽象類，其有兩個實現：RegularEnumSet 、JumboEnumSet，選擇哪一個取決於實例化時枚舉中常量的數量。

在很多場景中的枚舉常量集合操作（如：取子集、增加、刪除、containsAll和removeAll批操作）使用EnumSet非常合適；如果需要迭代所有可能的常量則使用Enum.values()。

public class Pizza {
 
    private static EnumSet<PizzaStatus> undeliveredPizzaStatuses =
      EnumSet.of(PizzaStatus.ORDERED, PizzaStatus.READY);
 
    private PizzaStatus status;
 
    public enum PizzaStatus {
        ...
    }
 
    public boolean isDeliverable() {
        return this.status.isReady();
    }
 
    public void printTimeToDeliver() {
        System.out.println("Time to delivery is "   
          this.getStatus().getTimeToDelivery()   " days");
    }
 
    public static List<Pizza> getAllUndeliveredPizzas(List<Pizza> input) {
        return input.stream().filter(
          (s) -> undeliveredPizzaStatuses.contains(s.getStatus()))
            .collect(Collectors.toList());
    }
 
    public void deliver() { 
        if (isDeliverable()) { 
            PizzaDeliverySystemConfiguration.getInstance().getDeliveryStrategy()
              .deliver(this); 
            this.setStatus(PizzaStatus.DELIVERED); 
        } 
    }
     
    // Methods that set and get the status variable.
}

下面的測試演示了展示了 EnumSet 在某些場景下的強大功能：

@Test
public void givenPizaOrders_whenRetrievingUnDeliveredPzs_thenCorrectlyRetrieved() {
    List<Pizza> pzList = new ArrayList<>();
    Pizza pz1 = new Pizza();
    pz1.setStatus(Pizza.PizzaStatus.DELIVERED);
 
    Pizza pz2 = new Pizza();
    pz2.setStatus(Pizza.PizzaStatus.ORDERED);
 
    Pizza pz3 = new Pizza();
    pz3.setStatus(Pizza.PizzaStatus.ORDERED);
 
    Pizza pz4 = new Pizza();
    pz4.setStatus(Pizza.PizzaStatus.READY);
 
    pzList.add(pz1);
    pzList.add(pz2);
    pzList.add(pz3);
    pzList.add(pz4);
 
    List<Pizza> undeliveredPzs = Pizza.getAllUndeliveredPizzas(pzList); 
    assertTrue(undeliveredPzs.size() == 3); 
}

6.2. EnumMap

EnumMap是一個專門化的映射實現，用於將枚舉常量用作鍵。與對應的 HashMap 相比，它是一個高效緊湊的實現，並且在內部表示爲一個數組:

EnumMap<Pizza.PizzaStatus, Pizza> map;

讓我們快速看一個真實的示例，該示例演示如何在實踐中使用它：

public static EnumMap<PizzaStatus, List<Pizza>> 
  groupPizzaByStatus(List<Pizza> pizzaList) {
    EnumMap<PizzaStatus, List<Pizza>> pzByStatus = 
      new EnumMap<PizzaStatus, List<Pizza>>(PizzaStatus.class);
     
    for (Pizza pz : pizzaList) {
        PizzaStatus status = pz.getStatus();
        if (pzByStatus.containsKey(status)) {
            pzByStatus.get(status).add(pz);
        } else {
            List<Pizza> newPzList = new ArrayList<Pizza>();
            newPzList.add(pz);
            pzByStatus.put(status, newPzList);
        }
    }
    return pzByStatus;
}

下面的測試演示了展示了 EnumMap 在某些場景下的強大功能：

@Test
public void givenPizaOrders_whenGroupByStatusCalled_thenCorrectlyGrouped() {
    List<Pizza> pzList = new ArrayList<>();
    Pizza pz1 = new Pizza();
    pz1.setStatus(Pizza.PizzaStatus.DELIVERED);
 
    Pizza pz2 = new Pizza();
    pz2.setStatus(Pizza.PizzaStatus.ORDERED);
 
    Pizza pz3 = new Pizza();
    pz3.setStatus(Pizza.PizzaStatus.ORDERED);
 
    Pizza pz4 = new Pizza();
    pz4.setStatus(Pizza.PizzaStatus.READY);
 
    pzList.add(pz1);
    pzList.add(pz2);
    pzList.add(pz3);
    pzList.add(pz4);
 
    EnumMap<Pizza.PizzaStatus,List<Pizza>> map = Pizza.groupPizzaByStatus(pzList);
    assertTrue(map.get(Pizza.PizzaStatus.DELIVERED).size() == 1);
    assertTrue(map.get(Pizza.PizzaStatus.ORDERED).size() == 2);
    assertTrue(map.get(Pizza.PizzaStatus.READY).size() == 1);
}

7. 通過枚舉實現一些設計模式

7.1 單例模式

通常，使用類實現 Singleton 模式並非易事，枚舉提供了一種實現單例的簡便方法。

《Effective Java 》和《Java與模式》都非常推薦這種方式，使用這種方式方式實現枚舉可以有什麼好處呢？

《Effective Java》

這種方法在功能上與公有域方法相近，但是它更加簡潔，無償提供了序列化機制，絕對防止多次實例化，即使是在面對複雜序列化或者反射攻擊的時候。雖然這種方法還沒有廣泛採用，但是單元素的枚舉類型已經成爲實現 Singleton的最佳方法。 —-《Effective Java 中文版第二版》

《Java與模式》

《Java與模式》中，作者這樣寫道，使用枚舉來實現單實例控制會更加簡潔，而且無償地提供了序列化機制，並由JVM從根本上提供保障，絕對防止多次實例化，是更簡潔、高效、安全的實現單例的方式。

下面的代碼段顯示瞭如何使用枚舉實現單例模式：

public enum PizzaDeliverySystemConfiguration {
    INSTANCE;
    PizzaDeliverySystemConfiguration() {
        // Initialization configuration which involves
        // overriding defaults like delivery strategy
    }
 
    private PizzaDeliveryStrategy deliveryStrategy = PizzaDeliveryStrategy.NORMAL;
 
    public static PizzaDeliverySystemConfiguration getInstance() {
        return INSTANCE;
    }
 
    public PizzaDeliveryStrategy getDeliveryStrategy() {
        return deliveryStrategy;
    }
}

如何使用呢？請看下面的代碼：

PizzaDeliveryStrategy deliveryStrategy = PizzaDeliverySystemConfiguration.getInstance().getDeliveryStrategy();

通過 PizzaDeliverySystemConfiguration.getInstance() 獲取的就是單例的 PizzaDeliverySystemConfiguration

7.2 策略模式

通常，策略模式由不同類實現同一個接口來實現的。

這也就意味着添加新策略意味着添加新的實現類。使用枚舉，可以輕鬆完成此任務，添加新的實現意味着只定義具有某個實現的另一個實例。

下面的代碼段顯示瞭如何使用枚舉實現策略模式：

public enum PizzaDeliveryStrategy {
    EXPRESS {
        @Override
        public void deliver(Pizza pz) {
            System.out.println("Pizza will be delivered in express mode");
        }
    },
    NORMAL {
        @Override
        public void deliver(Pizza pz) {
            System.out.println("Pizza will be delivered in normal mode");
        }
    };
 
    public abstract void deliver(Pizza pz);
}

給 Pizza 增加下面的方法：

public void deliver() {
    if (isDeliverable()) {
        PizzaDeliverySystemConfiguration.getInstance().getDeliveryStrategy()
          .deliver(this);
        this.setStatus(PizzaStatus.DELIVERED);
    }
}

如何使用呢？請看下面的代碼：

@Test
public void givenPizaOrder_whenDelivered_thenPizzaGetsDeliveredAndStatusChanges() {
    Pizza pz = new Pizza();
    pz.setStatus(Pizza.PizzaStatus.READY);
    pz.deliver();
    assertTrue(pz.getStatus() == Pizza.PizzaStatus.DELIVERED);
}

8. Java 8 與枚舉

Pizza 類可以用Java 8重寫，您可以看到方法 lambda 和Stream API如何使 getAllUndeliveredPizzas（）和groupPizzaByStatus（）方法變得如此簡潔：

getAllUndeliveredPizzas（）:

public static List<Pizza> getAllUndeliveredPizzas(List<Pizza> input) {
    return input.stream().filter(
      (s) -> !deliveredPizzaStatuses.contains(s.getStatus()))
        .collect(Collectors.toList());
}

groupPizzaByStatus（） :

public static EnumMap<PizzaStatus, List<Pizza>> 
  groupPizzaByStatus(List<Pizza> pzList) {
    EnumMap<PizzaStatus, List<Pizza>> map = pzList.stream().collect(
      Collectors.groupingBy(Pizza::getStatus,
      () -> new EnumMap<>(PizzaStatus.class), Collectors.toList()));
    return map;
}

9. Enum 類型的 JSON 表現形式

使用Jackson庫，可以將枚舉類型的JSON表示爲POJO。下面的代碼段顯示了可以用於同一目的的Jackson批註：

@JsonFormat(shape = JsonFormat.Shape.OBJECT)
public enum PizzaStatus {
    ORDERED (5){
        @Override
        public boolean isOrdered() {
            return true;
        }
    },
    READY (2){
        @Override
        public boolean isReady() {
            return true;
        }
    },
    DELIVERED (0){
        @Override
        public boolean isDelivered() {
            return true;
        }
    };
 
    private int timeToDelivery;
 
    public boolean isOrdered() {return false;}
 
    public boolean isReady() {return false;}
 
    public boolean isDelivered(){return false;}
 
    @JsonProperty("timeToDelivery")
    public int getTimeToDelivery() {
        return timeToDelivery;
    }
 
    private PizzaStatus (int timeToDelivery) {
        this.timeToDelivery = timeToDelivery;
    }
}

我們可以按如下方式使用 Pizza 和 PizzaStatus：

Pizza pz = new Pizza();
pz.setStatus(Pizza.PizzaStatus.READY);
System.out.println(Pizza.getJsonString(pz));

生成 Pizza 狀態以以下JSON展示：

{
  "status" : {
    "timeToDelivery" : 2,
    "ready" : true,
    "ordered" : false,
    "delivered" : false
  },
  "deliverable" : true
}

有關枚舉類型的JSON序列化/反序列化（包括自定義）的更多信息，請參閱Jackson-將枚舉序列化爲JSON對象。

10.總結

本文我們討論了Java枚舉類型，從基礎知識到高級應用以及實際應用場景，讓我們感受到枚舉的強大功能。

11. 補充

我們在上面講到了，我們可以通過在枚舉類型中定義屬性,方法和構造函數讓它變得更加強大。

下面我通過一個實際的例子展示一下，當我們調用短信驗證碼的時候可能有幾種不同的用途，我們在下面這樣定義：


public enum PinType {

    REGISTER(100000, "註冊使用"),
    FORGET_PASSWORD(100001, "忘記密碼使用"),
    UPDATE_PHONE_NUMBER(100002, "更新手機號碼使用");

    private final int code;
    private final String message;

    PinType(int code, String message) {
        this.code = code;
        this.message = message;
    }

    public int getCode() {
        return code;
    }

    public String getMessage() {
        return message;
    }

    @Override
    public String toString() {
        return "PinType{"  
                "code="   code  
                ", message='"   message   '\''  
                '}';
    }
}

實際使用：

System.out.println(PinType.FORGET_PASSWORD.getCode());
System.out.println(PinType.FORGET_PASSWORD.getMessage());
System.out.println(PinType.FORGET_PASSWORD.toString());

Output:

100001
忘記密碼使用
PinType{code=100001, message='忘記密碼使用'}

這樣的話，在實際使用起來就會非常靈活方便！

開源項目推薦

作者的其他開源項目推薦：

JavaGuide：【Java學習面試指南】一份涵蓋大部分Java程序員所需要掌握的核心知識。
springboot-guide : 適合新手入門以及有經驗的開發人員查閱的 Spring Boot 教程（業餘時間維護中，歡迎一起維護）。
programmer-advancement : 我覺得技術人員應該有的一些好習慣！
spring-security-jwt-guide :從零入門！Spring Security With JWT（含權限驗證）後端部分代碼。

用好Java中的枚舉,真的沒有那麼簡單!

1.概覽

2.自定義枚舉方法

3.使用 == 比較枚舉類型

4.在 switch 語句中使用枚舉類型

5.枚舉類型的屬性,方法和構造函數

6.EnumSet and EnumMap

6.1. EnumSet

6.2. EnumMap

7. 通過枚舉實現一些設計模式

7.1 單例模式

7.2 策略模式

8. Java 8 與枚舉

9. Enum 類型的 JSON 表現形式

10.總結

11. 補充

開源項目推薦

公衆號

2024年DataOps趨勢預測：AI不會取代數據工程師

雲原生週刊：K8s 中的服務和網絡｜ 2024.4.29

[轉帖]cpupower

今天，昨天，近七天，近30天，近90天，js封裝

華爲云云原生FinOps解決方案，釋放雲原生最大價值

第二彈！「Java面試題精華集」1w字的Java集合框架篇（2020最新版）！

Github點贊接近 70k 的Spring Cloud學習教程+實戰項目推薦！牛批！

Github點贊接近 100k 的Spring Boot學習教程+實戰項目推薦！

程序元應該跳出了自己“舒適區”嗎？

用好Java中的枚舉,真的沒有那麼簡單!

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結