手撕源码系列：深入理解HashMap源码_手撕源码什么意思

手撕源码系列：深入理解HashMap源码

0.简介

​ 首先来看下HashMap的继承体系结构。

​ 接着，通过一个例子，感受下HashMap。

HashMap<String, Integer> map = new HashMap<String, Integer>();
map.put("语文", 1);
map.put("数学", 2);
map.put("英语", 3);
map.put("历史", 4);
map.put("政治", 5);
map.put("地理", 6);
map.put("生物", 7);
map.put("化学", 8);
for(Entry<String, Integer> entry : map.entrySet()) {
    System.out.println(entry.getKey() + ": " + entry.getValue());
}
1
2
3
4
5
6
7
8
9
10
11
12

​ 上面这段代码用HashMap如何存储呢？

1.HashMap核心属性分析

//默认table的大小
static final int DEFAULT_INITIAL_CAPACITY = 1 << 4; // aka 16
//table的最大长度
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;
//树化的另一个参数，整个哈希表的元素超过64后才能树化
static final int MIN_TREEIFY_CAPACITY = 64;

1
2
3
4
5
6
7
8
9
10
11
12
13

//哈希表
transient Node<K,V>[] table;
//当前哈希表中元素个数
transient int size;
//当前哈希表结构修改次数
transient int modCount;
//扩容阈值，当哈希表中的元素超过阈值，触发扩容
int threshold;
//负载因子，可以计算threshold，threshold=capacity*loadFactor
final float loadFactor;
1
2
3
4
5
6
7
8
9
10

2.构造方法分析

​ 一共由4个构造方法。

    public HashMap(int initialCapacity, float loadFactor) {
        if (initialCapacity < 0)
            //参数不合法
            throw new IllegalArgumentException("Illegal initial capacity: " +
                                               initialCapacity);
        //创建出来的数组最大只能是MAXIMUM_CAPACITY
        if (initialCapacity > MAXIMUM_CAPACITY)
            initialCapacity = MAXIMUM_CAPACITY;
        if (loadFactor <= 0 || Float.isNaN(loadFactor))
            //参数不合法
            throw new IllegalArgumentException("Illegal load factor: " +
                                               loadFactor);
        //赋值操作
        this.loadFactor = loadFactor;
        //计算threshold
        this.threshold = tableSizeFor(initialCapacity);
    }
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

​ 请注意这样最后一行代码：this.threshold = tableSizeFor(initialCapacity);，为什么要计算下，直接赋值不可以吗？要求threshold必须是2的次方数，如果不是的话，需要进行处理，向上取整为最小的2的次方数。比如我输入了个7，那么向上取为8，输入24取为32。

​ 顺便看下tableSizeFor()方法。

tableSizeFor()方法

​ 该方法返回的是大于等于当前值cap的数字，并且这个数字一定是2的次方数。以cap=10，模拟一下执行过程。

cap = 10

n = 10 -1 =9

n |= n >>> 1 0b1001 | 0b0100 = 0b1101

n |= n >>> 2 0b1101 | 0b0011 = 0b1111

n |= n >>> 4 0b1111 | 0b0000 = 0b1111

n |= n >>> 8 0b1111 | 0b0000 = 0b1111

n |= n >>>16 0b1111 | 0b0000 = 0b1111

0b1111 = 15

因为15>0，所以判断15是否>=MAXIMUM_CAPACITY，显示是小于关系

所以return 15+1=16

方法返回16。

    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;
    }
1
2
3
4
5
6
7
8
9

​ 为什么n=cap-1？如果不进行这一步的话，我们得到的结果会比应该得到的结果大2倍，比如cap=10，。那么返回的值就是32而不是16。

​ 为什么最后一行代码有个n+1，因为我们得到的n的二进制表现形式都是类似于0000 0000 0011 1111、0000 0001 1111 1111等等这样的，+1之后就会变成2的次方数。

​ 那么问题来了，为什么要让cap保持2的次方数？

​ 在JDK8中，key的哈希值是由hash(key)方法算出来的（后面会介绍），table数组的index就是key的哈希值决定的。我们肯定期望数据能均匀分布，防止哈希冲突带来的链化问题，所以希望用%取余的操作实现。

​ 当除数是2的次方时，取余操作等价于与其除数-1的与（&）操作，也就是说下面这两个式子是相等的。

index=e.hash & (newCap - 1)
    
index=e.hash % newCap    
1
2
3

​ 为什么要替换呢？显然是&操作比%取余效率要高得多。

​ 下面再看看其他的构造方法。

	public HashMap(int initialCapacity) {
        //套用第一个介绍的构造方法，完成构造
        this(initialCapacity, DEFAULT_LOAD_FACTOR);
    }
    public HashMap() {
        //设置负载因子，其它的参数都使用默认值
        this.loadFactor = DEFAULT_LOAD_FACTOR; 
    }
    public HashMap(Map<? extends K, ? extends V> m) {
        //设置负载因子
        this.loadFactor = DEFAULT_LOAD_FACTOR;
        //
        putMapEntries(m, false);
    }
