最近發現公司的程式碼中存在大量的使用int枚舉的方式,也看到了一些使用enum進行枚舉的方式。對此很好奇,進行了研究,估計寫此文總結,來說一說為什麼要使用enum。
java為什麼要使用枚舉?
假設現在有兩種訂單類型:預訂訂單和非預訂訂單。
需求一: 方法submitOrder依據不同訂單類型進行不同的處理。
需求二: 為一個物件: OrderResult設定訂單類型。
以下分別用兩種枚舉方式來實現。
int枚舉
class IntEnumExample{ private static final PRE_ORDER = 1; private static final NOT_PRE_ORDER = 2; public void submitOrder(int orderType, OrderResult orderResult){ orderResult.setType(orderType); if(orderType == PRE_ORDER){ do something to process preOrder }else if(orderType == NOT_PRE_ORDER){ do something to process other order } } public static void main(String [] args){ IntEnumExample example = new IntEnumExample(); //passing wrong type to the method, however, no compile error and runtime exception here, the bug is hard to be discerned. example.submitOrder(3, orderResult); } }
從上面的例子可以看到,使用int枚舉有幾個缺點:
#1. int枚舉不做型別檢查,可以給上面的submitOrder方法傳入任意int值
2.程式碼可讀性低,如果沒有文件或源碼,不知道給submitOrder傳遞的值的意義。
不僅如此,就像我之前修改專案中sonar掃描程式碼發現的問題那樣,很多人在使用int枚舉時,並沒有像上例中將int值定義成static final。如果忘記定義變數為final則int枚舉的值就可以被修改,如果忘記定義變數為static,就可能出現使用這個int值時,該int值還沒有被初始化。
總之,會引起bug。
在下面來看看使用enum如何做同樣的事。
class IntEnumExample{ private enum ORDER_TYPE { NOT_PRE_ORDER(1),PRE_ORDER(2); private final int value; private ORDER_TYPE(int value){ this.value = value; } } public void submitOrder(ORDER_TYPE orderType, OrderResult orderResult){ orderResult.setType(orderType); if(orderType == ORDER_TYPE.PRE_ORDER){ do something to process preOrder }else if(orderType == ORDER_TYPE.NOT_PRE_ORDER){ do something to process other order } } public static void main(String [] args){ IntEnumExample example = new IntEnumExample(); //compiler will complain error here, if argument is not the type in the enum. example.submitOrder(ORDER_TYPE.PRE_ORDER, orderResult); } }
透過上述程式碼可以看到,enum很優雅的解決了上一個範例中的問題。
1.編譯器將對enum進行類型檢查,類型不符合的編譯器會直接報錯。
2.比較與int枚舉型直接傳int數值的方式,enum傳遞enum型別物件的方式,程式碼可讀性更高,傳遞的枚舉型別一目了然。
3.enum類型中的物件本身就是static final的。
重要提示:
還有一點值得一提的是,如果有時想給每個枚舉類型賦予一個int值,要使用上例中enum定義的方式。
private enum ORDER_TYPE { NOT_PRE_ORDER(1),PRE_ORDER(2); private final int value; private ORDER_TYPE(int value){ this.value = value; } }
enum本質也是一個類,所以方法ORDER_TYPE(int value)是這個枚舉類型的建構函數,故每個枚舉類型在初始化的時候需要給構造函數傳遞回應的值,如: PRE_ORDER(2)。
這種情況下,想得到枚舉型別對應的int數值時可以透過ORDER_TYPE.PRE_ORDER.value取得。
單獨提下enum的這種用法是因為,有些人可能會直接使用enum中的ordinal()方法直接實現enum類型與int類型的關聯。 ordinal()方法傳回的是enum類型在被定義時的序數,如ORDER_TYPE.PRE_ORDER.value.ordinal()傳回值為0。所以取得枚舉型別對應的int數值貌似也可以透過ORDER_TYPE.PRE_ORDER.value.ordinal() 1實現。
不要使用ordinal()方法!不要使用ordinal()方法!不要使用ordinal()方法!重要的事情說三遍,為什麼?
序數是很不可靠的東西,序數是可以改變的,假設有一天ORDER_TYPE的定義變了,需要增加幾種型,或是不小心換了NOT_PRE_ORDER和PRE_ORDER定義時的順序,如:
private enum ORDER_TYPE { PRE_ORDER,NOT_PRE_ORDER; }
這時就會造成很嚴重的bug,而且不好發現,編譯時,執行時都不會有報錯。
所以,不要依賴ordianl()方法。
相關學習推薦:java基礎教學
以上是java為什麼要使用枚舉?的詳細內容。更多資訊請關注PHP中文網其他相關文章!