源码分析—HashMap（JDK1.8）

发表于 | 分类于 |
| 字数统计: 5,330

前面分析了JDK1.7中HashMap的源码，它是通过是“数组+链表”实现的，但在JDK1.8中对HashMap的实现做了很大的变动和优化，改为了用“数组+链表或红黑树”来实现。

下面先讲一下红黑树相关内容。

红黑树

二叉查找树

介绍红黑树之前我们要先理解二叉查找树的数据结构，下面简单介绍一下。

上面这张图就是一个二叉查找树。二叉查找树有如下几条特性：

  1. 左子树上所有结点的值均小于或等于它的根结点的值。
  2. 右子树上所有结点的值均大于或等于它的根结点的值。
  3. 左、右子树也分别为二叉排序树。

既然名字中有“查找”，那么到底是怎么查找的呢？
比如我们要查找10这个元素，查找过程为：首先找到根节点，然后根据二叉查找树的第一二条特性，我们知道要查找的10>9所以是在根节点的右边去查找，找到13，10<13,所以接着在13的左边找，找到11,10<11,继续在11的左边查找，这样就找到了10。这其实就是二分查找的思想。我们要查出结果所需的最大次数就是二叉树的高度！

总结一下二分查找的思想：找到数组的中间位置的元素v，将数组分成>v和<\v两部分，然后将v和要查找的数据进行一个比较，如果大于v那么就在>v的部分再次进行二分查找，否则就在<\v的部分进行二分查找，直到找到对应的元素。

那既然要查出结果所需的最大次数就是二叉树的高度，那这个高度会不会有时候很长呢？
比如我们依次插入 根节点为9如下五个节点：7,6,5,4,3。依照二叉查找树的特性，结果会变成什么样呢？7,6,5,4,3一个比一个小，那么就会成一条直线，也就是成为了线性的查询，时间复杂度变成了O（n）级别。为了解决这种情况，该红黑树出场了。

红黑树

红黑树其实就是一种自平衡的二叉查找树。它这个自平衡的特性就可以对HashMap中链表可能会很长的问题做出优化。

红黑树是每个节点都带有颜色属性的二叉查找树，颜色或红色或黑色。除了二叉查找数的特性，红黑树还有如下单独的特性:

  1. 每个节点是红色或黑色。
  2. 根节点是黑色。
  3. 每个叶节点（NIL节点，空节点）是黑色的。
  4. 每个红色节点的两个子节点都是黑色。(从每个叶子到根的所有路径上不能有两个连续的红色节点)
  5. 从任一节点到其每个叶子的所有路径都包含相同数目的黑色节点。

如下就是一个典型的红黑树：

红黑树那么多规则，那么在插入和删除元素会不会破坏红黑树的规则呢？什么情况下会破坏？什么情况下不会？

比如我们向原红黑树插入为14的新节点就不会破坏规则：

向原红黑树插入值为21的新节点就破坏了规则：

那么红黑树是怎么维护这个二叉查找树的自平衡性的呢？

红黑树通过“变色”和“旋转”来维护红黑树的规则，变色就是让黑的变成红的，红的变成黑的，旋转又分为“左旋转”和“右旋转”。这个比较复杂，这里就不展开讲，只需要知道红黑树就是通过这种方式来实现它的自平衡性就行了。

源码分析

下面分析一下JDK1.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
29
30
31
32
33
34
35
// 默认容量16
static final int DEFAULT_INITIAL_CAPACITY = 1 << 4; 
 
// 最大容量
static final int MAXIMUM_CAPACITY = 1 << 30;    
 
// 默认负载因子0.75
static final float DEFAULT_LOAD_FACTOR = 0.75f; 
 
//桶(bucket)中链表节点转换红黑树节点的阈值, 结点数大于这个值时会转成红黑树
static final int TREEIFY_THRESHOLD = 8; 
 
//桶(bucket)中红黑树节点转换链表节点的阈值, 结点数小于等于这个值时会转成链表
static final int UNTREEIFY_THRESHOLD = 6;   
 
// 转红黑树时, table的最小长度
static final int MIN_TREEIFY_CAPACITY = 64; 

// 存储元素的数组，总是2的幂次倍
transient Node<k,v>[] table; 

// 存放具体元素的集
transient Set<map.entry<k,v>> entrySet;

// 实际已存储的节点数量
transient int size;

// 每次扩容或更改map结构的计数器
transient int modCount;   

// 阈值，当size超过这个阈值，哈希数组会进行扩容
int threshold;

// 负载因子
final float loadFactor;

数据结构