1
2
3
4
5
6
7
8
9
10
11
12
13
14

3.HashMap put方法与putVal方法分析

put方法

​ 实际上还是调用putVal方法。但是我们发现当执行putVal()方法的时候，还套了一个hash(key)的方法，下面我们来看下该方法。

public V put(K key, V value) {
        return putVal(hash(key), key, value, false, true);
}
1
2
3

hash(Object key)

​ 该方法的主要作用是让哈希值的高16位也参与运算，增加散列性。

/**
*当key为null的时候hash为0，如果不是null则令key的哈希值和key哈希值的高16位进行异或运算。
异或运算：相同返回0，不同返回1.
*/
static final int hash(Object key) {
    int h;
    return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
}
1
2
3
4
5
6
7
8

​ 让key的hash值的高16位参与运算为什么可以增加散列性？回忆下我们算index的时候，是这样实现的

(n - 1) & hash
1

​ 设计者认为这方法很容易发生碰撞。为什么这么说呢？不妨思考一下，在n - 1为15(0x1111)时，其实散列真正生效的只是低4bit的有效位，当然容易碰撞了。

​ 因此，设计者想了一个顾全大局的方法(综合考虑了速度、作用、质量)，就是把高16bit和低16bit异或了一下。设计者还解释到因为现在大多数的hashCode的分布已经很不错了，就算是发生了碰撞也用O(logn)的tree去做了。仅仅异或一下，既减少了系统的开销，也不会造成的因为高位没有参与下标的计算(table长度比较小时)，从而引起的碰撞。

putVal方法

​ 该方法时put方法的核心。下面来看看源码是怎么写的。

/*
hash：就是key的哈希值
onlyIfAbsent：如果存在一个和key相同的情况，那么就不插入了，一般是false
*/ 
final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
                   boolean evict) {
    	//tab:引用当前hashMap的散列表
    	//p:表示当前散列表的结点
    	//n:表示散列表的长度
    	//i：表示路由寻址的结果
        Node<K,V>[] tab; Node<K,V> p; int n, i;
    	//延迟初始化，第一次调用putVal会初始化hashMap对象中的散列表
        if ((tab = table) == null || (n = tab.length) == 0)
            n = (tab = resize()).length;
    	//最简单的一种情况，寻址找到的桶位刚好是null
    	//直接将当前的key-value的node放进去就可以
        if ((p = tab[i = (n - 1) & hash]) == null)
            tab[i] = newNode(hash, key, value, null);
        else {
            //e：不为null的话，找到了一个与当前要插入的键值对一致的元素
            //k:表示临时的key
            Node<K,V> e; K k;
            //表示桶位中的该元素，与当前插入的元素的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 {
                //链表的情况，而且当前链表的头结点和要插入的key不一致
                for (int binCount = 0; ; ++binCount) {
                    //条件成立的话，说明迭代到最后1个元素，也没找到和key一致的结点，说明需要加到当前链表的末尾
                    if ((e = p.next) == null) {
                        p.next = newNode(hash, key, value, null);
                        //由于是尾插法，所以很方便可以知道目前链表的长度
                        //由于binCount是从0开始所以TREEIFY_THRESHOLD需要-1，二者比较判断是否进行树化操作。
                        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;
                }
            }
            //条件如果成立，说明找到了和key完全一致的的结点，可以进行替换操作
            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;
    }
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

​ 下列三张图片来源于网络，参考的博客地址在文末给出。

4.HashMap resize扩容方法分析

resize()

​ 为了解决哈希冲突导致的链化影响查询效率的问题，所以需要扩容。

下面是该方法的源码分析：

final Node<K,V>[] resize() {
    	//odlTab：引用扩容前的哈希表
        Node<K,V>[] oldTab = table;
    	//oldCap：表示扩容前table数组的长度
        int oldCap = (oldTab == null) ? 0 : oldTab.length;
    	//oldThr：表示扩容前的扩容阈值，也是触发本次扩容的阈值
        int oldThr = threshold;
    	//newCap：扩容之后table数组的对象
    	//newThr：扩容之后，下次再触发扩容的条件
        int newCap, newThr = 0;
    	//条件如果成立，说明hashMap中的散列表已经初始过了，这是一次正常扩容
        if (oldCap > 0) {
            //如果oldCap已经大于等于当前允许的最大值了，那么不扩容
            //设置扩容条件为int的最大值
            if (oldCap >= MAXIMUM_CAPACITY) {
                threshold = Integer.MAX_VALUE;
                return oldTab;
            }
            //新容量是旧容量的2倍，newCap小于数组最大值限制
            //且扩容之前的阈值大于等于16，在这种情况下，则下次扩容的阈值等于当前的阈值*2.
            else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
                     oldCap >= DEFAULT_INITIAL_CAPACITY)
                newThr = oldThr << 1; // double threshold
        }
    	//oldCap==0，说明hashMap中的散列表是null
    	//1.new HashMap(initCap,loadFactor)
    	//2.new HashMap(initCap)
    	//3.new HashMap(map) 并且该map有数据
    	//以上三种情况会设置threshold，所以oldThr会大于0
        else if (oldThr > 0) // initial capacity was placed in threshold
            //threshold是2的次方，所以newCap也是2的次方数
            newCap = oldThr;
    	//oldThr==0  oldCap==0
    	//new HashMap();
        else {               // zero initial threshold signifies using defaults
            newCap = DEFAULT_INITIAL_CAPACITY;
            newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
        }
    	//计算新threshold值
        if (newThr == 0) {
            float ft = (float)newCap * loadFactor;
            newThr = (newCap < MAXIMUM_CAPACITY && ft < (float)MAXIMUM_CAPACITY ?
                      (int)ft : Integer.MAX_VALUE);
        }
    	//到此为止，上面的所有代码都是再计算扩容之后table数组的大小以及下次再触发扩容的条件
    	//下面开始真正的扩容
        threshold = newThr;
        @SuppressWarnings({"rawtypes","unchecked"})
            Node<K,V>[] newTab = (Node<K,V>[])new Node[newCap];
        table = newTab;
        //如果条件成立，那么说明hashMap本次扩容前，table不是null
    	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;
}
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

