Java 容器源码分析之 HashMap

HashMap 是对 Map 接口的一种基于哈希表的实现。所谓 Map,就是映射,存储一系列 Key-Value 对,一个键对应一个值,通过键来查找对应的值。HashMap 是一种高效的实现,在通常情况可以得到常数级别的查找和插入性能。

1
2
public class HashMap<K,V> extends AbstractMap<K,V>
implements Map<K,V>, Cloneable, Serializable

HashMap 继承了 AbstractMap 类,并实现了 Map、Cloneable 和 Serializable 接口。AbstractMap提供了Map接口的抽象实现,并提供了一些方法的基本实现。注意,Map接口属于集合框架,但并没有继承 Collection 接口,因此 Map 是一种集合,但并不是 Collection 类型。尽管如此,Map 对象的键可以看作 Set 对象, 值可以看作 Collection 对象,键值对则可以看作 Map.Entry 组成的 Set 对象。

下面会基于 JDK 8 中 HashMap 的源码分析其具体的实现。

底层结构

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
static final int DEFAULT_INITIAL_CAPACITY = 1 << 4; // aka 16
static final int MAXIMUM_CAPACITY = 1 << 30; //2^30
static final float DEFAULT_LOAD_FACTOR = 0.75f;

/**
* The bin count threshold for using a tree rather than list for a
* bin. Bins are converted to trees when adding an element to a
* bin with at least this many nodes. The value must be greater
* than 2 and should be at least 8 to mesh with assumptions in
* tree removal about conversion back to plain bins upon
* shrinkage.
*/

static final int TREEIFY_THRESHOLD = 8;

/**
* The bin count threshold for untreeifying a (split) bin during a
* resize operation. Should be less than TREEIFY_THRESHOLD, and at
* most 6 to mesh with shrinkage detection under removal.
*/

static final int UNTREEIFY_THRESHOLD = 6;

/**
* The smallest table capacity for which bins may be treeified.
* (Otherwise the table is resized if too many nodes in a bin.)
* Should be at least 4 * TREEIFY_THRESHOLD to avoid conflicts
* between resizing and treeification thresholds.
*/

static final int MIN_TREEIFY_CAPACITY = 64;

使用了基于数组的哈希表的结构,数组中每一个元素都是一个链表,把数组中的每一格称为一个桶(bin或bucket)。当数组中已经被使用的桶的数量超过容量和装填因子的积,会进行扩容操作。

由于每一个桶中都是一个单向链表,hash 相同的键值对都会作为一个节点被加入这个链表,当桶中键值对数量过多时会将桶中的单向链表转化为一个树。通过TREEIFY_THRESHOLD、UNTREEIFY_THRESHOLD和MIN_TREEIFY_CAPACITY来控制转换需要的阈值。

在JDK 8之前的 HashMap 中都只是采取了单向链表的方式,哈希碰撞会给查找带来灾难性的影响。在最差的情况下,HashMap 会退化为一个单链表,查找时间由 O(1) 退化为 O(n) 。而在JDK 8中,如果单链表过长则会转换为一颗红黑树,使得最坏情况下查找的时间复杂度为 O(log n) 。红黑树节点的空间占用相较于普通节点要高出许多,通常只有在比较极端的情况下才会由单链表转化为红黑树。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
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;
}
}

HashMap 的 Entry 定义如上所示,包括了键、值以及下一个节点的引用,其实就是单向链表中的一个节点。这个节点是在普通的桶中使用的,在树形桶中使用的节点 TreeNode 是 LinkedHashMap.Entry 的子类,而 LinkedHashMap.Entry 又是 HashMap.Node 的子类。使用 TreeNode 节点构造一颗红黑树,在红黑树中查找时可以发挥二叉查找的优势。当然,由于TreeNode也可以被当作普通节点的扩展,红黑树也可以按照单链表的方式进行遍历,后面会看到在遍历所有元素的时候就是当作单向链表处理的。红黑树的各种操作比较复杂,我会再专门写一篇文章进行介绍,现在只需要知道有这么回事就可以了。