在JDK1.8中HashMap是“数组+链表或红黑数”的结构，当一个桶中的节点数比较少时，这些节点以一个单向链表存储在桶中，当节点数大于8则转为红黑树。

如果是链表，节点上的元素是一个Node<K,V>实例；如果是红黑树，节点上的元素是一个TreeNode<K,V>实例。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
// 链表节点, 继承自Entry
static class Node<K,V> implements Map.Entry<K,V> {  
    final int hash;
    final K key;
    V value;
    Node<K,V> next;
 
    // ... ...
}
 
// 红黑树节点
static final class TreeNode<K,V> extends LinkedHashMap.Entry<K,V> {
    TreeNode<K,V> parent;  // red-black tree links
    TreeNode<K,V> left;
    TreeNode<K,V> right;
    TreeNode<K,V> prev;    // needed to unlink next upon deletion
    boolean red;
   
    // ...
}

构造器

和JDK1.7中的HashMap类似，有4个构造器。

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
public HashMap() {
    this.loadFactor = DEFAULT_LOAD_FACTOR; 
}
 
 
public HashMap(int initialCapacity) {
    this(initialCapacity, DEFAULT_LOAD_FACTOR);
}
 
 
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(Map<? extends K, ? extends V> m) {
    this.loadFactor = DEFAULT_LOAD_FACTOR;
    putMapEntries(m, false);
}
 
 
/**
 * evict：false表示是初始化创建HashMap对象，否则为true
 */
