資深架構師談論Java 枚舉

概念

enum 的全稱爲 enumeration，是 JDK 1.5 中引入的新特性。

在Java中，被 enum 關鍵字修飾的類型就是枚舉類型。形式如下：

enum Color { RED, GREEN, BLUE }
如果枚舉不添加任何方法，枚舉值默認爲從0開始的有序數值。以 Color 枚舉類型舉例，它的枚舉常量依次爲 RED：0，GREEN：1，BLUE：2。

枚舉的好處：可以將常量組織起來，統一進行管理。

枚舉的典型應用場景：錯誤碼、狀態機等。

枚舉類型的本質

儘管 enum 看起來像是一種新的數據類型，事實上，enum是一種受限制的類，並且具有自己的方法。

創建enum時，編譯器會爲你生成一個相關的類，這個類繼承自 java.lang.Enum。

java.lang.Enum類聲明

public abstract class Enum<E extends Enum<E>>
        implements Comparable<E>, Serializable { ...
         }

枚舉的方法
在enum中，提供了一些基本方法：

values()：返回 enum 實例的數組，而且該數組中的元素嚴格保持在 enum 中聲明時的順序。

name()：返回實例名。

ordinal()：返回實例聲明時的次序，從0開始。

getDeclaringClass()：返回實例所屬的 enum 類型。

equals()：判斷是否爲同一個對象。

可以使用 == 來比較enum實例。

此外，java.lang.Enum實現了Comparable和 Serializable 接口，所以也提供 compareTo() 方法。

例：展示enum的基本方法


public class EnumMethodDemo {
    enum Color {RED, GREEN, BLUE;}
    enum Size {BIG, MIDDLE, SMALL;}
    public static void main(String args[]) {
        System.out.println("=========== Print all Color ===========");
        for (Color c : Color.values()) {
            System.out.println(c + " ordinal: " + c.ordinal());
        }
        System.out.println("=========== Print all Size ===========");
        for (Size s : Size.values()) {
            System.out.println(s + " ordinal: " + s.ordinal());
        }

        Color green = Color.GREEN;
        System.out.println("green name(): " + green.name());
        System.out.println("green getDeclaringClass(): " + green.getDeclaringClass());
        System.out.println("green hashCode(): " + green.hashCode());
        System.out.println("green compareTo Color.GREEN: " + green.compareTo(Color.GREEN));
        System.out.println("green equals Color.GREEN: " + green.equals(Color.GREEN));
        System.out.println("green equals Size.MIDDLE: " + green.equals(Size.MIDDLE));
        System.out.println("green equals 1: " + green.equals(1));
        System.out.format("green == Color.BLUE: %b\n", green == Color.BLUE);
    }
}

輸出

=========== Print all Color ===========
RED ordinal: 0
GREEN ordinal: 1
BLUE ordinal: 2
=========== Print all Size ===========
BIG ordinal: 0
MIDDLE ordinal: 1
SMALL ordinal: 2
green name(): GREEN
green getDeclaringClass(): class org.zp.javase.enumeration.EnumDemo$Color
green hashCode(): 460141958
green compareTo Color.GREEN: 0
green equals Color.GREEN: true
green equals Size.MIDDLE: false
green equals 1: false
green == Color.BLUE: false
請加Q君樣：
756584822大家一起吹水聊天

枚舉的特性

枚舉的特性，歸結起來就是一句話：

除了不能繼承，基本上可以將 enum 看做一個常規的類。

但是這句話需要拆分去理解，讓我們細細道來。

枚舉可以添加方法
在概念章節提到了，枚舉值默認爲從0開始的有序數值。那麼問題來了：如何爲枚舉顯示的賦值。

Java 不允許使用 = 爲枚舉常量賦值
如果你接觸過C/C++，你肯定會很自然的想到賦值符號 = 。在C/C++語言中的enum，可以用賦值符號=顯示的爲枚舉常量賦值；但是，很遺憾，Java 語法中卻不允許使用賦值符號 = 爲枚舉常量賦值。

例：C/C++ 語言中的枚舉聲明

typedef enum{
    ONE = 1,
    TWO,
    THREE = 3,
    TEN = 10
} Number;

枚舉可以添加普通方法、靜態方法、抽象方法、構造方法
Java 雖然不能直接爲實例賦值，但是它有更優秀的解決方案：爲 enum 添加方法來間接實現顯示賦值。

創建enum 時，可以爲其添加多種方法，甚至可以爲其添加構造方法。

注意一個細節：如果要爲enum定義方法，那麼必須在enum的最後一個實例尾部添加一個分號。此外，在enum中，必須先定義實例，不能將字段或方法定義在實例前面。否則，編譯器會報錯。

例：全面展示如何在枚舉中定義普通方法、靜態方法、抽象方法、構造方法

