EnumSet的使用及源碼分析

假設一種場景,如果你想用一個數表示多種狀態,那么位運算是一種很好的選擇。用或運算復合多種狀態,用與運算判斷是否包含某種狀態。
由此,你可能會寫出如下代碼:

public class Status {
    public static final int IN_STORED = 1 << 0; // 1,在倉
    public static final int ON_THE_WAY = 1 << 1; // 2,在途

    private int value;

    public void setStatus(int value) { this.value = value;  }
    public int getStatus() { return value; }
}

status.setStatus(IN_STORED | ON_THE_WAY); // 設置為即在倉也在途
IN_STORED & status.getStatus() > 0 ?   // 判斷狀態中是否包含在倉

但是Java有EnumSet,可以優化為:

public class StatusWrapper {
    public enum Status { IN_STORED, ON_THE_WAY }

    public void setStatus(Set<Status> status) { ... }
}

wrapper.setStatus(EnumSet.of(Status.IN_STORED, Status.ON_THE_WAY));

那么,使用EnumSet的好處是:
1、避免手動操作位運算可能出現的錯誤
2、代碼更簡短、清晰、安全

原理:

// EnumSet.java
public static <E extends Enum<E>> EnumSet<E> of(E e1, E e2) {
    EnumSet<E> result = noneOf(e1.getDeclaringClass());
    result.add(e1);
    result.add(e2);
    return result;
}

初始化Enum Set。還提供了其他5個of靜態函數,分別是不同參數個數,需要注意的是變長參數那個of函數可能會更慢些

// Enum.java
@SuppressWarnings("unchecked")
public final Class<E> getDeclaringClass() {
    Class<?> clazz = getClass();
    Class<?> zuper = clazz.getSuperclass();
    return (zuper == Enum.class) ? (Class<E>)clazz : (Class<E>)zuper;
}

問:為什么要定義getDeclaringClass,而不直接使用getClass呢?
答:先看如下例子:

public enum MyEnum {

   A {
       void doSomething() { ... }
   },


   B {
       void doSomethingElse() { ... }
   };}

現象:MyEnum.A.getClass()和MyEnum.A.getDeclaringClass()是不一樣的。

原因:Java enum values are permitted to have value-specific class bodies(Java枚舉值允許有特定于值的類主體),這將生成表示A和B的類主體的內部類。這些內部類將是MyEnum的子類。因此MyEnum.A.getClass()返回的是表示A類主體(A's class body)的匿名類,而MyEnum.A.getDeclaringClass()會返回MyEnum。

結論:如果是簡單的枚舉(without constant-specific class bodies),這2種方法返回的結果是一樣的,但如果枚舉包含constant-specific class bodies,就會出現不一致。因此對枚舉類進行比較的時候,使用getDeclaringClass是萬無一失的

參考資料https://stackoverflow.com/questions/5758660/java-enum-getdeclaringclass-vs-getclass

// EnumSet.java
// Creates an empty enum set with the specified element type
public static <E extends Enum<E>> EnumSet<E> noneOf(Class<E> elementType) {
    Enum<?>[] universe = getUniverse(elementType);
    if (universe == null)
        throw new ClassCastException(elementType + " not an enum");

    if (universe.length <= 64)
        return new RegularEnumSet<>(elementType, universe);
    else
        return new JumboEnumSet<>(elementType, universe);
}

noneOf函數會創建一個空枚舉set:
1、getUniverse獲取Enum數組


image.png

2、 根據數組長度,小于等于64則返回RegularEnumSet,否則JumboEnumSet
RegularEnumSet是EnumSet的子類,RegularEnumSet的構造函數中會調用EnumSet的構造函數,將枚舉類型、枚舉數組保存起來:

/**
* The class of all the elements of this set.
*/
final Class<E> elementType;

/**
* All of the values comprising T.  (Cached for performance.)
*/
final Enum<?>[] universe;

下面只選取RegularEnumSet的源碼進行分析:

// RegularEnumSet.java
public boolean add(E e) {
    typeCheck(e);

    long oldElements = elements;
    elements |= (1L << ((Enum<?>)e).ordinal());
    return elements != oldElements;
}

1)typeCheck函數校驗傳入的e是否是該枚舉中的值