JDK 7 扩容的问题

单线程resize

​ 单线程情况下，resize无问题。由于JDK7使用的是头插法，所以可以看到图中的结点逆序了。但是在JDK8中已经改成尾插法。

多线程并发下的resize

​ 这里假设有两个线程同时执行了put操作并引发了扩容，执行了transfer方法，并假设线程一进入transfer方法并执行完next = e.next后，因为线程调度所分配时间片用完而“暂停”，此时线程2完成了transfer方法的执行。此时状态如下。

接着线程1被唤醒，继续执行第一轮循环的剩余部分

e.next = newTable[1] = null
newTable[1] = e = key(5)
e = next = key(9)
1
2
3

结果如下图所示

接着执行下一轮循环，结果状态图如下所示

继续下一轮循环，结果状态图如下所示

此时循环链表形成，并且key(11)无法加入到线程1的新数组。在下一次访问该链表时会出现死循环。

5.HashMap get 方法分析

get(Object key)

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

getNode(int hash, Object key)

final Node<K,V> getNode(int hash, Object key) {
    	//tab：引用当前hashMap的散列表
    	//first:桶位中的头节点
    	//e：临时node元素
    	//n:table数组长度
        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) {
            
            //第一种情况：定位出来的桶位元素 即位我们需要get的数据
            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;
    }	
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

​ 在JDK1.7及以前的版本中，HashMap里是没有红黑树的实现的，在JDK1.8中加入了红黑树是为了防止哈希表碰撞攻击，当链表链长度为8时，及时转成红黑树，提高map的效率。

​ 这个性能提升有什么用处？比方说恶意的程序，如果它知道我们用的是哈希算法，它可能会发送大量的请求，导致产生严重的哈希碰撞。然后不停的访问这些key就能显著的影响服务器的性能，这样就形成了一次拒绝服务攻击（DoS）。JDK 8中从O(n)到O(logn)的飞跃，可以有效地防止类似的攻击，同时也让HashMap性能的可预测性稍微增强了一些。

6.HashMap remove方法分析

remove(Object key, Object value)

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

remove(Object key, Object value)

public boolean remove(Object key, Object value) {
    return removeNode(hash(key), key, value, true, true) != null;
}
1
2
3

removeNode

final Node<K,V> removeNode(int hash, Object key, Object value,
                               boolean matchValue, boolean movable) {
    //tab:引用当前hashMap的散列表
    //p:当前node元素
    //n:表示散列表数组长度
    //index:表示寻址地址
        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：查找到的结果结点
            //e:当前Node的下一个结点
            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);
                }
            }
            //判断node不为空的话，说明按照key查找到需要删除的数据了
            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
                    //把node结点干掉，然后让p的后继节点指向node的后继结点
                    p.next = node.next;
                ++modCount;
                --size;
                afterNodeRemoval(node);
                return node;
            }
        }
        return null;
    }
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

​ afterNodeRemoval(node);干什么用的？？

7.HashMap replace方法分析

​ replace方法有2个，一个是三个参数的，一个是两个参数的方法。

@Override
public boolean replace(K key, V oldValue, V newValue) {
    Node<K,V> e; V v;
    if ((e = getNode(hash(key), key)) != null &&
        ((v = e.value) == oldValue || (v != null && v.equals(oldValue)))) {
        e.value = newValue;
        afterNodeAccess(e);
        return true;
    }
    return false;
}

@Override
public V replace(K key, V value) {
    Node<K,V> e;
    if ((e = getNode(hash(key), key)) != null) {
        V oldValue = e.value;
        e.value = value;
        afterNodeAccess(e);
        return oldValue;
    }
    return null;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

8.小结

• HashMap在JDK7和JDK8有什么区别？

• 负载因子过大会怎么办？负载因子过小又会怎么办？
  

参考：

https://www.nowcoder.com/discuss/151172