public enum ErrorCode {
    OK(0) {
        public String getDescription() {
            return "成功";
        }
    },
    ERROR_A(100) {
        public String getDescription() {
            return "錯誤A";
        }
    },
    ERROR_B(200) {
        public String getDescription() {
            return "錯誤B";
        }
    };

    private int code;

    // 構造方法：enum的構造方法只能被聲明爲private權限或不聲明權限
    private ErrorCode(int number) { // 構造方法
        this.code = number;
    }
    public int getCode() { // 普通方法
        return code;
    } // 普通方法
    public abstract String getDescription(); // 抽象方法
    public static void main(String args[]) { // 靜態方法
        for (ErrorCode s : ErrorCode.values()) {
            System.out.println("code: " + s.getCode() + ", description: " + s.getDescription());
        }
    }
}

注：上面的例子並不可取，僅僅是爲了展示枚舉支持定義各種方法。下面是一個簡化的例子

例：一個錯誤碼枚舉類型的定義

本例和上例的執行結果完全相同。

public enum ErrorCodeEn {
    OK(0, "成功"),
    ERROR_A(100, "錯誤A"),
    ERROR_B(200, "錯誤B");

    ErrorCodeEn(int number, String description) {
        this.code = number;
        this.description = description;
    }
    private int code;
    private String description;
    public int getCode() {
        return code;
    }
    public String getDescription() {
        return description;
    }
    public static void main(String args[]) { // 靜態方法
        for (ErrorCodeEn s : ErrorCodeEn.values()) {
            System.out.println("code: " + s.getCode() + ", description: " + s.getDescription());
        }
    }
}

枚舉可以實現接口
enum 可以像一般類一樣實現接口。

同樣是實現上一節中的錯誤碼枚舉類，通過實現接口，可以約束它的方法。

public interface INumberEnum {
    int getCode();
    String getDescription();
}

public enum ErrorCodeEn2 implements INumberEnum {
    OK(0, "成功"),
    ERROR_A(100, "錯誤A"),
    ERROR_B(200, "錯誤B");

    ErrorCodeEn2(int number, String description) {
        this.code = number;
        this.description = description;
    }

    private int code;
    private String description;

    @Override
    public int getCode() {
        return code;
    }
請加Q君樣：
756584822大家一起吹水聊天
    @Override
    public String getDescription() {
        return description;
    }
}

枚舉不可以繼承
enum 不可以繼承另外一個類，當然，也不能繼承另一個 enum 。

因爲 enum 實際上都繼承自 java.lang.Enum 類，而 Java 不支持多重繼承，所以 enum 不能再繼承其他類，當然也不能繼承另一個 enum。

枚舉的應用場景
組織常量
在JDK1.5 之前，在Java中定義常量都是public static final TYPE a; 這樣的形式。有了枚舉，你可以將有關聯關係的常量組織起來，使代碼更加易讀、安全，並且還可以使用枚舉提供的方法。

枚舉聲明的格式
注：如果枚舉中沒有定義方法，也可以在最後一個實例後面加逗號、分號或什麼都不加。

下面三種聲明方式是等價的：

enum Color { RED, GREEN, BLUE }
enum Color { RED, GREEN, BLUE, }
enum Color { RED, GREEN, BLUE; }

`switch`狀態機

我們經常使用switch語句來寫狀態機。JDK7以後，switch已經支持 int、char、String、enum 類型的參數。這幾種類型的參數比較起來，使用枚舉的switch代碼更具有可讀性。

enum Signal {RED, YELLOW, GREEN}

public static String getTrafficInstruct(Signal signal) {
    String instruct = "信號燈故障";
    switch (signal) {
        case RED:
            instruct = "紅燈停";
            break;
        case YELLOW:
            instruct = "黃燈請注意";
            break;
        case GREEN:
            instruct = "綠燈行";
            break;
        default:
            break;
    }
    return instruct;
}

組織枚舉

可以將類型相近的枚舉通過接口或類組織起來。

但是一般用接口方式進行組織。

原因是：Java接口在編譯時會自動爲enum類型加上public static修飾符；Java類在編譯時會自動爲 enum 類型加上static修飾符。看出差異了嗎？沒錯，就是說，在類中組織 enum，如果你不給它修飾爲 public，那麼只能在本包中進行訪問。

例：在接口中組織 enum

public interface Plant {
    enum Vegetable implements INumberEnum {
        POTATO(0, "土豆"),
        TOMATO(0, "西紅柿");

        Vegetable(int number, String description) {
            this.code = number;
            this.description = description;
        }

        private int code;
        private String description;

        @Override
        public int getCode() {
            return 0;
        }

        @Override
        public String getDescription() {
            return null;
        }
    }

    enum Fruit implements INumberEnum {
        APPLE(0, "蘋果"),
        ORANGE(0, "桔子"),
        BANANA(0, "香蕉");

        Fruit(int number, String description) {
            this.code = number;
            this.description = description;
        }

        private int code;
        private String description;

        @Override
        public int getCode() {
            return 0;
        }

