一、概述
根据源码英文解释,EnumMap是一种键是枚举类型的Map的实现,而EnumMap的底层实现是通过数组来实现的。
二、源码分析
1. 继承关系
public class EnumMap<K extends Enum<K>, V> extends AbstractMap<K, V>
implements java.io.Serializable, Cloneable
2.1 属性
// EnumMap的key类型,由于K继承了Enum类,所以自然EnumMap的key也是枚举类型,并且枚举类型包含了两个属性:name(名称),ordinal(次序)
private final Class<K> keyType;
// EnumMap中存储key的数组
private transient K[] keyUniverse;
// 存储EnumMap的数组,允许为null,如果为null,会被替换为内部定义的Object变量NULL
private transient Object[] vals;
// 内部变量,用于代替value中出现的null
private static final Object NULL = new Object() {
public int hashCode() {
return 0;
}
public String toString() {
return "java.util.EnumMap.NULL";
}
};
2.2 重要方法
(1) put方法(部分代码没贴出)
public V put(K key, V value) {
typeCheck(key);
int index = key.ordinal();
Object oldValue = vals[index];
vals[index] = maskNull(value);
if (oldValue == null)
size++;
return unmaskNull(oldValue);
}
大致流程:
- 检查key是否是枚举类型;
- 使用key的下标作为value数组的下标;
- 校验是否为null;
- 判断原先下标处是否有值,如果有值,即是覆盖,map大小不变;
- 将原值返回;
(2) get方法
public V get(Object key) {
return (isValidKey(key) ?
unmaskNull(vals[((Enum<?>)key).ordinal()]) : null);
}
大致流程:
- 校验key是否是枚举,key为空或类型不匹配返回null;
- 由于value保存的是数组,所以使用key的ordinal也即是下标值,从value数组中直接取出即可;
三、代码展示
我们使用一个简单的例子来展示一下实现过程。
public class EnumMapTest {
public static void main(String[] args) {
EnumMap<Color, Integer> enumMap = new EnumMap<>(Color.class);
enumMap.put(Color.RED, 1);
enumMap.put(Color.GREEN, 2);
enumMap.put(Color.BLUE, 3);
enumMap.forEach((key, value) -> {
System.out.println(key.name() + "," + key.ordinal() + "," + value);
});
}
}
enum Color {
RED, GREEN, BLUE
}
打印结果:
RED,0,1
GREEN,1,2
BLUE,2,3
四、总结
- 由于EnumMap的key是枚举类型,而枚举的属性ordinal是固定的,并且EnumMap的value存储的是一个数组,所以key的ordinal与value数组的下标的对应关系在构造方法中已经固定了,所以get的时候效率自然会很高;
- 由于key是枚举,所以key不允许null,而value是允许null的,并且null会被EnumMap的NULL实例对象所替换;
- 元素的存储顺序是根据枚举的生命的次序来确定的。
- EnumMap不是线程安全的,如果要线程安全,可以使用Collections的synchronizedMap方法;