聊一聊Java的列舉enum

工匠初心發表於2019-08-01
Java

一. 什麼是列舉

列舉是一種資料型別，具有集合的一些特點，可以存放多個元素，但儲存物件有限且固定，列舉也有比較常見的使用場景，如我們需要表達性別（男、女），顏色（紅、黃、藍），星期（星期一、星期二...星期日），四季（春、夏、秋、冬），地理位置（東、西、南、北），方向（前、後、左、右）等，這些場景都非常適合列舉。

二. 定義列舉

java中使用enum來定義列舉，和class，interface具有同樣的等級，(注意是enum，而不是Enum)，定義列舉可以有兩種情況

第一種：預設構造器（空構造器）

public enum Quarter {
    SPRING, SUMMER, AUTUMN, WINTER;
}

未定義成員變數和成員方法，省略了private Quarter() {}

public enum Quarter {
    SPRING, SUMMER, AUTUMN, WINTER;
    private Quarter(){}
}

簡單說明一下：列舉enum的構造器只能是private

第二種：定義了成員變數、帶參構造器

列舉可以定義成員變數，包括成員屬性、方法，抽象方法，靜態方法等

public enum Quarter {
    SPRING("春"), SUMMER("夏"), AUTUMN("秋"), WINTER("冬");

    private Quarter(String name){
        this.name = name;
    }
    private String name;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
    //靜態方法
    public static void printName(){
        System.out.println(Quarter.SUMMER);
    }
    
    //抽象方法
    public abstract void printValue();
}

注意：列舉和類一樣，可以有多個構造器，即有了一個帶參構造器，還可以有無參構造器，編譯是可以通過的。

除此之外：

  1. 列舉enum 預設繼承了java.lang.Enum類，實現了 java.lang.Seriablizable 和 java.lang.Comparable 兩個介面，可序列化以及進行比較；
  2. 所有的列舉值都是常量，預設採用了public static final 進行了修飾，enum不是類，自然也不能被繼承或實現；
  3. 列舉值必須在第一行，否則編譯出錯；

三. 列舉常見用法

1. 獲取列舉元素以及成員變數

public static void main(String[] args) {
    //獲取列舉元素
    System.out.println(Quarter.SPRING);
    //呼叫toString()方法將列舉元素轉化為String型別
    System.out.println(Quarter.SPRING.name());
    System.out.println(Quarter.SPRING.toString());
    //獲取成員變數
    System.out.println(Quarter.SPRING.getName());
}

輸出結果：

SPRING
SPRING
SPRING
春

2. 列舉遍歷

有時候我們需要將列舉元素都取出來作為查詢條件，此時就需要進行遍歷，通過呼叫Quarter.values()方法

public static void main(String[] args) {
    //通過values()方法得到Quarter元素的陣列
    Quarter[] quarters = Quarter.values();
    List<String> quarterParam = new ArrayList<>(quarters.length);
    //將陣列中的元素儲存到List集合quarterParam中
    for (Quarter quarter : quarters) {
        quarterParam.add(quarter.toString());
    }
}

3. switch條件判斷

列舉的元素有限且固定，通過switch做條件判斷卻是正好

public static void main(String[] args){
    Quarter quarter = Quarter.AUTUMN;
    switch (quarter) {
        case SPRING:
            System.out.println("找到了，是它：" + SPRING);
            break;
        case SUMMER:
            System.out.println("找到了，是它：" + SUMMER);
            break;
        case AUTUMN:
            System.out.println("找到了，是它：" + AUTUMN);
            break;
        case WINTER:
            System.out.println("找到了，是它：" + WINTER);
            break;
        default:
            System.out.println("未找到");
            break;
    }
}

執行後結果：

找到了，是它：AUTUMN

簡單說明一下：其實此處不需要default的內容，或者說將WINTER作為default即可，因為列舉天然有型別限制，你只能傳遞它已有的元素以及null，不過正常情況下都會提前判斷傳遞的引數是否為null，當switch接收到null時會報java.lang.NullPointerException。

4. 列舉比較

4.1. 判斷是否相等

列舉判斷兩個元素是否相等直接使用==進行判斷即可，因為它非類，也無法例項化，儲存位置自然也不會根據物件的不同而不同。

public static void main(String[] args){
    System.out.println(Quarter.AUTUMN == Quarter.AUTUMN);
    System.out.println(Quarter.AUTUMN == Quarter.WINTER);
}

執行結果：

true
false

也可以通過equals()方法進行比較，不過沒必要，因為其底層也是通過 == 來實現的。

public abstract class Enum<E extends Enum<E>>
        implements Comparable<E>, Serializable {
    //equals比較
    public final boolean equals(Object other) {
        return this==other;
    }
}

4.2. 順序比較

通過compareTo進行列舉元素比較，此處比較的是在列舉中元素的先後順序，返回的是位置序數的差值

public static void main(String[] args){
    System.out.println(Quarter.AUTUMN.compareTo(Quarter.SPRING));
    System.out.println(Quarter.AUTUMN.compareTo(Quarter.WINTER));
}

執行結果為：

2
-1

我們看一下compareTo方法

public abstract class Enum<E extends Enum<E>>
        implements Comparable<E>, Serializable {
    //元素在列舉中的序號
    private final int ordinal;
    //可以看到compareTo方法返回的就是兩個元素ordinal的差值
    public final int compareTo(E o) {
        Enum<?> other = (Enum<?>)o;
        Enum<E> self = this;
        if (self.getClass() != other.getClass() &&
            self.getDeclaringClass() != other.getDeclaringClass())
            throw new ClassCastException();
        return self.ordinal - other.ordinal;
    }
}

5. 列舉也可也實現介面

public interface WeatherInterface {
    //獲取溫度
    public String getTemperature(Quarter quarter);
}
public enum Quarter implements WeatherInterface{
    SPRING("春"), SUMMER("夏"), AUTUMN("秋"), WINTER("冬");
    
    private Quarter(String name){
        this.name = name;
    }

    private String name;

    public String getName() {
        return name;
    }
    //重寫獲取溫度方法
    @Override
    public String getTemperature(Quarter quarter) {
        switch (quarter) {
            case SPRING:
                return "適中";
            case SUMMER:
                return "熱";
            case AUTUMN:
                return "涼爽";
            case WINTER:
                return "寒冷";
            default:
                return "無法確定";
        }
    }
}

但注意列舉不可繼承其他類

public class Pquarter {}
//無法編譯通過
public enum Quarter extends Pquarter {}

6. 使用介面來組織列舉

如果列舉太多也不好管理，同時條理不夠清晰，我們可以通過介面來將多個相關列舉組織在一起進行管理，

public interface Weather {
    enum Quarter implements Weather {
        SPRING, SUMMER, AUTUMN, WINTER;
    }
    enum Temperature implements Weather {
        MODERATE, HEAT, COOL, COLD
    }
    //呼叫時直接通過Weather.Quarter.SPRING即可。
}

四. 總結

本文主要介紹了列舉enum主要特點，定義，無參構造器，有參構造器，列舉的常用方法舉例以及主要的應用場景，若有不對之處，請批評指正，望共同進步，謝謝！

相關文章