HashMap 中使用的一些成员变量如下,就不用再多加介绍了。注意变量 table 的注释中说表的容量必须是2的幂次方,我们会在后面分析为什么这样要求。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
/**
* The table, initialized on first use, and resized as
* necessary. When allocated, length is always a power of two.
* (We also tolerate length zero in some operations to allow
* bootstrapping mechanics that are currently not needed.)
*/

transient Node<K,V>[] table;

/**
* Holds cached entrySet(). Note that AbstractMap fields are used
* for keySet() and values().
*/

transient Set<Map.Entry<K,V>> entrySet;

/**
* The number of key-value mappings contained in this map.
*/

transient int size;

/**
* The number of times this HashMap has been structurally modified
* Structural modifications are those that change the number of mappings in
* the HashMap or otherwise modify its internal structure (e.g.,
* rehash). This field is used to make iterators on Collection-views of
* the HashMap fail-fast. (See ConcurrentModificationException).
*/

transient int modCount;

初始化

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
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);
}

/**
* Returns a power of two size for the given target capacity.
*/

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;
}

HashMap的构造方法没什么好说的,默认的容量为16。我们在 HashMap 的构造函数中并没有看到为 table 数组分配空间的语句,因为这里采用了延迟加载的方式,直到第一次调用 put 方法时才会真正地分配数组空间。具体见后面关于 resize() 方法的分析。

我们主要解析一下 tableSizeFor(int cap) 方法。前面说过,表的大小要求是2的幂次方,但如果构造函数中指定的容量并不是2的幂次方,这一点要怎么保证呢?

>>>是无符号右移操作,|是位或操作,经过五次右移和位或操作可以保证得到大小为2^k-1的数。看一下这个例子:

1
2
3
4
0 0 0 0 1 ? ? ? ? ?     //n
0 0 0 0 1 1 ? ? ? ? //n |= n >>> 1;
0 0 0 0 1 1 1 1 ? ? //n |= n >>> 2;
0 0 0 0 1 1 1 1 1 1 //n |= n >>> 4;

在进行5次位移操作和位或操作后就可以得到 2^k-1,最后加1即可。

哈希计算及映射

如果让我们来设计一个哈希表,可能最容易想到的就是使用 Key 自身的 hashCode() 方法来得到哈希值,然后通过 hashCode()%n 的方式来确定在数组中放置的bin的位置。我们看一下 HashMap 中是怎么实现的。

1
2
3
4
5
6
7
8
static final int hash(Object key) {
int h;
return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
}

static int indexFor(int h, int length) {
return h & (length - 1);
}

在计算哈希值时,使用 Key 对象自身的哈希值,并让高位和低位进行异或操作。indexFor() 方法用来计算哈希值为 h 在长为 length 的数组中出现的位置,该方法在源码中并没有显式出现,不过所有的操作都是这样完成的。这个方法完成的实际就是取模的操作。

前面说过,length必须是2^n,因而(length-1)的二进制表示为0...011...11 的形式,位与操作后保留了 h 的低位,实际上就是 h%length。只是位操作相比于取模的操作更加高效。这也解释了为什么必须要求数组长度是2的幂次方,因为只有这样才能保证使用位与取模的正确性。再回过头来看看 hash() 操作,因为映射时只保留了低位信息,两个值如果低位相同很可能会发生碰撞;而将高位和低位异或,引入了高位的信息,减少了碰撞的概率。

HashpMap支持为 null 的键和值,对于 key 为 null 的情况,其哈希值为0。

扩容

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
/**
* Initializes or doubles table size. If null, allocates in
* accord with initial capacity target held in field threshold.
* Otherwise, because we are using power-of-two expansion, the
* elements from each bin must either stay at same index, or move
* with a power of two offset in the new table.
*
* @return the table
*/

