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(<span class="hljs-string">"green name(): "</span> + green.name());
System.out.println(<span class="hljs-string">"green getDeclaringClass(): "</span> + green.getDeclaringClass());
System.out.println(<span class="hljs-string">"green hashCode(): "</span> + green.hashCode());
System.out.println(<span class="hljs-string">"green compareTo Color.GREEN: "</span> + green.compareTo(Color.GREEN));
System.out.println(<span class="hljs-string">"green equals Color.GREEN: "</span> + green.equals(Color.GREEN));
System.out.println(<span class="hljs-string">"green equals Size.MIDDLE: "</span> + green.equals(Size.MIDDLE));
System.out.println(<span class="hljs-string">"green equals 1: "</span> + green.equals(<span class="hljs-number">1</span>));
System.out.format(<span class="hljs-string">"green == Color.BLUE: %b\n"</span>, 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
枚舉的特性
枚舉的特性，歸結起來就是一句話：
除了不能繼承，基本上可以將
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";
}
};
<span class="hljs-keyword">private</span> <span class="hljs-keyword">int</span> code;
<span class="hljs-comment">// 構造方法：enum的構造方法只能被聲明為private權限或不聲明權限</span>
<span class="hljs-function"><span class="hljs-keyword">private</span> <span class="hljs-title">ErrorCode</span><span class="hljs-params">(<span class="hljs-keyword">int</span> number)</span> </span>{ <span class="hljs-comment">// 構造方法</span>
<span class="hljs-keyword">this</span>.code = number;
}
<span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">int</span> <span class="hljs-title">getCode</span><span class="hljs-params">()</span> </span>{ <span class="hljs-comment">// 普通方法</span>
<span class="hljs-keyword">return</span> code;
} <span class="hljs-comment">// 普通方法</span>
<span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">abstract</span> String <span class="hljs-title">getDescription</span><span class="hljs-params">()</span></span>; <span class="hljs-comment">// 抽象方法</span>
<span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">static</span> <span class="hljs-keyword">void</span> <span class="hljs-title">main</span><span class="hljs-params">(String args[])</span> </span>{ <span class="hljs-comment">// 靜態方法</span>
<span class="hljs-keyword">for</span> (ErrorCode s : ErrorCode.values()) {
System.out.println(<span class="hljs-string">"code: "</span> + s.getCode() + <span class="hljs-string">", description: "</span> + s.getDescription());
}
}
}
注：上面的例子並不可取，僅僅是為了展示枚舉支持定義各種方法。下面是一個簡化的例子
例：一個錯誤碼枚舉類型的定義
本例和上例的執行結果完全相同。
public enum ErrorCodeEn {
OK(0, "成功"),
ERROR_A(100, "錯誤A"),
ERROR_B(200, "錯誤B");
ErrorCodeEn(<span class="hljs-keyword">int</span> number, String description) {
<span class="hljs-keyword">this</span>.code = number;
<span class="hljs-keyword">this</span>.description = description;
}
<span class="hljs-keyword">private</span> <span class="hljs-keyword">int</span> code;
<span class="hljs-keyword">private</span> String description;
<span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">int</span> <span class="hljs-title">getCode</span><span class="hljs-params">()</span> </span>{
<span class="hljs-keyword">return</span> code;
}
<span class="hljs-function"><span class="hljs-keyword">public</span> String <span class="hljs-title">getDescription</span><span class="hljs-params">()</span> </span>{
<span class="hljs-keyword">return</span> description;
}
<span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">static</span> <span class="hljs-keyword">void</span> <span class="hljs-title">main</span><span class="hljs-params">(String args[])</span> </span>{ <span class="hljs-comment">// 靜態方法</span>
<span class="hljs-keyword">for</span> (ErrorCodeEn s : ErrorCodeEn.values()) {
System.out.println(<span class="hljs-string">"code: "</span> + s.getCode() + <span class="hljs-string">", description: "</span> + 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(<span class="hljs-keyword">int</span> number, String description) {
<span class="hljs-keyword">this</span>.code = number;
<span class="hljs-keyword">this</span>.description = description;
}
<span class="hljs-keyword">private</span> <span class="hljs-keyword">int</span> code;
<span class="hljs-keyword">private</span> String description;
<span class="hljs-meta">@Override</span>
<span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">int</span> <span class="hljs-title">getCode</span><span class="hljs-params">()</span> </span>{
<span class="hljs-keyword">return</span> code;
}
<span class="hljs-meta">@Override</span>
<span class="hljs-function"><span class="hljs-keyword">public</span> String <span class="hljs-title">getDescription</span><span class="hljs-params">()</span> </span>{
<span class="hljs-keyword">return</span> 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(<span class="hljs-keyword">int</span> number, String description) {
<span class="hljs-keyword">this</span>.code = number;
<span class="hljs-keyword">this</span>.description = description;
}
<span class="hljs-keyword">private</span> <span class="hljs-keyword">int</span> code;
<span class="hljs-keyword">private</span> String description;
<span class="hljs-meta">@Override</span>
<span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">int</span> <span class="hljs-title">getCode</span><span class="hljs-params">()</span> </span>{
<span class="hljs-keyword">return</span> <span class="hljs-number">0</span>;
}
<span class="hljs-meta">@Override</span>
<span class="hljs-function"><span class="hljs-keyword">public</span> String <span class="hljs-title">getDescription</span><span class="hljs-params">()</span> </span>{
<span class="hljs-keyword">return</span> <span class="hljs-keyword">null</span>;
}
}
<span class="hljs-class"><span class="hljs-keyword">enum</span> <span class="hljs-title">Fruit</span> <span class="hljs-keyword">implements</span> <span class="hljs-title">INumberEnum</span> </span>{
APPLE(<span class="hljs-number">0</span>, <span class="hljs-string">"蘋果"</span>),
ORANGE(<span class="hljs-number">0</span>, <span class="hljs-string">"桔子"</span>),
BANANA(<span class="hljs-number">0</span>, <span class="hljs-string">"香蕉"</span>);
Fruit(<span class="hljs-keyword">int</span> number, String description) {
<span class="hljs-keyword">this</span>.code = number;
<span class="hljs-keyword">this</span>.description = description;
}
<span class="hljs-keyword">private</span> <span class="hljs-keyword">int</span> code;
<span class="hljs-keyword">private</span> String description;
<span class="hljs-meta">@Override</span>
<span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">int</span> <span class="hljs-title">getCode</span><span class="hljs-params">()</span> </span>{
<span class="hljs-keyword">return</span> <span class="hljs-number">0</span>;
}
<span class="hljs-meta">@Override</span>
<span class="hljs-function"><span class="hljs-keyword">public</span> String <span class="hljs-title">getDescription</span><span class="hljs-params">()</span> </span>{
<span class="hljs-keyword">return</span> <span class="hljs-keyword">null</span>;
}
}
}
例：在類中組織 enum
本例和上例效果相同。
public class Plant2 {
public enum Vegetable implements INumberEnum {...} // 省略代碼
public enum Fruit implements INumberEnum {...} // 省略代碼
}
策略枚舉
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);
<span class="hljs-keyword">private</span> <span class="hljs-keyword">final</span> PayType payType;
PayrollDay(PayType payType) {
<span class="hljs-keyword">this</span>.payType = payType;
}
<span class="hljs-function"><span class="hljs-keyword">double</span> <span class="hljs-title">pay</span><span class="hljs-params">(<span class="hljs-keyword">double</span> hoursWorked, <span class="hljs-keyword">double</span> payRate)</span> </span>{
<span class="hljs-keyword">return</span> payType.pay(hoursWorked, payRate);
}
<span class="hljs-comment">// 策略枚舉</span>
<span class="hljs-keyword">private</span> <span class="hljs-class"><span class="hljs-keyword">enum</span> <span class="hljs-title">PayType</span> </span>{
WEEKDAY {
<span class="hljs-function"><span class="hljs-keyword">double</span> <span class="hljs-title">overtimePay</span><span class="hljs-params">(<span class="hljs-keyword">double</span> hours, <span class="hljs-keyword">double</span> payRate)</span> </span>{
<span class="hljs-keyword">return</span> hours <= HOURS_PER_SHIFT ? <span class="hljs-number">0</span> : (hours - HOURS_PER_SHIFT)
* payRate / <span class="hljs-number">2</span>;
}
},
WEEKEND {
<span class="hljs-function"><span class="hljs-keyword">double</span> <span class="hljs-title">overtimePay</span><span class="hljs-params">(<span class="hljs-keyword">double</span> hours, <span class="hljs-keyword">double</span> payRate)</span> </span>{
<span class="hljs-keyword">return</span> hours * payRate / <span class="hljs-number">2</span>;
}
};
<span class="hljs-keyword">private</span> <span class="hljs-keyword">static</span> <span class="hljs-keyword">final</span> <span class="hljs-keyword">int</span> HOURS_PER_SHIFT = <span class="hljs-number">8</span>;
<span class="hljs-function"><span class="hljs-keyword">abstract</span> <span class="hljs-keyword">double</span> <span class="hljs-title">overtimePay</span><span class="hljs-params">(<span class="hljs-keyword">double</span> hrs, <span class="hljs-keyword">double</span> payRate)</span></span>;
<span class="hljs-function"><span class="hljs-keyword">double</span> <span class="hljs-title">pay</span><span class="hljs-params">(<span class="hljs-keyword">double</span> hoursWorked, <span class="hljs-keyword">double</span> payRate)</span> </span>{
<span class="hljs-keyword">double</span> basePay = hoursWorked * payRate;
<span class="hljs-keyword">return</span> 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());
}
作者：半邊星
歡迎任何形式的轉載，但請務必注明出處。
限於本人水平，如果文章和代碼有表述不當之處，還請不吝賜教。