為什么建議你使用枚舉?
本文轉(zhuǎn)載自微信公眾號(hào)「Java中文社群 」,作者 磊哥 。轉(zhuǎn)載本文請(qǐng)聯(lián)系Java中文社群 公眾號(hào)。
枚舉是 JDK 1.5 新增的數(shù)據(jù)類型,使用枚舉我們可以很好的描述一些特定的業(yè)務(wù)場景,比如一年中的春、夏、秋、冬,還有每周的周一到周天,還有各種顏色,以及可以用它來描述一些狀態(tài)信息,比如錯(cuò)誤碼等。
枚舉類型不止存在在 Java 語言中,在其它語言中也都能找到它的身影,例如 C# 和 Python 等,但我發(fā)現(xiàn)在實(shí)際的項(xiàng)目中使用枚舉的人很少,所以本文就來聊一聊枚舉的相關(guān)內(nèi)容,好讓朋友們對(duì)枚舉有一個(gè)大概的印象,這樣在編程時(shí)起碼還能想到有“枚舉”這樣一個(gè)類型。
本文的結(jié)構(gòu)目錄如下:
枚舉的 7 種使用方法很多人不使用枚舉的一個(gè)重要的原因是對(duì)枚舉不夠熟悉,那么我們就先從枚舉的 7 種使用方法說起。
用法一:常量
在 JDK 1.5 之前,我們定義常量都是 public static final... ,但有了枚舉,我們就可以把這些常量定義成一個(gè)枚舉類了,實(shí)現(xiàn)代碼如下:
- public enum ColorEnum {
- RED, GREEN, BLANK, YELLOW
- }
用法二:switch
將枚舉用在 switch 判斷中,使得代碼可讀性更高了,實(shí)現(xiàn)代碼如下:
- enum ColorEnum {
- GREEN, YELLOW, RED
- }
- public class ColorTest {
- ColorEnum color = ColorEnum.RED;
- public void change() {
- switch (color) {
- case RED:
- color = ColorEnum.GREEN;
- break;
- case YELLOW:
- color = ColorEnum.RED;
- break;
- case GREEN:
- color = ColorEnum.YELLOW;
- break;
- }
- }
- }
用法三:枚舉中增加方法
我們可以在枚舉中增加一些方法,讓枚舉具備更多的特性,實(shí)現(xiàn)代碼如下:
- public class EnumTest {
- public static void main(String[] args) {
- ErrorCodeEnum errorCode = ErrorCodeEnum.SUCCESS;
- System.out.println("狀態(tài)碼:" + errorCode.code() +
- " 狀態(tài)信息:" + errorCode.msg());
- }
- }
- enum ErrorCodeEnum {
- SUCCESS(1000, "success"),
- PARAM_ERROR(1001, "parameter error"),
- SYS_ERROR(1003, "system error"),
- NAMESPACE_NOT_FOUND(2001, "namespace not found"),
- NODE_NOT_EXIST(3002, "node not exist"),
- NODE_ALREADY_EXIST(3003, "node already exist"),
- UNKNOWN_ERROR(9999, "unknown error");
- private int code;
- private String msg;
- ErrorCodeEnum(int code, String msg) {
- this.code = code;
- this.msg = msg;
- }
- public int code() {
- return code;
- }
- public String msg() {
- return msg;
- }
- public static ErrorCodeEnum getErrorCode(int code) {
- for (ErrorCodeEnum it : ErrorCodeEnum.values()) {
- if (it.code() == code) {
- return it;
- }
- }
- return UNKNOWN_ERROR;
- }
- }
以上程序的執(zhí)行結(jié)果為:
狀態(tài)碼:1000 狀態(tài)信息:success
用法四:覆蓋枚舉方法
我們可以覆蓋一些枚舉中的方法用于實(shí)現(xiàn)自己的業(yè)務(wù),比如我們可以覆蓋 toString()方法,實(shí)現(xiàn)代碼如下:
- public class EnumTest {
- public static void main(String[] args) {
- ColorEnum colorEnum = ColorEnum.RED;
- System.out.println(colorEnum.toString());
- }
- }
- enum ColorEnum {
- RED("紅色", 1), GREEN("綠色", 2), BLANK("白色", 3), YELLOW("黃色", 4);
- // 成員變量
- private String name;
- private int index;
- // 構(gòu)造方法
- private ColorEnum(String name, int index) {
- this.name = name;
- this.index = index;
- }
- //覆蓋方法
- @Override
- public String toString() {
- return this.index + ":" + this.name;
- }
- }
以上程序的執(zhí)行結(jié)果為:
1:紅色
用法五:實(shí)現(xiàn)接口
枚舉類可以用來實(shí)現(xiàn)接口,但不能用于繼承類,因?yàn)槊杜e默認(rèn)繼承了 java.lang.Enum類,在 Java 語言中允許實(shí)現(xiàn)多接口,但不能繼承多個(gè)父類,實(shí)現(xiàn)代碼如下:
- public class EnumTest {
- public static void main(String[] args) {
- ColorEnum colorEnum = ColorEnum.RED;
- colorEnum.print();
- System.out.println("顏色:" + colorEnum.getInfo());
- }
- }
- interface Behaviour {
- void print();
- String getInfo();
- }
- enum ColorEnum implements Behaviour {
- RED("紅色", 1), GREEN("綠色", 2), BLANK("白色", 3), YELLOW("黃色", 4);
- private String name;
- private int index;
- private ColorEnum(String name, int index) {
- this.name = name;
- this.index = index;
- }
- @Override
- public void print() {
- System.out.println(this.index + ":" + this.name);
- }
- @Override
- public String getInfo() {
- return this.name;
- }
- }
以上程序的執(zhí)行結(jié)果為:
1:紅色
顏色:紅色
用法六:在接口中組織枚舉類
我們可以在一個(gè)接口中創(chuàng)建多個(gè)枚舉類,用它可以很好的實(shí)現(xiàn)“多態(tài)”,也就是說我們可以將擁有相同特性,但又有細(xì)微實(shí)現(xiàn)差別的枚舉類聚集在一個(gè)接口中,實(shí)現(xiàn)代碼如下:
- public class EnumTest {
- public static void main(String[] args) {
- // 賦值第一個(gè)枚舉類
- ColorInterface colorEnum = ColorInterface.ColorEnum.RED;
- System.out.println(colorEnum);
- // 賦值第二個(gè)枚舉類
- colorEnum = ColorInterface.NewColorEnum.NEW_RED;
- System.out.println(colorEnum);
- }
- }
- interface ColorInterface {
- enum ColorEnum implements ColorInterface {
- GREEN, YELLOW, RED
- }
- enum NewColorEnum implements ColorInterface {
- NEW_GREEN, NEW_YELLOW, NEW_RED
- }
- }
以上程序的執(zhí)行結(jié)果為:
RED
NEW_RED
用法七:使用枚舉集合
在 Java 語言中和枚舉類相關(guān)的,還有兩個(gè)枚舉集合類 java.util.EnumSet 和 java.util.EnumMap,使用它們可以實(shí)現(xiàn)更多的功能。
使用 EnumSet 可以保證元素不重復(fù),并且能獲取指定范圍內(nèi)的元素,示例代碼如下:
- import java.util.ArrayList;
- import java.util.EnumSet;
- import java.util.List;
- public class EnumTest {
- public static void main(String[] args) {
- List<ColorEnum> list = new ArrayList<ColorEnum>();
- list.add(ColorEnum.RED);
- list.add(ColorEnum.RED); // 重復(fù)元素
- list.add(ColorEnum.YELLOW);
- list.add(ColorEnum.GREEN);
- // 去掉重復(fù)數(shù)據(jù)
- EnumSet<ColorEnum> enumSet = EnumSet.copyOf(list);
- System.out.println("去重:" + enumSet);
- // 獲取指定范圍的枚舉(獲取所有的失敗狀態(tài))
- EnumSet<ErrorCodeEnum> errorCodeEnums = EnumSet.range(ErrorCodeEnum.ERROR, ErrorCodeEnum.UNKNOWN_ERROR);
- System.out.println("所有失敗狀態(tài):" + errorCodeEnums);
- }
- }
- enum ColorEnum {
- RED("紅色", 1), GREEN("綠色", 2), BLANK("白色", 3), YELLOW("黃色", 4);
- private String name;
- private int index;
- private ColorEnum(String name, int index) {
- this.name = name;
- this.index = index;
- }
- }
- enum ErrorCodeEnum {
- SUCCESS(1000, "success"),
- ERROR(2001, "parameter error"),
- SYS_ERROR(2002, "system error"),
- NAMESPACE_NOT_FOUND(2003, "namespace not found"),
- NODE_NOT_EXIST(3002, "node not exist"),
- NODE_ALREADY_EXIST(3003, "node already exist"),
- UNKNOWN_ERROR(9999, "unknown error");
- private int code;
- private String msg;
- ErrorCodeEnum(int code, String msg) {
- this.code = code;
- this.msg = msg;
- }
- public int code() {
- return code;
- }
- public String msg() {
- return msg;
- }
- }
以上程序的執(zhí)行結(jié)果為:
去重:[RED, GREEN, YELLOW]
所有失敗狀態(tài):[ERROR, SYS_ERROR, NAMESPACE_NOT_FOUND, NODE_NOT_EXIST, NODE_ALREADY_EXIST, UNKNOWN_ERROR]
EnumMap 與 HashMap 類似,不過它是一個(gè)專門為枚舉設(shè)計(jì)的 Map 集合,相比 HashMap 來說它的性能更高,因?yàn)樗鼉?nèi)部放棄使用鏈表和紅黑樹的結(jié)構(gòu),采用數(shù)組作為數(shù)據(jù)存儲(chǔ)的結(jié)構(gòu)。
EnumMap 基本使用示例如下:
- import java.util.EnumMap;
- public class EnumTest {
- public static void main(String[] args) {
- EnumMap<ColorEnum, String> enumMap = new EnumMap<>(ColorEnum.class);
- enumMap.put(ColorEnum.RED, "紅色");
- enumMap.put(ColorEnum.GREEN, "綠色");
- enumMap.put(ColorEnum.BLANK, "白色");
- enumMap.put(ColorEnum.YELLOW, "黃色");
- System.out.println(ColorEnum.RED + ":" + enumMap.get(ColorEnum.RED));
- }
- }
- enum ColorEnum {
- RED, GREEN, BLANK, YELLOW;
- }
以上程序的執(zhí)行結(jié)果為:
RED:紅色
使用注意事項(xiàng)
阿里《Java開發(fā)手冊(cè)》對(duì)枚舉的相關(guān)規(guī)定如下,我們?cè)谑褂脮r(shí)需要稍微注意一下。
【強(qiáng)制】所有的枚舉類型字段必須要有注釋,說明每個(gè)數(shù)據(jù)項(xiàng)的用途。
【參考】枚舉類名帶上 Enum 后綴,枚舉成員名稱需要全大寫,單詞間用下劃線隔開。說明:枚舉其實(shí)就是特殊的常量類,且構(gòu)造方法被默認(rèn)強(qiáng)制是私有。正例:枚舉名字為 ProcessStatusEnum 的成員名稱:SUCCESS / UNKNOWN_REASON。
假如不使用枚舉
在枚舉沒有誕生之前,也就是 JDK 1.5 版本之前,我們通常會(huì)使用 int 常量來表示枚舉,實(shí)現(xiàn)代碼如下:
- public static final int COLOR_RED = 1;
- public static final int COLOR_BLUE = 2;
- public static final int COLOR_GREEN = 3;
但是使用 int 類型可能存在兩個(gè)問題:
第一, int 類型本身并不具備安全性,假如某個(gè)程序員在定義 int 時(shí)少些了一個(gè)final 關(guān)鍵字,那么就會(huì)存在被其他人修改的風(fēng)險(xiǎn),而反觀枚舉類,它“天然”就是一個(gè)常量類,不存在被修改的風(fēng)險(xiǎn)(原因詳見下半部分);第二,使用 int 類型的語義不夠明確,比如我們?cè)诳刂婆_(tái)打印時(shí)如果只輸出 1...2...3 這樣的數(shù)字,我們肯定不知道它代表的是什么含義。
那有人就說了,那就使用常量字符唄,這總不會(huì)還不知道語義吧?實(shí)現(xiàn)示例代碼如下:
- public static final String COLOR_RED = "RED";
- public static final String COLOR_BLUE = "BLUE";
- public static final String COLOR_GREEN = "GREEN";
但是這樣同樣存在一個(gè)問題,有些初級(jí)程序員會(huì)不按套路出牌,他們可能會(huì)直接使用字符串的值進(jìn)行比較,而不是直接使用枚舉的字段,實(shí)現(xiàn)示例代碼如下:
- public class EnumTest {
- public static final String COLOR_RED = "RED";
- public static final String COLOR_BLUE = "BLUE";
- public static final String COLOR_GREEN = "GREEN";
- public static void main(String[] args) {
- String color = "BLUE";
- if ("BLUE".equals(color)) {
- System.out.println("藍(lán)色");
- }
- }
- }
這樣當(dāng)我們修改了枚舉中的值,那程序就涼涼了。
枚舉使用場景
枚舉的常見使用場景是單例,它的完整實(shí)現(xiàn)代碼如下:
- public class Singleton {
- // 枚舉類型是線程安全的,并且只會(huì)裝載一次
- private enum SingletonEnum {
- INSTANCE;
- // 聲明單例對(duì)象
- private final Singleton instance;
- // 實(shí)例化
- SingletonEnum() {
- instance = new Singleton();
- }
- private Singleton getInstance() {
- return instance;
- }
- }
- // 獲取實(shí)例(單例對(duì)象)
- public static Singleton getInstance() {
- return SingletonEnum.INSTANCE.getInstance();
- }
- private Singleton() {
- }
- // 類方法
- public void sayHi() {
- System.out.println("Hi,Java.");
- }
- }
- class SingletonTest {
- public static void main(String[] args) {
- Singleton singleton = Singleton.getInstance();
- singleton.sayHi();
- }
- }
因?yàn)槊杜e只會(huì)在類加載時(shí)裝載一次,所以它是線程安全的,這也是《Effective Java》作者極力推薦使用枚舉來實(shí)現(xiàn)單例的主要原因。
知識(shí)擴(kuò)展
枚舉為什么是線程安全的?
這一點(diǎn)要從枚舉最終生成的字節(jié)碼說起,首先我們先來定義一個(gè)簡單的枚舉類:
- public enum ColorEnumTest {
- RED, GREEN, BLANK, YELLOW;
- }
然后我們?cè)賹⑸厦娴哪嵌未a編譯為字節(jié)碼,具體內(nèi)容如下:
- public final class ColorEnumTest extends java.lang.Enum<ColorEnumTest> {
- public static final ColorEnumTest RED;
- public static final ColorEnumTest GREEN;
- public static final ColorEnumTest BLANK;
- public static final ColorEnumTest YELLOW;
- public static ColorEnumTest[] values();
- public static ColorEnumTest valueOf(java.lang.String);
- static {};
- }
從上述結(jié)果可以看出枚舉類最終會(huì)被編譯為被 final 修飾的普通類,它的所有屬性也都會(huì)被 static 和 final 關(guān)鍵字修飾,所以枚舉類在項(xiàng)目啟動(dòng)時(shí)就會(huì)被 JVM 加載并初始化,而這個(gè)執(zhí)行過程是線程安全的,所以枚舉類也是線程安全的類。
小貼士:代碼反編譯的過程是先用 javac 命令將 java 代碼編譯字節(jié)碼(.class),再使用 javap 命令查看編譯的字節(jié)碼。
枚舉比較小技巧
我們?cè)诿杜e比較時(shí)使用 == 就夠了,因?yàn)槊杜e類是在程序加載時(shí)就創(chuàng)建了(它并不是new 出來的),并且枚舉類不允許在外部直接使用 new 關(guān)鍵字來創(chuàng)建枚舉實(shí)例,所以我們?cè)谑褂妹杜e類時(shí)本質(zhì)上只有一個(gè)對(duì)象,因此在枚舉比較時(shí)使用 == 就夠了。
并且我們?cè)诓榭疵杜e的 equlas() 源碼會(huì)發(fā)現(xiàn),它的內(nèi)部其實(shí)還是直接調(diào)用了 == 方法,源碼如下:
- public final boolean equals(Object other) {
- return this==other;
- }
總結(jié)
本文我們介紹了枚舉類的 7 種使用方法:常量、switch、枚舉中添加方法、覆蓋枚舉方法、實(shí)現(xiàn)接口、在接口中組織枚舉類和使用枚舉集合等,然后講了如果不使用枚舉類使用 int 類型和 String 類型存在的一些弊端:語義不夠清晰、容易被修改、存在被誤用的風(fēng)險(xiǎn),所以我們?cè)谶m合的環(huán)境下應(yīng)該盡量使用枚舉類。并且我們還講了枚舉類的使用場景——單例,以及枚舉類為什么是安全的,最后我們講了枚舉比較的小技巧,希望本文對(duì)你有幫助。
查看 & 鳴謝
https://www.iteye.com/blog/softbeta-1185573
鏈接:https://mp.weixin.qq.com/s/HDotguLpNgtwK-Jz2UsODQ