        @Override
        public String getDescription() {
            return null;
        }
    }
}

例：在類中組織 enum

本例和上例效果相同。

public class Plant2 {
    public enum Vegetable implements INumberEnum {...}  // 省略代碼
    public enum Fruit implements INumberEnum {...} // 省略代碼
}請加Q君樣：
756584822大家一起吹水聊天

策略枚舉
EffectiveJava中展示了一種策略枚舉。這種枚舉通過枚舉嵌套枚舉的方式，將枚舉常量分類處理。

這種做法雖然沒有switch語句簡潔，但是更加安全、靈活。

例：EffectvieJava中的策略枚舉範例

enum PayrollDay {
    MONDAY(PayType.WEEKDAY), TUESDAY(PayType.WEEKDAY), WEDNESDAY(
            PayType.WEEKDAY), THURSDAY(PayType.WEEKDAY), FRIDAY(PayType.WEEKDAY), SATURDAY(
            PayType.WEEKEND), SUNDAY(PayType.WEEKEND);

    private final PayType payType;

    PayrollDay(PayType payType) {
        this.payType = payType;
    }

    double pay(double hoursWorked, double payRate) {
        return payType.pay(hoursWorked, payRate);
    }

    // 策略枚舉
    private enum PayType {
        WEEKDAY {
            double overtimePay(double hours, double payRate) {
                return hours <= HOURS_PER_SHIFT ? 0 : (hours - HOURS_PER_SHIFT)
                        * payRate / 2;
            }
        },
        WEEKEND {
            double overtimePay(double hours, double payRate) {
                return hours * payRate / 2;
            }
        };請加Q君樣：
756584822大家一起吹水聊天
        private static final int HOURS_PER_SHIFT = 8;

        abstract double overtimePay(double hrs, double payRate);

        double pay(double hoursWorked, double payRate) {
            double basePay = hoursWorked * payRate;
            return basePay + overtimePay(hoursWorked, payRate);
        }
    }
}

測試

System.out.println("時薪100的人在週五工作8小時的收入：" + PayrollDay.FRIDAY.pay(8.0, 100));
System.out.println("時薪100的人在週六工作8小時的收入：" + PayrollDay.SATURDAY.pay(8.0, 100));

EnumSet和EnumMap
Java 中提供了兩個方便操作enum的工具類——EnumSet 和 EnumMap。

EnumSet 是枚舉類型的高性能 Set 實現。它要求放入它的枚舉常量必須屬於同一枚舉類型。
EnumMap是專門爲枚舉類型量身定做的 Map 實現。雖然使用其它的 Map 實現（如HashMap）也能完成枚舉類型實例到值得映射，但是使用 EnumMap 會更加高效：它只能接收同一枚舉類型的實例作爲鍵值，並且由於枚舉類型實例的數量相對固定並且有限，所以EnumMap使用數組來存放與枚舉類型對應的值。這使得 EnumMap 的效率非常高。

// EnumSet的使用
System.out.println("EnumSet展示");
EnumSet<ErrorCodeEn> errSet = EnumSet.allOf(ErrorCodeEn.class);
for (ErrorCodeEn e : errSet) {
    System.out.println(e.name() + " : " + e.ordinal());
}

// EnumMap的使用
System.out.println("EnumMap展示");
EnumMap<StateMachine.Signal, String> errMap = new EnumMap(StateMachine.Signal.class);
errMap.put(StateMachine.Signal.RED, "紅燈");
errMap.put(StateMachine.Signal.YELLOW, "黃燈");
errMap.put(StateMachine.Signal.GREEN, "綠燈");
for (Iterator<Map.Entry<StateMachine.Signal, String>> iter = errMap.entrySet().iterator(); iter.hasNext();) {
    Map.Entry<StateMachine.Signal, String> entry = iter.next();
    System.out.println(entry.getKey().name() + " : " + entry.getValue());
}

資深架構師談論Java 枚舉

概念

枚舉類型的本質

枚舉的特性

`switch`狀態機

組織枚舉

如何在低代碼平臺中引用 JavaScript ？

探究職業發展的關鍵：能力模型解讀

高效率使用windows

如何使用 JavaScript 獲取當前頁面幀率 FPS

工程款拖欠，農民工怎麼了？就得一直忍着委屈求全嗎？

HarmonyOS 實現下拉刷新，上拉加載更多

語音信號處理中的“窗函數”

智能決策新時代：可視化大屏是否能夠超越傳統白板？

解密Prompt系列28. LLM Agent之金融領域摸索：FinMem & FinAgent

分享幾個.NET開源的AI和LLM相關項目框架

自學第七十天

SylixOS---互斥信號量與優先級反轉問題

5G-NSA組網參數配置

資深架構師談論Java 枚舉

Ruby 抓疫情數據

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

linux以太網驅動總結

資深架構師談論Java 枚舉

概念

枚舉類型的本質

枚舉的特性

switch狀態機

組織枚舉

`switch`狀態機