為什麼建議你使用列舉？

列舉是 JDK 1.5 新增的資料型別，使用列舉我們可以很好的描述一些特定的業務場景，比如一年中的春、夏、秋、冬，還有每週的週一到周天，還有各種顏色，以及可以用它來描述一些狀態資訊，比如錯誤碼等。

列舉型別不止存在在 Java 語言中，在其它語言中也都能找到它的身影，例如 C# 和 Python 等，但我發現在實際的專案中使用列舉的人很少，所以本文就來聊一聊列舉的相關內容，好讓朋友們對列舉有一個大概的印象，這樣在程式設計時起碼還能想到有“列舉”這樣一個型別。

本文的結構目錄如下：

列舉的 7 種使用方法

很多人不使用列舉的一個重要的原因是對列舉不夠熟悉，那麼我們就先從列舉的 7 種使用方法說起。

用法一：常量

在 JDK 1.5 之前，我們定義常量都是 public static final... ，但有了列舉，我們就可以把這些常量定義成一個列舉類了，實現程式碼如下：

public enum ColorEnum {  
  RED, GREEN, BLANK, YELLOW  
} 

用法二：switch

將列舉用在 switch 判斷中，使得程式碼可讀性更高了，實現程式碼如下：

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

用法三：列舉中增加方法

我們可以在列舉中增加一些方法，讓列舉具備更多的特性，實現程式碼如下：

public class EnumTest {
    public static void main(String[] args) {
        ErrorCodeEnum errorCode = ErrorCodeEnum.SUCCESS;
        System.out.println("狀態碼：" + errorCode.code() + 
                           " 狀態資訊：" + 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;
    }
}

以上程式的執行結果為：

狀態碼：1000 狀態資訊：success

用法四：覆蓋列舉方法

我們可以覆蓋一些列舉中的方法用於實現自己的業務，比如我們可以覆蓋 toString() 方法，實現程式碼如下：

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;

    //  構造方法
    private ColorEnum(String name, int index) {
        this.name = name;
        this.index = index;
    }

    //覆蓋方法
    @Override
    public String toString() {
        return this.index + "：" + this.name;
    }
}

以上程式的執行結果為：

1：紅色

用法五：實現介面

列舉類可以用來實現介面，但不能用於繼承類，因為列舉預設繼承了 java.lang.Enum 類，在 Java 語言中允許實現多介面，但不能繼承多個父類，實現程式碼如下：

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

以上程式的執行結果為：

1：紅色

顏色：紅色

用法六：在介面中組織列舉類

我們可以在一個介面中建立多個列舉類，用它可以很好的實現“多型”，也就是說我們可以將擁有相同特性，但又有細微實現差別的列舉類聚集在一個介面中，實現程式碼如下：

public class EnumTest {
    public static void main(String[] args) {
        // 賦值第一個列舉類
        ColorInterface colorEnum = ColorInterface.ColorEnum.RED;
        System.out.println(colorEnum);
        // 賦值第二個列舉類
        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
    }
}

以上程式的執行結果為：

RED

NEW_RED

用法七：使用列舉集合

在 Java 語言中和列舉類相關的，還有兩個列舉集合類 java.util.EnumSet 和 java.util.EnumMap，使用它們可以實現更多的功能。

使用 EnumSet 可以保證元素不重複，並且能獲取指定範圍內的元素，示例程式碼如下：

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);  // 重複元素
        list.add(ColorEnum.YELLOW);
        list.add(ColorEnum.GREEN);
        // 去掉重複資料
        EnumSet<ColorEnum> enumSet = EnumSet.copyOf(list);
        System.out.println("去重：" + enumSet);

        // 獲取指定範圍的列舉（獲取所有的失敗狀態）
        EnumSet<ErrorCodeEnum> errorCodeEnums = EnumSet.range(ErrorCodeEnum.ERROR, ErrorCodeEnum.UNKNOWN_ERROR);
        System.out.println("所有失敗狀態：" + 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;
    }
}

以上程式的執行結果為：

去重：[RED, GREEN, YELLOW]

所有失敗狀態：[ERROR, SYS_ERROR, NAMESPACE_NOT_FOUND, NODE_NOT_EXIST, NODE_ALREADY_EXIST, UNKNOWN_ERROR]

EnumMap 與 HashMap 類似，不過它是一個專門為列舉設計的 Map 集合，相比 HashMap 來說它的效能更高，因為它內部放棄使用連結串列和紅黑樹的結構，採用陣列作為資料儲存的結構。

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

以上程式的執行結果為：

RED:紅色