2)重點是:elements |= (1L << ((Enum<?>)e).ordinal());
2.1)private long elements = 0L;
2.2)取枚舉值的ordinal,初始為0;( 每個枚舉值都對應著自己的ordinal,第一個枚舉值的ordinal為0,第二個為1,以此類推。ordinal()返回的是ordinal的值)
2.3)1 << ordinal ;
2.4)與elements做 |=運算。
例:
a. 添加ordinal為0的枚舉值,則計算后elements為1 (B)
b. 添加ordinal為1的枚舉值,則計算后elements為( 01 | 10 ) = 11 (B)
c. 添加ordinal為2的枚舉值,則計算后elements為(011 | 100) = 111 (B)

換句話說,long的最低位為1,表示存儲了ordinal為0的枚舉值,次低位為1,表示存儲了ordinal為1的枚舉值,以此類推。
所以,RegularEnumSet 就是用long型來存儲枚舉,支持64位(long64位)。

// RegularEnumSet.java
public boolean contains(Object e) {
    if (e == null)
        return false;
    Class<?> eClass = e.getClass();
    if (eClass != elementType && eClass.getSuperclass() != elementType)
        return false;

    return (elements & (1L << ((Enum<?>)e).ordinal())) != 0;

例:假設RegularEnumSet已存儲了ordinal為0,1,2的枚舉值 ,判斷ordinal為1的枚舉值是否已存儲。

1、1L << ((Enum<?>)e).ordinal() = 010 (B)

2、elements為111 (B)

3、elements & 10 = 010 (B)不等于0,則表示存在該枚舉值

參考資料:https://blog.csdn.net/u010887744/article/details/50834738

有時,我們可能需要將這種復合狀態的值記錄下來,那么可以對Type進行改造:

public enum  Type {

    IN_STORED(1 << 0, "在倉"),
    ON_THE_WAY(1 << 1, "在途"),
    ;

    private Integer value;
    private String desc;

    Type(Integer value, String desc) {
        this.value = value;
        this.desc = desc;
    }

    public Integer getValue() {
        return value;
    }

    public String getDesc() {
        return desc;
    }

    /**
     * 計算Set集合的value和
     */
    public static Integer valueOf(Set<Type> types) {
        Integer value = 0;
        for (Type type : types) {
            value += type.getValue();
        }
        return value;
    }

    /**
     * 判斷value是否包含type
     */
    public static Boolean contains(Integer value, Type type) {
        return (value & type.getValue()) > 0;
    }
}

// 外部調用:
int value = Type.valueOf(EnumSet.of(Type.IN_STORED, Type.ON_THE_WAY));
Boolean contains = Type.contains(value, Type.IN_STORED);
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,316評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,481評論 3 415
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事?!?“怎么了?”我有些...
    開封第一講書人閱讀 176,241評論 0 374
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,939評論 1 309
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,697評論 6 409
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,182評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,247評論 3 441
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,406評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,933評論 1 334
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,772評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,973評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,516評論 5 359
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,209評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,638評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,866評論 1 285
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,644評論 3 391
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,953評論 2 373

推薦閱讀更多精彩內容

  • 一、什么是枚舉? 枚舉是由一組固定的常量組成的合法值。通過這一定義,我們可以看出枚舉的核心在于常量,而且常量是固定...
    Roger_黃閱讀 970評論 0 4
  • Chapter 6 Enums and Annotations 枚舉和注解 JAVA supports two s...
    LaMole閱讀 831評論 0 2
  • 對象的創建與銷毀 Item 1: 使用static工廠方法,而不是構造函數創建對象:僅僅是創建對象的方法,并非Fa...
    孫小磊閱讀 2,010評論 0 3
  • 在公眾號“陳珂”上,看到名為《應該從哪里開始學習?怎樣學習》的一篇文章。 全文有三個標題,第三個標題是“掌握黃金思...
    思慕海閱讀 394評論 2 1
  • 蒙山浪子閱讀 130評論 0 1