EnumMap源码分析-白红宇

自Java8以来，HashMap是高效的。应用HashMap完成枚举类型到值的映射也是我们常用的方式，但是EnumMap将更加高效。

EnumMap顾名思义，是为枚举类服务的。

key必须为枚举类（Enum），且创建EnumMap时必须指定key的类型。

key不能为null，NullPointerException，但value允许null。

底层结构均为数组，大小为Enum成员数量，创建EnumMap时会缓存所有枚举达到key数组。

元素顺序为Enum的顺序，与put顺序无关。

与HashMap类似，不保证线程安全。

注意：

迭代时不会抛出ConcurrentModificationException。

NULL和null的区别。

1、重要属性

private

final

Class<K>

keyType;

// EnumMap的key的类型，在keyType中的enumConstants存放key的所有枚举值。

private transient K[] keyUniverse; //存放key的所有枚举值

private transient Object[] vals; // EnumMap的value值

private transient int size =0;

注意：key和value的底层机构均为数组。

常用方法:

private Object maskNull(Object value) {
        return (value == null ? NULL : value); //null变NULL，避免内部空指针异常 }

private V unmaskNull(Object value) {
        return (V)(value == NULL ? null : value); }

private static final Object NULL = new Object() {
        public int hashCode() {
            return 0;     }     public String toString() {
            return "java.util.EnumMap.NULL";     } };

2、put

public V put(K key, V value) {
        typeCheck(key); // key必须是keyType类型或keyType子类型，否则ClassCastException异常     int index = key.ordinal(); // 以key的ordinal作为数组下标     Object oldValue = vals[index];     vals[index] = maskNull(value); //maskNull: value为空则返回自定义的空对象NULL     if (oldValue == null)         size++;     return unmaskNull(oldValue); //返回oldValue或null

3、get

public V get(Object key) {
        return (isValidKey(key) ?         unmaskNull(vals[((Enum
     )key).ordinal()]) : null); }

private boolean isValidKey(Object key) { // 检验key的有效性（不为null且类型合法）     if (key == null)         return false; // Cheaper than instanceof Enum followed by getDeclaringClass     Class
      keyClass = key.getClass();     return keyClass == keyType || keyClass.getSuperclass() == keyType; }

get方法先检验key的有效性，有效则以ordinal为下标返回vals[ordinal]，否则返回null，So，和HashMap一样，不可以用get来判断EnumMap是否包含某一元素，因为某元素的value可能本就为null。

4、contains相关

public boolean containsKey(Object key) {
        return isValidKey(key) && vals[((Enum
     )key).ordinal()] != null; }

注意containsKey和get的区别（仅仅未调用unmaskNull方法），以及EnumMap自定义的NULL和null的区别。

public boolean containsValue(Object value) {
        value = maskNull(value); //null则返回NULL，否则返回value本身     for (Object val : vals) // 遍历vals         if (value.equals(val))             return true; // 只要有一个相等即返回true     return false; }

private boolean containsMapping(Object key, Object value) {
        return isValidKey(key) &&         maskNull(value).equals(vals[((Enum
     )key).ordinal()]); }

// containsMapping方法是私有的，仅供EntrySet的contains方法调用。

5、遍历相关

// 遍历KeySet

Set keySet = enumMap.keySet();

terator iteKey = keySet.iterator();

while(iteKey.hasNext()){

Object object =(Object) iteKey.next();

System.out.print(object +"="+ enumMap.get(object)+"; ");

}

------------------

// 遍历values

Collection<Object> vals = enumMap.values();

Iterator iteVal = vals.iterator();

while(iteVal.hasNext()){

Object object =(Object) iteVal.next();

System.out.print(object +"; ");

// ((Iterator) object).remove();// ClassCastException: String cannot be cast to Iterator

}

--------------------

// 遍历Entry

Set<Entry<Season, Object>> entrySet = enumMap.entrySet();

Iterator iteEn = entrySet.iterator();

while(iteEn.hasNext()){

Entry object =(Entry) iteEn.next();

System.out.print(object.getKey()+"; ");

iteEn.remove();

}

注意：和HashMap不同的是，EnumMap迭代不会抛

ConcurrentModificationException异常。

for (Object entry : enumMap.entrySet()) {

enumMap.remove(Season.summer); // 【--不抛--

ConcurrentModificationException

异常】

}

EnumMap中没有mouCount，相应Iterator中也没有expectedModCount，也就是说没有fast-fail机制。