final void putMapEntries(Map<? extends K, ? extends V> m, boolean evict) {
    //获取该map的实际长度
    int s = m.size();
    if (s > 0) {
        //判断table是否已经初始化
        if (table == null) { 
            /** 求出需要的容量，因为实际使用的长度=容量*0.75得来的，+1是因为小数相除，基本都不会是整数，容量大小不能为小数的，后面转换为int，多余的小数就要被丢掉，所以+1，例如，map实际长度22，22/0.75=29.3,所需要的容量肯定为30，有人会问如果刚刚好除得整数呢，除得整数的话，容量大小多1也没什么影响 **/
            float ft = ((float)s / loadFactor) + 1.0F;
            //判断该容量大小是否超出上限。
            int t = ((ft < (float)MAXIMUM_CAPACITY) ?
                     (int)ft : MAXIMUM_CAPACITY);
            /** 对临界值进行初始化，tableSizeFor(t)这个方法会返回大于t值的，且离其最近的2次幂，例如t为29，则返回的值是32 **/
            if (t > threshold)
                threshold = tableSizeFor(t);
        } else if (s > threshold)   //如果table已经初始化，并且传入的map中节点数量>临界值，则进行扩容操作
            resize();
        //遍历，把map中的数据转到hashMap中。
        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的构造器，其它情况下在创建HashMap实例时，都不会创建去创建一个哈希数组，即执行构造器后table仍然为null，直到第一次执行put方法时table才会通过resize()方法创建一个数组。

put方法

put流程的主要步骤：
①.判断键值对数组table[i]是否为空，为空则执行resize()进行扩容；
②.根据key计算hash值得到插入的数组索引i，如果table[i]==null，直接新建Node添加到i位置，转向⑥，如果table[i]不为空，转向③；
③.判断table[i]的首个元素是否和要添加的key一样，如果相同直接覆盖value，否则转向④，这里的相同是指key的hashCode和equals相同；
④.判断table[i] 是否为treeNode，即table[i] 是否是红黑树，如果是红黑树，则直接在树中插入键值对，否则转向⑤；
⑤.遍历table[i]，判断链表长度是否大于8，大于8的话把链表转换为红黑树，在红黑树中执行插入操作，否则进行链表的插入操作；遍历过程中若发现key已经存在直接覆盖value即可；
⑥.插入成功后，判断实际存在的键值对数量size是否超多了最大容量threshold，如果超过，进行扩容。

流程图如下：

具体详细源码分析如下：

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

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

/**
 *
 * @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
 */
final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
               boolean evict) {
    //tab 哈希数组，p 该哈希桶的首节点，n hashMap的长度，i 计算出的数组下标
    Node<K,V>[] tab; Node<K,V> p; int n, i;
    //如果table还没有初始化，调用resize()方法，生成了一个数组对象
    if ((tab = table) == null || (n = tab.length) == 0)
        n = (tab = resize()).length;
    //根据key的hash值和哈希数组的长度，计算出要插入到桶的位置，如果该位置为空，则新建一个节点存放在这个位置。
    if ((p = tab[i = (n - 1) & hash]) == null)
        tab[i] = newNode(hash, key, value, null);
    else {
        // e 临时节点， k 当前位置节点的key, p 在前一步已经赋值为当前位置的一个不为空的Node对象
        Node<K,V> e; K k;
        //第一种，这个桶上首节点的key，和要添加的key相同，则把当前的Node对象赋值给临时节点e
        if (p.hash == hash &&
            ((k = p.key) == key || (key != null && key.equals(k))))
            e = p;
        //第二种，两个key不相同，判断该p是否属于红黑树的节点
        else if (p instanceof TreeNode)
            /**为红黑树的节点，则在红黑树中进行添加，如果该节点已经存在，则putTreeVal返回该节点（不为null），该值很重要，用来判断put操作是否成功，如果添加成功返回null**/
            e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
        else {
            //第三种，两个key不相同，并且这个桶上首节点也不是红黑树，则为链表的节点
            for (int binCount = 0; ; ++binCount) {  //遍历该链表
                //如果一直找到尾部，都没有节点的key和要添加的key相同，则把这个key-value包装成节点添加到链表的尾部
                if ((e = p.next) == null) {
                    p.next = newNode(hash, key, value, null);
                    //如果链表上的节点数量>=8个，则调用treeifyBin方法
                    if (binCount >= TREEIFY_THRESHOLD - 1) 
                        //treeifyBin首先判断当前hashMap的长度，如果不足64，只进行resize扩容；如果达到64，将链表转换为红黑树
                        treeifyBin(tab, hash);
                    break;
                }
                //如果链表中有某个节点key和要添加的key相同，则结束循环。此时e则为当前重复的节点
                if (e.hash == hash &&
                    ((k = e.key) == key || (key != null && key.equals(k))))
                    break;
                p = e;
            }
        }
        //e不为空表示链表或红黑树中存在一个节点key和要添加的key相同，则用待插入值覆盖旧值，并返回旧值。
        if (e != null) { // existing mapping for key
            V oldValue = e.value;
            if (!onlyIfAbsent || oldValue == null)
                e.value = value;
            afterNodeAccess(e);
            return oldValue;
        }
    }
    //到了这一步，说明不是覆盖旧值的情况，而是往hash表中添加了新的节点，需要进行如下几个后续操作。
    ++modCount;
    //添加了新的节点后，实际节点数量大于临界值则需要resize()
    if (++size > threshold)
        resize();
    afterNodeInsertion(evict);
    //成功添加新的节点是返回null
    return null;
}

resize方法

在put方法中会调用resize()方法，resize()也属于HashMap中一个重要方法。

  1. resize()方法会在两种情况下被调用：1）初始化，即第一次往HashMap中插入数据；2）Hashmap中键值对的数量大于阈值时进行扩容。
  2. 每次扩容的时候都是扩容2被（旧容量往左移1位）。
  3. 扩展后Node对象的位置要么在原位置，要么移动到原偏移+原数组长度的位置。即一个Node本来在tab[i]处，扩容后要么还是在tab[i]处，要么移动到了tab[i+oldTab.length]处。
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
/**
 * 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 旧的哈希数组，oldCap 旧的数组的长度，oldThr 旧的阈值，newCap 新的数组长度，newThr 新的阈值
    Node<K,V>[] oldTab = table;
    int oldCap = (oldTab == null) ? 0 : oldTab.length;
    int oldThr = threshold;
    int newCap, newThr = 0;
    //oldCap > 0 说明不是在初始化数组
    if (oldCap > 0) {
        //数组已经到最大长度，将阈值改为最大值，且不再扩容
        if (oldCap >= MAXIMUM_CAPACITY) {
            threshold = Integer.MAX_VALUE;
            return oldTab;
        }
        //扩容两倍后的长度<最大值，并且old长度也>=16，new长度=old长度2倍
        else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
                 oldCap >= DEFAULT_INITIAL_CAPACITY)
            newThr = oldThr << 1; //阈值也扩容两倍
    } else if (oldThr > 0) // old阈值有过初始化的情况
        newCap = oldThr;
    else {               // old长度、old阈值都为0的情况，即默认初始化
        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属性
    table = newTab;
    if (oldTab != null) {
        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)     //oldTab[j]处只有一个节点的情况
                    newTab[e.hash & (newCap - 1)] = e;
                else if (e instanceof TreeNode)     //红黑树的情形
                    ((TreeNode<K,V>)e).split(this, newTab, j, oldCap);
                else { //链表情形
                    Node<K,V> loHead = null, loTail = null;     //要放在旧索引位置的节点，这些节点在新数组的索引仍为j
                    Node<K,V> hiHead = null, hiTail = null;     //要放在新索引位置的节点，这些节点在新数组的索引将会变成：j + oldCap
                    Node<K,V> next;
                    do {
                        next = e.next;
                        if ((e.hash & oldCap) == 0) {
                            if (loTail == null)     // 如果loTail为空, 代表该节点为第一个节点
                                loHead = e;     // 则将loHead赋值为第一个节点
                            else
                                loTail.next = e;        // 否则将节点添加在loTail后面
                            loTail = e;          // 并将loTail赋值为新增的节点
                        }
                        else {
                            if (hiTail == null)
                                hiHead = e;
                            else
                                hiTail.next = e;
                            hiTail = e;
                        }
                    } while ((e = next) != null);
                    //如果loTail不为空（说明扩容有节点的数组索引j没变），则将最后一个节点的next设为空，并在新数组索引=j处设置对应的头节点为loHead。
                    if (loTail != null) {
                        loTail.next = null;
                        newTab[j] = loHead;
                    }
                    
                    //如果hiTail不为空（说明扩容有节点的数组索引j发生变化），则将最后一个节点的next设为空，并在新数组索引=j + oldCap处设置对应的头节点为hiHead。
                    if (hiTail != null) {
                        hiTail.next = null;
                        newTab[j + oldCap] = hiHead;
                    }
                }
            }
        }
    }
    return newTab;
}

过程参考如下图：

get方法

get方法比较简单，大概流程就是：

  1. 根据key的hash值，得到应该查找的的数组索引i，判断tab[i]处的值是否是null，如果为null直接返回value为null。
  2. 如果不为null，判断数组上的这个节点的key和要查找的key是否相同（通过hash、queals、==等判断条件），如果相同，返回该节点的value。
  3. 如果步骤2中的key相等判断为false，则再检查当前节点是红黑树还是链表，分别用对应的方法遍历，最终看是否找到红黑树或链表里的节点key和查找的key是否相等，找到了就返回对应节点的value，没有找到则最后返回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

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) {
    //first 桶中的头结点，e 临时变量，n 数组的长度, k 某个节点的key
    Node<K,V>[] tab; Node<K,V> first, e; int n; K k;
    //根据hash值和数组长度，得到key对应的桶的位置，再获取桶上的头节点，检查该头节点是否为空
    if ((tab = table) != null && (n = tab.length) > 0 &&
        (first = tab[(n - 1) & hash]) != null) {
        //头节点不为空，则判断这个头结点的key是否和查找的key相同，相同则返回这个头结点
        if (first.hash == hash && // always check first node
            ((k = first.key) == key || (key != null && key.equals(k))))
            return first;
        //不相同则找首节点的后一个节点，如果后一个节点是null，则最后返回null
        if ((e = first.next) != null) {
            //后一个节点不为null，则要看桶上的数据结构是链表还是红黑树，分别按结构查找，没有找到也是最后返回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;
}

remove方法

remove(Object key)方法其实就是根据key找到对应的节点并移除，不会改变哈希数组的长度。具体源码如下：

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
public V remove(Object key) {
    Node<K,V> e;
    //实质是调用removeNode(hash(key), key, null, false, true)进行删除
    return (e = removeNode(hash(key), key, null, false, true)) == null ? null : e.value;
}

/**
  * value表示key对应的value，它和matchValue参数配合使用。如果matchValue为ture则不仅要找到key对应的节点，而且节点的value要和这个value参数相等才进行移除操作；如果matchValue为false则value参数将被忽略。
  * movable表示是否要移除时是否要移动其它节点（只针对红黑树而言）。
  */
final Node<K,V> removeNode(int hash, Object key, Object value,
                           boolean matchValue, boolean movable) {
    //tab 哈希数组，p key对应的数组下标处的节点，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) {   //根据key的hash找到对应下标处的节点，这个节点不为空则继续进行remove操作
        //node 存储要删除的节点，e 临时变量，k 当前节点的key，v 当前节点的value
        Node<K,V> node = null, e; K k; V v;
        //如果数组下标的节点正好是要删除的节点，把值赋给临时变量node
        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不再是数组下标的节点，而是要删除结点的上一个结点**/
                    p = e;
                } while ((e = e.next) != null);
            }
        }
        //找到要删除的节点后，然后进行matchValue的判断
        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;
            //键值对数量减1
            --size;
            /**此方法在hashMap中是为了让子类去实现，主要是对删除结点后的链表关系进行处理**/
            afterNodeRemoval(node);
            //返回删除的节点
            return node;
        }
    }
    //返回null则表示没有该节点，删除失败
    return null;
}
------ 本文完 ------