final Node<K,V>[] resize() {
//使用oldTab指向原来的hash表
//通常方法内都使用局部变量,局部变量在方法栈上,而对象的成员在堆上
//方法栈的访问比堆更高效
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
}
//oldCap <=0,table空间尚未分配,初始化分配空间
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;
//原来的表中有内容,表明这是一次扩容,需要将Entry散列到新的位置
if (oldTab != null) {
//遍历所有的bins
for (int j = 0; j < oldCap; ++j) {
Node<K,V> e;
if ((e = oldTab[j]) != null) {
oldTab[j] = null; //旧表中赋null,便于GC
//该桶中只有一个节点,直接散列到新的位置
if (e.next == null)
newTab[e.hash & (newCap - 1)] = e;
//该桶中是一颗红黑树,通过红黑树的split方法处理
else if (e instanceof TreeNode)
((TreeNode<K,V>)e).split(this, newTab, j, oldCap);
//单项链表,从新散列,但要保证Entry原来的顺序
//因为容量加倍了,散列时使用的位数扩展了一位
//该链表中Entry散列后可能有两个位置,通过新扩展位为0或1区分
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;
//新扩展位为0(oldCap为2^k),低链表
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;
//高链表的位置相对于低链表的偏移为oldCap
newTab[j + oldCap] = hiHead;
}
}
}
}
}
return newTab;
}

添加及更新操作

向 HashMap 中添加及更新一个已存在的 Entry 都是通过 putVal(int hash, K key, V value, boolean onlyIfAbsent,boolean evict) 方法来实现的,该方法的详细解释见下面的代码。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
/**
* Implements Map.put and related methods
*
* @param hash hash for key
* @param key the key
* @param value the value to put
* @param onlyIfAbsent if true, don't change existing value
* @param evict if false, the table is in creation mode.
* @return previous value, or null if none
*/

//onlyIfAbsent控制已存在Key的行为,若为true,则Key存在时不修改
//evict用于控制插入回调函数的行为,构造函数中调用evict为false,其余为true
final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
boolean evict)
{

//使用局部变量tab而不是类成员,方法栈上访问更快
Node<K,V>[] tab; Node<K,V> p; int n, i;
//当前table还没有分配空间,或大小为0,要先用resize()初始化
if ((tab = table) == null || (n = tab.length) == 0)
n = (tab = resize()).length;
//散列到对应的bin,若该bin为空,直接放入Entry即可
if ((p = tab[i = (n - 1) & hash]) == null)
tab[i] = newNode(hash, key, value, null);
//bin中已经存在了单链表或红黑树
else {
Node<K,V> e; K k;
//根节点的Key就是要插入的Key
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 {
//遍历链表,并统计该bin种Entry数量
for (int binCount = 0; ; ++binCount) {
//该Key在链表中不存在,插入末尾
//此时e == null
if ((e = p.next) == null) {
p.next = newNode(hash, key, value, null);
//bin中Entry数量大于阈值,转化为红黑树
if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
treeifyBin(tab, hash);
break;
}
//该Key已经在链表中
if (e.hash == hash &&
((k = e.key) == key || (key != null && key.equals(k))))
break;
p = e;
}
}
// e != null,说明该Key已经在存在于HashMap中
// onlyIfAbsent 控制是否替换原来的value
if (e != null) { // existing mapping for key
V oldValue = e.value;
if (!onlyIfAbsent || oldValue == null)
e.value = value;
//调用回调函数,HashMap中并没有实现具体行为
afterNodeAccess(e);
return oldValue;
}
}
++modCount; //修改计数加1
if (++size > threshold)
//超出阈值,扩容
resize();
//插入完成后的回调,HashMap中并没有实现具体行为
afterNodeInsertion(evict);
return null;
}

replace() 方法的实现需要先查找到指定的 Entry,然后直接操作 Entry。查找操作的分析见下一节。

查找

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
/**
* Implements Map.get and related methods
*
* @param hash hash for key
* @param key the key
* @return the node, or null if none
*/

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);
}
}
//未查找到,返回null
return null;
}

public V get(Object key) {
Node<K,V> e;
return (e = getNode(hash(key), key)) == null ? null : e.value;
}

public boolean containsKey(Object key) {
return getNode(hash(key), key) != null;
}

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) {
//按照单链表的方式进行遍历,
//因为HashMap中 TreeNode 节点也存在next成员,可以用链表的方式进行遍历
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;
}