使用注意事項

阿里《Java開發手冊》對列舉的相關規定如下，我們在使用時需要稍微注意一下。

【強制】所有的列舉型別欄位必須要有註釋，說明每個資料項的用途。

【參考】列舉類名帶上 Enum 字尾，列舉成員名稱需要全大寫，單詞間用下劃線隔開。說明：列舉其實就是特殊的常量類，且構造方法被預設強制是私有。正例：列舉名字為 ProcessStatusEnum 的成員名稱：SUCCESS / UNKNOWN_REASON。

假如不使用列舉

在列舉沒有誕生之前，也就是 JDK 1.5 版本之前，我們通常會使用 int 常量來表示列舉，實現程式碼如下：

public static final int COLOR_RED = 1;
public static final int COLOR_BLUE = 2;
public static final int COLOR_GREEN = 3;

但是使用 int 型別可能存在兩個問題：

第一， int 型別本身並不具備安全性，假如某個程式設計師在定義 int 時少些了一個 final 關鍵字，那麼就會存在被其他人修改的風險，而反觀列舉類，它“天然”就是一個常量類，不存在被修改的風險（原因詳見下半部分）；

第二，使用 int 型別的語義不夠明確，比如我們在控制檯列印時如果只輸出 1...2...3 這樣的數字，我們肯定不知道它代表的是什麼含義。

那有人就說了，那就使用常量字元唄，這總不會還不知道語義吧？實現示例程式碼如下：

public static final String COLOR_RED = "RED";
public static final String COLOR_BLUE = "BLUE";
public static final String COLOR_GREEN = "GREEN";

但是這樣同樣存在一個問題，有些初級程式設計師會不按套路出牌，他們可能會直接使用字串的值進行比較，而不是直接使用列舉的欄位，實現示例程式碼如下：

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("藍色");
        }
    }
}

這樣當我們修改了列舉中的值，那程式就涼涼了。

列舉使用場景

列舉的常見使用場景是單例，它的完整實現程式碼如下：

public class Singleton {
    // 列舉型別是執行緒安全的，並且只會裝載一次
    private enum SingletonEnum {
        INSTANCE;
        // 宣告單例物件
        private final Singleton instance;
        // 例項化
        SingletonEnum() {
            instance = new Singleton();
        }
        private Singleton getInstance() {
            return instance;
        }
    }
    // 獲取例項（單例物件）
    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();
    }
}

因為列舉只會在類載入時裝載一次，所以它是執行緒安全的，這也是《Effective Java》作者極力推薦使用列舉來實現單例的主要原因。

知識擴充套件

列舉為什麼是執行緒安全的？

這一點要從列舉最終生成的位元組碼說起，首先我們先來定義一個簡單的列舉類：

public enum ColorEnumTest {
    RED, GREEN, BLANK, YELLOW;
}

然後我們再將上面的那段程式碼編譯為位元組碼，具體內容如下：

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

從上述結果可以看出列舉類最終會被編譯為被 final 修飾的普通類，它的所有屬性也都會被 static 和 final 關鍵字修飾，所以列舉類在專案啟動時就會被 JVM 載入並初始化，而這個執行過程是執行緒安全的，所以列舉類也是執行緒安全的類。

小貼士：程式碼反編譯的過程是先用 javac 命令將 java 程式碼編譯位元組碼（.class），再使用 javap 命令檢視編譯的位元組碼。

列舉比較小技巧

我們在列舉比較時使用 == 就夠了，因為列舉類是在程式載入時就建立了（它並不是 new 出來的），並且列舉類不允許在外部直接使用 new 關鍵字來建立列舉例項，所以我們在使用列舉類時本質上只有一個物件，因此在列舉比較時使用 == 就夠了。

並且我們在檢視列舉的 equlas() 原始碼會發現，它的內部其實還是直接呼叫了 == 方法，原始碼如下：

public final boolean equals(Object other) {
    return this==other;
}

總結

本文我們介紹了列舉類的 7 種使用方法：常量、switch、列舉中新增方法、覆蓋列舉方法、實現介面、在介面中組織列舉類和使用列舉集合等，然後講了如果不使用列舉類使用 int 型別和 String 型別存在的一些弊端：語義不夠清晰、容易被修改、存在被誤用的風險，所以我們在適合的環境下應該儘量使用列舉類。並且我們還講了列舉類的使用場景——單例，以及列舉類為什麼是安全的，最後我們講了列舉比較的小技巧，希望本文對你有幫助。

檢視 & 鳴謝

https://www.iteye.com/blog/softbeta-1185573