用好 Java 中的枚舉，讓你的工作效率飛起來！
點擊關(guān)注公眾號，Java干貨及時送達
牛逼！又發(fā)現(xiàn)了一款面試題庫，太全了！！
（點擊查看）
出處：baeldung.com/a-guide-to-java-enums
1.概覽
在本文中，我們將看到什么是 Java 枚舉，它們解決了哪些問題以及如何在實踐中使用 Java 枚舉實現(xiàn)一些設(shè)計模式。
enum關(guān)鍵字在 java5 中引入，表示一種特殊類型的類，其總是繼承java.lang.Enum類，更多內(nèi)容可以自行查看其官方文檔。
枚舉在很多時候會和常量拿來對比，可能因為本身我們大量實際使用枚舉的地方就是為了替代常量。那么這種方式由什么優(yōu)勢呢？
以這種方式定義的常量使代碼更具可讀性，允許進行編譯時檢查，預(yù)先記錄可接受值的列表，并避免由于傳入無效值而引起的意外行為。
下面示例定義一個簡單的枚舉類型 pizza 訂單的狀態(tài)，共有三種 ORDERED, READY, DELIVERED狀態(tài):
package shuang.kou.enumdemo.enumtest;
publicenum PizzaStatus {
ORDERED,
READY,
DELIVERED;
}
簡單來說，我們通過上面的代碼避免了定義常量，我們將所有和 pizza 訂單的狀態(tài)的常量都統(tǒng)一放到了一個枚舉類型里面。
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.自定義枚舉方法
現(xiàn)在我們對枚舉是什么以及如何使用它們有了基本的了解，讓我們通過在枚舉上定義一些額外的API方法，將上一個示例提升到一個新的水平：
publicclass Pizza {
private PizzaStatus status;
publicenum PizzaStatus {
ORDERED,
READY,
DELIVERED;
}
public boolean isDeliverable() {
if (getStatus() == PizzaStatus.READY) {
returntrue;
}
returnfalse;
}
// Methods that set and get the status variable.
}
3.使用 == 比較枚舉類型
由于枚舉類型確保JVM中僅存在一個常量實例，因此我們可以安全地使用“ ==”運算符比較兩個變量，如上例所示；此外，“ ==”運算符可提供編譯時和運行時的安全性。
首先，讓我們看一下以下代碼段中的運行時安全性，其中“ ==”運算符用于比較狀態(tài)，并且如果兩個值均為null 都不會引發(fā) NullPointerException。相反，如果使用equals方法，將拋出 NullPointerException：
if(testPz.getStatus().equals(Pizza.PizzaStatus.DELIVERED));
if(testPz.getStatus() == Pizza.PizzaStatus.DELIVERED);
對于編譯時安全性，我們看另一個示例，兩個不同枚舉類型進行比較，使用equal方法比較結(jié)果確定為true，因為getStatus方法的枚舉值與另一個類型枚舉值一致，但邏輯上應(yīng)該為false。這個問題可以使用==操作符避免。因為編譯器會表示類型不兼容錯誤：
if(testPz.getStatus().equals(TestColor.GREEN));
if(testPz.getStatus() == TestColor.GREEN);
4.在 switch 語句中使用枚舉類型
public int getDeliveryTimeInDays() {
switch (status) {
case ORDERED: return5;
case READY: return2;
case DELIVERED: return0;
}
return0;
}
5.枚舉類型的屬性,方法和構(gòu)造函數(shù)
你可以通過在枚舉類型中定義屬性,方法和構(gòu)造函數(shù)讓它變得更加強大。
下面，讓我們擴展上面的示例，實現(xiàn)從比薩的一個階段到另一個階段的過渡，并了解如何擺脫之前使用的if語句和switch語句：
publicclass Pizza {
private PizzaStatus status;
publicenum PizzaStatus {
ORDERED (5){
@Override
public boolean isOrdered() {
returntrue;
}
},
READY (2){
@Override
public boolean isReady() {
returntrue;
}
},
DELIVERED (0){
@Override
public boolean isDelivered() {
returntrue;
}
};
privateint timeToDelivery;
public boolean isOrdered() {returnfalse;}
public boolean isReady() {returnfalse;}
public boolean isDelivered(){returnfalse;}
public int getTimeToDelivery() {
return timeToDelivery;
}
PizzaStatus (int timeToDelivery) {
this.timeToDelivery = timeToDelivery;
}
}
public boolean isDeliverable() {
returnthis.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 是一種專門為枚舉類型所設(shè)計的 Set 類型。
與HashSet相比，由于使用了內(nèi)部位向量表示，因此它是特定 Enum 常量集的非常有效且緊湊的表示形式。
它提供了類型安全的替代方法，以替代傳統(tǒng)的基于int的“位標志”，使我們能夠編寫更易讀和易于維護的簡潔代碼。
EnumSet 是抽象類，其有兩個實現(xiàn)：RegularEnumSet 、JumboEnumSet，選擇哪一個取決于實例化時枚舉中常量的數(shù)量。
在很多場景中的枚舉常量集合操作（如：取子集、增加、刪除、containsAll和removeAll批操作）使用EnumSet非常合適；如果需要迭代所有可能的常量則使用Enum.values()。
publicclass Pizza {
privatestatic EnumSet<PizzaStatus> undeliveredPizzaStatuses =
EnumSet.of(PizzaStatus.ORDERED, PizzaStatus.READY);
private PizzaStatus status;
publicenum PizzaStatus {
...
}
public boolean isDeliverable() {
returnthis.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是一個專門化的映射實現(xiàn)，用于將枚舉常量用作鍵。與對應(yīng)的 HashMap 相比，它是一個高效緊湊的實現(xiàn)，并且在內(nèi)部表示為一個數(shù)組:
EnumMap<Pizza.PizzaStatus, Pizza> map;
讓我們快速看一個真實的示例，該示例演示如何在實踐中使用它：
publicstatic 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. 通過枚舉實現(xiàn)一些設(shè)計模式
7.1 單例模式
通常，使用類實現(xiàn) Singleton 模式并非易事，枚舉提供了一種實現(xiàn)單例的簡便方法。
《Effective Java 》和《Java與模式》都非常推薦這種方式，使用這種方式方式實現(xiàn)枚舉可以有什么好處呢？
《Effective Java》
“
這種方法在功能上與公有域方法相近，但是它更加簡潔，無償提供了序列化機制，絕對防止多次實例化，即使是在面對復(fù)雜序列化或者反射攻擊的時候。雖然這種方法還沒有廣泛采用，但是單元素的枚舉類型已經(jīng)成為實現(xiàn) Singleton的最佳方法。—-《Effective Java 中文版 第二版》
《Java與模式》
“
《Java與模式》中，作者這樣寫道，使用枚舉來實現(xiàn)單實例控制會更加簡潔，而且無償?shù)靥峁┝诵蛄谢瘷C制，并由JVM從根本上提供保障，絕對防止多次實例化，是更簡潔、高效、安全的實現(xiàn)單例的方式。
下面的代碼段顯示了如何使用枚舉實現(xiàn)單例模式：
publicenum 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 策略模式
通常，策略模式由不同類實現(xiàn)同一個接口來實現(xiàn)的。
這也就意味著添加新策略意味著添加新的實現(xiàn)類。使用枚舉，可以輕松完成此任務(wù)，添加新的實現(xiàn)意味著只定義具有某個實現(xiàn)的另一個實例。
下面的代碼段顯示了如何使用枚舉實現(xiàn)策略模式：
publicenum 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（） :
publicstatic 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 表現(xiàn)形式
使用Jackson庫，可以將枚舉類型的JSON表示為POJO。下面的代碼段顯示了可以用于同一目的的Jackson批注：
@JsonFormat(shape = JsonFormat.Shape.OBJECT)
publicenum PizzaStatus {
ORDERED (5){
@Override
public boolean isOrdered() {
returntrue;
}
},
READY (2){
@Override
public boolean isReady() {
returntrue;
}
},
DELIVERED (0){
@Override
public boolean isDelivered() {
returntrue;
}
};
privateint timeToDelivery;
public boolean isOrdered() {returnfalse;}
public boolean isReady() {returnfalse;}
public boolean isDelivered(){returnfalse;}
@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 狀態(tài)以以下JSON展示：
{
"status" : {
"timeToDelivery" : 2,
"ready" : true,
"ordered" : false,
"delivered" : false
},
"deliverable" : true
}
有關(guān)枚舉類型的JSON序列化/反序列化（包括自定義）的更多信息，請參閱Jackson-將枚舉序列化為JSON對象。
10.總結(jié)
本文我們討論了Java枚舉類型，從基礎(chǔ)知識到高級應(yīng)用以及實際應(yīng)用場景，讓我們感受到枚舉的強大功能。
11. 補充
我們在上面講到了，我們可以通過在枚舉類型中定義屬性,方法和構(gòu)造函數(shù)讓它變得更加強大。
下面我通過一個實際的例子展示一下，當我們調(diào)用短信驗證碼的時候可能有幾種不同的用途，我們在下面這樣定義：
publicenum PinType {
REGISTER(100000, "注冊使用"),
FORGET_PASSWORD(100001, "忘記密碼使用"),
UPDATE_PHONE_NUMBER(100002, "更新手機號碼使用");
privatefinalint code;
privatefinal 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='忘記密碼使用'}
這樣的話，在實際使用起來就會非常靈活方便！
如有文章對你有幫助，
歡迎關(guān)注??、點贊??、轉(zhuǎn)發(fā)??！
推薦， Java面試題庫，詳情點擊： 牛逼！又發(fā)現(xiàn)了一款牛逼的Java面試題庫，史上最強！ 點擊文末“閱讀原文”可直達
