基于哈希表(散列表)的Map接口实现类.提供所有可供选择map操作.允许key, value为null.(HashMap除了它是非线程安全的 这一点外,大体上与HashTable类似).HashMap是无序的,并且元素放入map中的顺序也不是一成不变的.
如果哈希算法将元素分散在合适的桶(bucket)中,那么HashMap能针对与像 get 和 put 这样的基础操作表现出优异的性能.对集合视图的遍历需要的时间与 HashMap 的 capacity 值(即桶的数量) 加上size(键值对的数量)成正比.因此,如果对遍历的性能有要求的话,不要把 initial capacity设置过高(或者load factor 设置过低).
initial capacity 和 load factor这两个参数影响着HashMap的性能. capacity 是HashMap中桶的数量,initial capacity 简言之是HashMap创建时桶的数量. load factor 是指在HashMap的capacity 自动扩容之前,map可以有多满. 当HashMap中键值对的数量达到capacity 和 load factor 的乘积时,将会被rehashed(内部数据结构被重构)来让HashMap的桶的数量翻倍.
一般来说,默认的加载因子(0.75)在时间和空间消耗上表现的比较平衡.变大虽然减少了空间的损耗,但是会增加查找的消耗(表现在大多数的map操作上,包括get和put).设置initial capacity时应该考虑预期的键值对数量和load factor,以便于最小化rehash操作的次数.如果initial capacity 比键值对的最大数量除以load factor 都大, rehash操作将永远不会出现.
如果map里要存储很多键值对,那么创建一个足够大的capacity将会免去rehash(自动扩容)带来的应能损耗从而更高效的保存.注意,如果用许多hashCode相同的键将会降低HashMap的性能.为了改良碰撞的性能,当键是可比较的(实现Comparable接口),可以在键之间用比较指令辅助解决这个问题.
注意,HashMap是非同步的(非线程安全的),如果多个线程并发访问一个HashMap,并且至少一个线程修改了HashMap的结构,必须进行额外的同步.(结构修改就是 添加或者删除了一个或多个键值对(映射关系),仅仅改变一个Map中已有的键对应的值不算结构修改).通常,熟练的做法是对 原本封装了map的对象 做同步.
如果不存在这样的对象,map应该用Collections.synchronizedMap()方法来封装. 为防止对map的意外非同步的访问,最好在创建时就对map封装.
所有通过这个类的集合视图方法返回的迭代器都是快速失败的: 如果迭代器创建创建好后的任意时间点,map的结构被修改了,迭代器都将抛出ConcurrentModificationException异常, 除了迭代器自己的remove方法.因此,在并发的修改的情况下,迭代器迅速且干净利落的失败,而不是冒着在将来一个不确定的时间有随意的,不确定的行为的风险.
注意,迭代器的的快速失败行为不是完全可靠的,一般而言, 在并发修改出现时,不可能做到绝对的可靠.迭代器的快速失败特性 尽可能的抛出ConcurrentModificationException. 因此, 为了程序的正确性依赖此异常编程来是错误的,迭代器的快速失败行为只应该用来debug.
实现说明
HashMap通常以装箱(桶)式hash表的形式存在,但当桶变得太大时,所有桶内部的结构会由链表的形式改变为树的形式,每个桶内的结构与TreeMap的结构类似. 大多数方法都尝试使用常规(链表式)的桶, 但在适当的情况下(通过简单地验证节点的类型), 用树形式的(桶的)方法来代替链表式的桶的方法.树形的桶遍历使用时和链表式的桶一样,但另外当桶内的元素数量过大时,树形式的桶查找更为高效.然而,在通常情况下,大多数链表式的桶内元素不会超量, 检查树形的桶存在也许会让map的方法产生延迟.
树形式的桶(也就是,桶里的元素全部是的树节点)主要按hashCode进行排序, 但在hashCode相同的情况下, 如果两个元素都是可比较的(实现Comparable接口),就用compareTo方法进行排序(我们谨慎的通过反射来验证泛型类型,参见comparableClassFor方法).当key的hashCode不同或者key已经排序时, 树形式的桶的增加了复杂性, 但在意外或恶意使用分散不均匀的hashCode方法,或者多个key有相同的hashCode时,只要key是可比较的,树形式的桶最坏也能提供O(log n)的时间复杂度,性能降低的更优雅(即当map中的元素的不均匀分布,因为hashCode相同而落在同一个桶中,树形式的桶最坏也能只需要O(log n)的时间复杂度,相比链表式的桶性能更优),因此这也是有价值的. (如果这两条都不占到,与不采取预防措施(桶树形化)相比,我们也许浪费了大约两倍的时间和空间.但是唯一已知的的例子是由糟糕的用户编程实践造成的,这已经很慢了,(桶的树形化)几乎没啥不同.
树形化节点大约是链表形式节点的两倍大小,因此只有在桶中的元素足够多才使用树形化节点(参考TREEIFY_THRESHOLD). 并且当树形式的桶中的元素数量变得太小时(因为remove和resize操作), 将会从树形式的桶转换回链表形式的桶. 在hashCode均匀分布的情况下,很少用到树形式的桶. 理论上来说, 在hashCode随机的情况下,由于扩容阈值为默认值0.75,桶中节点的分布遵循一个平均值约为0.5泊松分布(http://en.wikipedia.org/wiki/Poisson_distribution),尽管因为扩容的力度而有一个巨大的方差. 忽略方差,期望出现的列表的长度k是(exp(-0.5)*pow(0.5, k) /factorial(k)),最初的几个值为:
0: 0.60653066
1: 0.30326533
2: 0.07581633
3: 0.01263606
4: 0.00157952
5: 0.00015795
6: 0.00001316
7: 0.00000094
8: 0.00000006
更多: 一千万中少于一个.
树形式的桶的根节点一般都是它的第一个节点.然而,有时候(目前只有在Iterator.remove这种场景下),根节点也许在其他地方,但是能够循着父节点的链接恢复(红黑树自旋)(方法method TreeNode.root()). 所有可应用的内部方法接收一个hashCode作为参数( 通常由一个public方法提供), 允许它们互相调用,不用重复计算hashCode. 大多数内部方法也会接收一个 tap 参数, 这就是当前table数组,当扩容或者转换时,tab可能是新的那个也可能是旧的那个.
当桶在树形化/分割/取消树形化时, 保持节点在相同的 访问/遍历 相对顺序(即Node.next)来更好的保存位置,轻微的简化了 分割 或者 调用了iterator.remove的遍历 的处理. 使用比较器插入时, 我们比较 类型 和 能标识身份的hashCode, 通过再平衡保持一个总体的顺序(或者与需要的尽可能接近的顺序).
源码解析
static final int DEFAULT_INITIAL_CAPACITY = 1 << 4; // aka 16
static final int MAXIMUM_CAPACITY = 1 << 30;
static final float DEFAULT_LOAD_FACTOR = 0.75f;
static final int TREEIFY_THRESHOLD = 8;
static final int UNTREEIFY_THRESHOLD = 6;
static final int MIN_TREEIFY_CAPACITY = 64;
常量
DEFAULT_INITIAL_CAPACITY 默认初始化时桶的数量 16MAXIMUM_CAPACITY 桶的最大数量DEFAULT_LOAD_FACTOR 加载因子(扩容的阈值)TREEIFY_THRESHOLD 树形化的阈值(至少达到8个才可能将桶由链表树形化)UNTREEIFY_THRESHOLD 树的桶形化阈值(当树的元素个数小于这个值时,将树转换成链表)MIN_TREEIFY_CAPACITY 树形化时capacity的最小值(必须达到这个值,才可以将桶由链表树形化,如果未达到这个值但是桶中的元素个数过多,将会执行resize操作)静态工具
static class Node<K,V> implements Map.Entry<K,V> {
final int hash;
final K key;
V value;
Node<K,V> next;
Node(int hash, K key, V value, Node<K,V> next) {
this.hash = hash;
this.key = key;
this.value = value;
this.next = next;
}
public final K getKey() { return key; }
public final V getValue() { return value; }
public final String toString() { return key + "=" + value; }
public final int hashCode() {
return Objects.hashCode(key) ^ Objects.hashCode(value);
}
public final V setValue(V newValue) {
V oldValue = value;
value = newValue;
return oldValue;
}
public final boolean equals(Object o) {
if (o == this)
return true;
if (o instanceof Map.Entry) {
Map.Entry<?,?> e = (Map.Entry<?,?>)o;
if (Objects.equals(key, e.getKey()) &&
Objects.equals(value, e.getValue()))
return true;
}
return false;
}
}内部类Node实现了Map的Entry接口,包含键,值,键的hashCode,以及当前节点的下一节点next.
static final int hash(Object key) {
int h;
return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
}计算key的hashCode,让高位传播到(异或)低位. 因为HashMap桶的个数都是2的N次方,所以只是比当前位数高的位不同,而后几位和capacity位数相同,这样总是会发生碰撞(意思就是虽然两个hashCode不同,但是如果只是高位不同,低位相同,这样总是会落在相同的桶中,因为桶的个数始终是2的N次方),所以将高位传播到低位.
static Class<?> comparableClassFor(Object x) {
if (x instanceof Comparable) {
Class<?> c; Type[] ts, as; Type t; ParameterizedType p;
if ((c = x.getClass()) == String.class) // bypass checks
return c;
if ((ts = c.getGenericInterfaces()) != null) {
for (int i = 0; i < ts.length; ++i) {
if (((t = ts[i]) instanceof ParameterizedType) &&
((p = (ParameterizedType)t).getRawType() ==
Comparable.class) &&
(as = p.getActualTypeArguments()) != null &&
as.length == 1 && as[0] == c) // type arg is c
return c;
}
}
}
return null;
}如果 x 是可比较的, 返回x的类型,否则返回null. 这里也可以看出,源码对String类型做了特殊的处理,足以见得String作为key的使用频率.
static int compareComparables(Class<?> kc, Object k, Object x) {
return (x == null || x.getClass() != kc ? 0 :
((Comparable)k).compareTo(x));
}
static final int tableSizeFor(int cap) {
int n = cap - 1;
n |= n >>> 1;
n |= n >>> 2;
n |= n >>> 4;
n |= n >>> 8;
n |= n >>> 16;
return (n < 0) ? 1 : (n >= MAXIMUM_CAPACITY) ? MAXIMUM_CAPACITY : n + 1;
}计算capacity的大小,总是2的N次方.
域(字段/成员变量)
transient Node<K,V>[] table;
transient Set<Map.Entry<K,V>> entrySet;
transient int size;
transient int modCount;
int threshold;
final float loadFactor;
table数组(桶的数组), 初次使用时初始化,按需扩容.被分配以后,长度永远是2的幂(某些情况下也允许为0).
entrySet, 保存缓存的entrySet. (注意AbstractMap是 keySet,values).size, map中键值对的数量.modCount, (结构修改是指改变了键值对数量的行为)HashMap结构修改的次数,让迭代器快速失败.threshold, 扩容的阈值(当键值对达到这个数量将进行resize操作)(capacity * load factor)loadFactor, hashMap的加载因子.
公共的操作方法
public HashMap(int initialCapacity, float loadFactor) {
if (initialCapacity < 0)
throw new IllegalArgumentException("Illegal initial capacity: " +
initialCapacity);
if (initialCapacity > MAXIMUM_CAPACITY)
initialCapacity = MAXIMUM_CAPACITY;
if (loadFactor <= 0 || Float.isNaN(loadFactor))
throw new IllegalArgumentException("Illegal load factor: " +
loadFactor);
this.loadFactor = loadFactor;
this.threshold = tableSizeFor(initialCapacity);
}
public HashMap(int initialCapacity) {
this(initialCapacity, DEFAULT_LOAD_FACTOR);
}
public HashMap() {
this.loadFactor = DEFAULT_LOAD_FACTOR; // all other fields defaulted
}
public HashMap(Map<? extends K, ? extends V> m) {
this.loadFactor = DEFAULT_LOAD_FACTOR;
putMapEntries(m, false);
}几个构造函数,可以指定capacity,loadFactor,也可以不指定,使用默认值.还可以把其他map的键值对放到当前map中.
final void putMapEntries(Map<? extends K, ? extends V> m, boolean evict) {
int s = m.size();
if (s > 0) {
if (table == null) { // pre-size
float ft = ((float)s / loadFactor) + 1.0F;
int t = ((ft < (float)MAXIMUM_CAPACITY) ?
(int)ft : MAXIMUM_CAPACITY);
if (t > threshold)
threshold = tableSizeFor(t);
}
else if (s > threshold)
resize();
for (Map.Entry<? extends K, ? extends V> e : m.entrySet()) {
K key = e.getKey();
V value = e.getValue();
putVal(hash(key), key, value, false, evict);
}
}
}实现map的putAll方法,以及HashMap入参为 Map 的构造方法. 先根据入参map的size计算大小,再遍历调用putVal方法(参见下文)
public V get(Object key) {
Node<K,V> e;
return (e = getNode(hash(key), key)) == null ? null : e.value;
}
final Node<K,V> getNode(int hash, Object key) {
Node<K,V>[] tab; Node<K,V> first, e; int n; K k;
if ((tab = table) != null && (n = tab.length) > 0 &&
(first = tab[(n - 1) & hash]) != null) {
if (first.hash == hash && // always check first node
((k = first.key) == key || (key != null && key.equals(k))))
return first;
if ((e = first.next) != null) {
if (first instanceof TreeNode)
return ((TreeNode<K,V>)first).getTreeNode(hash, key);
do {
if (e.hash == hash &&
((k = e.key) == key || (key != null && key.equals(k))))
return e;
} while ((e = e.next) != null);
}
}
return null;
}get方法及其实现,先根据key的hash值(上文的hash方法计算得出)取模得到数组中对应下标的链表(头节点),然后总是校验链表头节点的key是否与查找的key equal,如果equal,就是我们找的那个Node.如果不是第一个Node,则根据桶的类型(树形桶/链表形桶遍历,直到查到目标Node或者遍历结束返回null).
public boolean containsKey(Object key) {
return getNode(hash(key), key) != null;
}containsKey方法实际上和get用了相同的实现.
public V put(K key, V value) {
return putVal(hash(key), key, value, false, true);
}
final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
boolean evict) {
Node<K,V>[] tab; Node<K,V> p; int n, i;
if ((tab = table) == null || (n = tab.length) == 0)
n = (tab = resize()).length;
if ((p = tab[i = (n - 1) & hash]) == null)
tab[i] = newNode(hash, key, value, null);
else {
Node<K,V> e; K k;
if (p.hash == hash &&
((k = p.key) == key || (key != null && key.equals(k))))
e = p;
else if (p instanceof TreeNode)
e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
else {
for (int binCount = 0; ; ++binCount) {
if ((e = p.next) == null) {
p.next = newNode(hash, key, value, null);
if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
treeifyBin(tab, hash);
break;
}
if (e.hash == hash &&
((k = e.key) == key || (key != null && key.equals(k))))
break;
p = e;
}
}
if (e != null) { // existing mapping for key
V oldValue = e.value;
if (!onlyIfAbsent || oldValue == null)
e.value = value;
afterNodeAccess(e);
return oldValue;
}
}
++modCount;
if (++size > threshold)
resize();
afterNodeInsertion(evict);
return null;
}
put方法.相同key,新值会覆盖旧值.putVal方法先找当前key对应的Node,如果key对应的Node为空,直接新建一个Node放入数组中;如果当前Node不为空判断Node是树节点还是链表节点,如果是树节点,则调用树节点的插入方法;如果是链表节点,则开始遍历key对应的链表(桶),将新的键值对插在链表末端,其中还要判断插入节点对后,桶内的节点数量是否达到了桶的树形化的数量,如果是,则需要调用树形化方法(树形化方法未必会将map树形化,如果当前tab数组的长度即capicity的小于64的话,会进行resize操作而不是树形化).插入完成后判断是否需要扩容.
final Node<K,V>[] resize() {
Node<K,V>[] oldTab = table;
int oldCap = (oldTab == null) ? 0 : oldTab.length;
int oldThr = threshold;
int newCap, newThr = 0;
if (oldCap > 0) {
if (oldCap >= MAXIMUM_CAPACITY) {
threshold = Integer.MAX_VALUE;
return oldTab;
}
else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
oldCap >= DEFAULT_INITIAL_CAPACITY)
newThr = oldThr << 1; // double threshold
}
else if (oldThr > 0) // initial capacity was placed in threshold
newCap = oldThr;
else { // zero initial threshold signifies using defaults
newCap = DEFAULT_INITIAL_CAPACITY;
newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
}
if (newThr == 0) {
float ft = (float)newCap * loadFactor;
newThr = (newCap < MAXIMUM_CAPACITY && ft < (float)MAXIMUM_CAPACITY ?
(int)ft : Integer.MAX_VALUE);
}
threshold = newThr;
@SuppressWarnings({"rawtypes","unchecked"})
Node<K,V>[] newTab = (Node<K,V>[])new Node[newCap];
table = newTab;
if (oldTab != null) {
for (int j = 0; j < oldCap; ++j) {
Node<K,V> e;
if ((e = oldTab[j]) != null) {
oldTab[j] = null;
if (e.next == null)
newTab[e.hash & (newCap - 1)] = e;
else if (e instanceof TreeNode)
((TreeNode<K,V>)e).split(this, newTab, j, oldCap);
else { // preserve order
Node<K,V> loHead = null, loTail = null;
Node<K,V> hiHead = null, hiTail = null;
Node<K,V> next;
do {
next = e.next;
if ((e.hash & oldCap) == 0) {
if (loTail == null)
loHead = e;
else
loTail.next = e;
loTail = e;
}
else {
if (hiTail == null)
hiHead = e;
else
hiTail.next = e;
hiTail = e;
}
} while ((e = next) != null);
if (loTail != null) {
loTail.next = null;
newTab[j] = loHead;
}
if (hiTail != null) {
hiTail.next = null;
newTab[j + oldCap] = hiHead;
}
}
}
}
}
return newTab;
}
resize方法, 初始化或者扩大一倍HashMap的size,map中元素的位置,要么在原先的桶中,要么在桶+原先的size的,这是因为size始终是2的幂. resize方法先通过一些判断得到扩容后新数组的长度,以及新数组扩容的阈值,再循环原数组,将链表拆分放到新的数组中. 具体做法是先判断,如果链表中只有单个节点,则直接放入对应的数组中的位置,如果有多个节点,就需要拆分了.
public V remove(Object key) {
Node<K,V> e;
return (e = removeNode(hash(key), key, null, false, true)) == null ?
null : e.value;
}
final Node<K,V> removeNode(int hash, Object key, Object value,
boolean matchValue, boolean movable) {
Node<K,V>[] tab; Node<K,V> p; int n, index;
if ((tab = table) != null && (n = tab.length) > 0 &&
(p = tab[index = (n - 1) & hash]) != null) {
Node<K,V> node = null, e; K k; V v;
if (p.hash == hash &&
((k = p.key) == key || (key != null && key.equals(k))))
node = p;
else if ((e = p.next) != null) {
if (p instanceof TreeNode)
node = ((TreeNode<K,V>)p).getTreeNode(hash, key);
else {
do {
if (e.hash == hash &&
((k = e.key) == key ||
(key != null && key.equals(k)))) {
node = e;
break;
}
p = e;
} while ((e = e.next) != null);
}
}
if (node != null && (!matchValue || (v = node.value) == value ||
(value != null && value.equals(v)))) {
if (node instanceof TreeNode)
((TreeNode<K,V>)node).removeTreeNode(this, tab, movable);
else if (node == p)
tab[index] = node.next;
else
p.next = node.next;
++modCount;
--size;
afterNodeRemoval(node);
return node;
}
}
return null;
}
remove方法,先根据要删除的key找到要删除的N节点所在数组中的位置和链表中的位置, 然后根据节点的类型分别实现删除的方法.
public void clear() {
Node<K,V>[] tab;
modCount++;
if ((tab = table) != null && size > 0) {
size = 0;
for (int i = 0; i < tab.length; ++i)
tab[i] = null;
}
}
clear方法,清空表中桶的数组;
public boolean containsValue(Object value) {
Node<K,V>[] tab; V v;
if ((tab = table) != null && size > 0) {
for (int i = 0; i < tab.length; ++i) {
for (Node<K,V> e = tab[i]; e != null; e = e.next) {
if ((v = e.value) == value ||
(value != null && value.equals(v)))
return true;
}
}
}
return false;
}
containsValue方法, map中是否包含改值,该方法遍历了表中的桶,以及桶中的链表,因此性能比 containsKey方法要差.
public Set<K> keySet() {
Set<K> ks = keySet;
if (ks == null) {
ks = new KeySet();
keySet = ks;
}
return ks;
}
public Collection<V> values() {
Collection<V> vs = values;
if (vs == null) {
vs = new Values();
values = vs;
}
return vs;
}
public Set<Map.Entry<K,V>> entrySet() {
Set<Map.Entry<K,V>> es;
return (es = entrySet) == null ? (entrySet = new EntrySet()) : es;
}keySet, values(valueSet),entrySet分别是map的键的集合,值的集合,以及键值对的集合,它们的共性是: 这些集合是由map支持的,所以对map的改变可以在这些集合中感知,反之亦然. 当程序中正在使用迭代器遍历时,如果map被修改(除了通过迭代器自身的remove方法,或者对map返回的一个enentry进行的 putValue操作), 迭代器迭代的结果将会变得不明确.
252
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