删除

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
/**
* Implements Map.remove and related methods
*
* @param hash hash for key
* @param key the key
* @param value the value to match if matchValue, else ignored
* @param matchValue if true only remove if value is equal
* @param movable if false do not move other nodes while removing
* @return the node, or null if none
*/

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) {
//p指向bin中的第一个Entry
//node指向目标Entry
Node<K,V> node = null, e; K k; V v;
//第一个Entry就命中
if (p.hash == hash &&
((k = p.key) == key || (key != null && key.equals(k))))
node = p;
else if ((e = p.next) != null) {
//在红黑树中查找目标Entry
if (p instanceof TreeNode)
node = ((TreeNode<K,V>)p).getTreeNode(hash, key);
//在单链表中查找目标Entry
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);
}
}
//找到目标Entry且符合移除的条件
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;
}

public V remove(Object key) {
Node<K,V> e;
return (e = removeNode(hash(key), key, null, false, true)) == null ?
null : e.value;
}

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;
}
}

遍历

HashMap 提供了三种方式来遍历其中的 Entry、Key 及Value,分别是 Set<Map.Entry<K,V>> entrySet()Set<K> keySet()Collection<V> values()。这三个方法的基本用法就不再介绍了,它们返回的都是可迭代的 Set 或 Collection。要弄清楚这三个方法的内部实现机制,首先要来看一下内部抽象类 HashIterator

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
abstract class HashIterator {
Node<K,V> next; // next entry to return
Node<K,V> current; // current entry
int expectedModCount; // for fast-fail
int index; // current slot

HashIterator() {
//用expectedModCount保存刚创建迭代器时的modCount,
//实现fail-fast机制需要对比该值和使用时的modCount
expectedModCount = modCount;
Node<K,V>[] t = table;
current = next = null;
index = 0;
//找到第一个有效的槽
if (t != null && size > 0) { // advance to first entry
do {} while (index < t.length && (next = t[index++]) == null);
}
}

public final boolean hasNext() {
return next != null;
}

final Node<K,V> nextNode() {
Node<K,V>[] t;
Node<K,V> e = next;
//fail-fast 检查
if (modCount != expectedModCount)
throw new ConcurrentModificationException();
if (e == null)
throw new NoSuchElementException();
//next = e.next
//遍历是通过单链表的方式来访问的,即便是红黑树也可以这样来遍历
//TreeNode中也存在next引用,也可以看做单链表
if ((next = (current = e).next) == null && (t = table) != null) {
//如果到达当前链表末尾next == null
//寻找下一个有效的槽
do {} while (index < t.length && (next = t[index++]) == null);
}
return e;
}

public final void remove() {
Node<K,V> p = current;
if (p == null)
throw new IllegalStateException();
//fail-fast 检查
if (modCount != expectedModCount)
throw new ConcurrentModificationException();
current = null;
K key = p.key;
//调用removeNode移除Entry
removeNode(hash(key), key, null, false, false);
//更新expectedModCount
expectedModCount = modCount;
}
}

final class KeyIterator extends HashIterator
implements Iterator<K> {

public final K next() { return nextNode().key; }
}

final class ValueIterator extends HashIterator
implements Iterator<V> {

public final V next() { return nextNode().value; }
}

final class EntryIterator extends HashIterator
implements Iterator<Map.Entry<K,V>> {

public final Map.Entry<K,V> next() { return nextNode(); }
}

KeyIteratorValueIteratorEntryIterator 都继承了 HashIterator,区别只在于 next() 方法返回的是 Key、Value 还是 Entry。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
//返回一个可迭代的Set
public Set<Map.Entry<K,V>> entrySet() {
Set<Map.Entry<K,V>> es;
return (es = entrySet) == null ? (entrySet = new EntrySet()) : es;
}

final class EntrySet extends AbstractSet<Map.Entry<K,V>> {
public final int size() { return size; }
public final void clear() { HashMap.this.clear(); }
//返回一个迭代器
public final Iterator<Map.Entry<K,V>> iterator() {
return new EntryIterator();
}
public final boolean contains(Object o) {
if (!(o instanceof Map.Entry))
return false;
Map.Entry<?,?> e = (Map.Entry<?,?>) o;
Object key = e.getKey();
Node<K,V> candidate = getNode(hash(key), key);
return candidate != null && candidate.equals(e);
}
public final boolean remove(Object o) {
if (o instanceof Map.Entry) {
Map.Entry<?,?> e = (Map.Entry<?,?>) o;
Object key = e.getKey();
Object value = e.getValue();
return removeNode(hash(key), key, value, true, true) != null;
}
return false;
}
public final Spliterator<Map.Entry<K,V>> spliterator() {
return new EntrySpliterator<>(HashMap.this, 0, -1, 0, 0);
}
public final void forEach(Consumer<? super Map.Entry<K,V>> action) {
Node<K,V>[] tab;
if (action == null)
throw new NullPointerException();
if (size > 0 && (tab = table) != null) {
int mc = modCount;
for (int i = 0; i < tab.length; ++i) {
for (Node<K,V> e = tab[i]; e != null; e = e.next)
action.accept(e);
}
if (modCount != mc)
throw new ConcurrentModificationException();
}
}
}

理解了 HashIterator 后再看 entrySet()EntrySet 类就比较容易理解了,注意到 HashMap 的实现中使用了一个 entrySet 成员来缓存结果。 keySet()values() 的实现也是类似的,只是 values() 返回的是 Collection ,因为值不能保证唯一性,而键是可以的。

小结

本文对 JDK 8 中的 HashMap 类的源代码进行了简要分析,重点在于分析其内部的实现机制及原理。

HashMap 内部是基于一个数组来实现的,数组中的每个元素称为一个桶(bin、bucket)。当数组中被占用的桶的数量超过了装填因子和数组容量设定的阈值后,会对数组进行扩容,容量将扩展为原来的2倍。哈希表中所有的 Entry 会被重新散列到新的位置中。

因为两个不同的Key在进行散列时可能会发生碰撞,HashMap为了避免哈希碰撞带来的影响也做了几点优化。在进行散列处理时,将高位与低位进行异或,从而减小碰撞的概率。当不同的Entry被分配到同一个桶中时,每个桶中使用单项链表的方式来保存数据,这个在最坏情况下性能会退化到O(n);在Java 8 的实现中,如果一个桶中的Entry数量超过了阈值(TREEIFY_THRESHOLD = 8),就会将单链表转化为一颗红黑树,当低于阈值(UNTREEIFY_THRESHOLD = 6)时重新转化为单链表。这样,在最差的情况下性能仍然可以保证为 O(log n)。在构造红黑树时,如果两个key的哈希值不等,则会按照哈希值排序;如果两个 key 的哈希值相等,则 Key 最好实现Comparable接口,并依此进行排序。当然,并不强制要求 Key 实现 Comparable 接口,这样在哈希碰撞严重的时候红黑树可能也不会带来很大的性能提升。关于Java 8 中 HashMap 的性能提升可参见这篇文章

红黑树的实现比较复杂,文中并没有作具体的分析。如果需要遍历所有的Entry,可以将红黑树也当作单向链表处理,因为 HashMap 中红黑树的节点中也维护了一个 next 引用。

在使用HashMap时要特别注意的一点是键的不变性。因为内部存储是基于数组的,数组下标则是通过Key对象的hash值来决定的。如果在 put(key,value) 后修改了 key 对象的成员,在调用 get(key) 时会先再次根据 key 的哈希值来确定数组的下标,这时由于hash值发生了改变,则无法找到对应的 Entry。当然,如果该对象的 hashCode()方法并不是根据成员来计算的,即修改对象成员也不会影响其 hash 值,则并不会受到影响。

HashMap 的实现不是同步的,在多线程场景下需要在外部手动进行同步控制。在迭代器中也使用了 fail-fast 机制。HashTable 的实现和 HashMap 非常相似,不过 HashTable 对每个方法进行了 Synchronize 同步以保证在多线程场景下的数据一致性,这种实现比较低效。在多线程场景下可以使用 Map m = Collections.synchronizedMap(new HashMap(...)); 或并发包中的 ConcurrentHashMap

HashMap 可以支持为 null 的键和值,而 HashTable 则要求键和值都不能为 null。

-EOF-

参考
Java HashMap工作原理