读源码理解jdk8 HashMap

目录

HashMap

1、内部结构

2、HashMap构造器

3、HashMap put操作

4、hashMap 扩容

5、get操作

---

HashMap

HashMap 继承于AbstractMap，实现了Map,Cloneable,Serializable接口。

1、内部结构

JDK7的HashMap内部结构是数组+链表。

JDK8的HashMap内部结构是数组+ 链表+ 红黑树。

• 链表节点结构：

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

 

• 树节点结构：

//LinkedHashMap.Entry<K,V>继承于 HashMap.Node<K,V>
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;
    TreeNode(int hash, K key, V val, Node<K,V> next) {
        super(hash, key, val, next);
    }
    .........
 }

• 一些重要的默认字段：

//如果创建一个HashMap未指定大小，HashMap初始化大小默认为16。
static final float DEFAULT_INITIAL_CAPACITY = 1 << 4;

//HashMap允许的最大容量为2^30。
static final float MAXIMUM_CAPACITY = 1 << 30; 

//负载因子，代表了HashTable的填充度，当HashTable内已经存在的元素个数超过HashTable容量*DEFAULT_LOAD_FACTOR时，
//进行扩容。默认为0.75 例如：HashTable的容量为32(32 * 0.75 = 14.4)，当已经存在14个元素时（不只是主干数组的元素，包括链表和树的节点），
//如果要再添加一个元素，需要先进行扩容操作。扩容后的HashMap容量是之前的2倍
// 这样做的原因是为了减少hash冲突。
static final float DEFAULT_LOAD_FACTOR = 0.75f;  

// 链表转树形的阈值
static final int TREEIFY_THRESHOLD = 8;
// 容器可以树化的最小容量
static final int MIN_TREEIFY_CAPACITY = 64;
// 结合以上两个字段，在HashMap的容量大于等于64的前提下（小于64或者为空时，进行扩容操作），
//当某个链表的节点个数为大于等于8时，需要将链表转为树形
// 这样做为了避免链表过长，红黑树查询某个节点最差为O（logN）相比于链表的最差O（N），效率会更好。

// 树形转为链表的阈值
// 当红黑树的节点个数小于等于6时，需要将红黑树转为链表
static final int UNTREEIFY_THRESHOLD = 6;

 问题：为什么不直接使用红黑树，而是要先使用链表，到一定条件下再转红黑树呢？

Because TreeNodes are about twice the size of regular nodes,

we use them only when bins contain enough nodes to warrant use (see TREEIFY_THRESHOLD).

And when they become too small (due to removal or resizing) they are converted back to plain bins. 

“因为树节点的大小是链表节点大小的两倍，所以只有在容器中包含足够的节点保证使用才用它”，显然尽管转为树使得查找的速度更快，但是在节点数比较少的时候，此时对于红黑树来说内存上的劣势会超过查找等操作的优势，自然使用链表更加好，但是在节点数比较多的时候，综合考虑，红黑树比链表要好。

问题：为什么在节点数为8时进行链表转红黑树操作，而不是节点数为9？或者10？

Ideally, under random hashCodes, the frequency of nodes in bins follows a Poisson distribution

with a parameter of about 0.5 on average for the default resizing threshold of 0.75, although

with a large variance because of resizing granularity. Ignoring variance, the expected

occurrences of list size k are (exp(-0.5) * pow(0.5, k) / factorial(k)).

The first values are:

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

more: less than 1 in ten million

 

 

理想情况下，在随机哈希码下，哈希表中节点的频率遵循泊松分布，而根据统计，忽略方差，列表长度为K的期望出现的次数是以上的结果，可以看到其实在为8的时候概率就已经很小了，再往后调整并没有很大意义。

2、HashMap构造器

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

除了入参指定为Map的构造器外，其他构造器并不会为数组Node<K,V>[] table分配内存空间，只是初始化一些成员变量。

threshold ：HashMap进行扩容的阈值，构造初始化为 HashMap容量大小，总是2的指数。（注意：虽然在构造时，threshold 为 HashMap容量大小，但是在put操作为table分配内存空间时，会把threshold 修改为HashMap容量大小 * loadFactor ，这个后面会讲）

来看一下threshold 计算方法tableSizeFor（）：

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

这个方法巧妙地利用了无符号位移和按位或，得到一个比入参cap大但是最接近cap或者等于cap的2的次幂。比如如果给定cap是10，那么应该返回2^3=16。

举个例子：

cap = 259;
cap - 1 = 258;
258用二进制表示为0000 0001 0000 0010
n |= n >>> 1  // n等于n与n向无符号右位移1位的值做按位或（按位或：即二进制位有一个1，结果位就为1）
n >>> 1 = 0000 0000 1000 0001
  0000 0001 0000 0010
  0000 0000 1000 0001
 ------------------------
= 0000 0001 1000 0011
所以 n |= n >>> 1, n= 0000 0001 1000 0011;
n >>> 2 = 0000 0000 0110 0000
   0000 0001 1000 0011
   0000 0000 0110 0000
  ------------------------
 = 0000 0001 1110 0011
 所以 n |= n >>> 2, n= 0000 0001 1110 0011;
 n >>> 4 = 0000 0000 0001 1110
   0000 0001 1110 0011
   0000 0000 0001 1110
  ------------------------
 = 0000 0001 1111 1111
 所以 n |= n >>> 4, n= 0000 0001 1111 1111;
 ..............
 n |= n >>> 16, n= 0000 0001 1111 1111;
 此时 n + 1  = 0000 0010 0000 0000 = 512；
 
 对比下每一次计算前后n的值，可以发现每一次计算都是把二进制位为1的右边的x位置为1，
 直到最后，最初始时n的最高位1后面的所有二进制位都被置为1，再加1后就得到比n大且最接近n的2的次幂方。
 0000 0001 0000 0010
 0000 0001 1000 0011
 
 0000 0001 1000 0011
 0000 0001 1110 0011

3、HashMap put操作

put操作会构建table数组，为其分配内存空间。

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;
    // 判断table是否为空，如果是，通过扩容resize（）来创建
    if ((tab = table) == null || (n = tab.length) == 0)
        n = (tab = resize()).length;
    // table不为空，key的hash值与 （length -1）做按位与运算后得到index，
    // 判断 table[index]是否存在节点，如果没有，直接添加一个新的node到table[index]
    if ((p = tab[i = (n - 1) & hash]) == null)
        tab[i] = newNode(hash, key, value, null);
    else {
        //判断 table[index]不为null
        Node<K,V> e; K k;
        // 判断下table[index]上的node的key的hash与所要添加的节点的key的hash是否相等，
        // key是否与所要添加的节点的key相等，如果是，直接将要添加的节点覆盖原来的节点
        // 为什么要判断hash是否相等？因为17 & 15 和 33 & 15 相等，也就是
        // 不同的key的hash可能得到相同的index，而key的hash值与key的hashCode值相关，
        // 正常情况下，两个key equals返回true,他们的HashCode也应该相同。
        // 如果hashMap的key重写了equals但没有重写HashCode，此时equals返回true，两个HashCode却不同
        // 这种情况下就不是覆盖原来的节点，而是不断添加本应该是相同节点的节点到链表中，
        // 利用get取节点或者根据containsKey判断节点是否存在都不会得到预期的结果。
        if (p.hash == hash &&
            ((k = p.key) == key || (key != null && key.equals(k))))
            e = p;
        else if (p instanceof TreeNode)
        //如果与table[index]的当前节点不一样，判断一下是否是树形节点，是的话就
        // 通过树的特性去添加节点
            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);
                    // 检测是否该从链表变成树（注意：这里是先插入节点，没有增加binCount,所以判断条件是大于等于阈值-1）
                    // 阈值默认为8
                    //treeifyBin（）方法还会判断，在table容量小于MIN_TREEIFY_CAPACITY  = 64时，
                    //不会树形化，会进行扩容
                    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;
            }
        }
        // e != null,说明新添加的节点已经存在table中，
        //这次操作没有新增节点，只是覆盖了原来的节点
        // 如果原来节点的value不为空，返回原来节点的value，否则返回新的节点的value
        if (e != null) { // existing mapping for key
            V oldValue = e.value;
            if (!onlyIfAbsent || oldValue == null)
                e.value = value;
            afterNodeAccess(e);
            return oldValue;
        }
    }
    ++modCount;
    // e == null,新增了一个节点，size增加1，
    // 判断size增加1后是否大于hashTable的容量,是的话进行扩容。
    if (++size > threshold)
        resize();
    afterNodeInsertion(evict);
    return null;
}

• put操作总结

1. 如果tabel为空，通过扩容来创建table。
2. 根据key的hashCode计算hash，与（length -1）做按位与运算得到index；

    2.1、如果table[index] == null，那么直接添加新的节点；

    2.2、如果table[index] ！= null，并且新的节点与旧的节点相同（判断hash和key是否相等），覆盖旧的节点；

    2.3、如果table[index] ！= null，并且新的节点与旧的节点不相同；

            2.3.1、判断是不是树节点，是的话就就根据树的特性去添加节点；

            2.3.2、是链表节点，遍历链表，如果找得到与新节点相等的旧节点，覆盖旧节点，否 则就在链表尾部添加新的节点，添加新节点后还需要判断是否需要把链表转为树形。

3. 如果是新节点覆盖旧节点，table中的节点个数未变，返回节点的value；
4. 如果是新增节点，判断新增后节点后table中的节点个数是否超过了扩容的阈值，如果超过，需要进行扩容，扩容后的table容量是之前的2倍。

问题：HashMap的key需要注意什么？

自定义类作为key，必须重写equals()和hashCode()方法。

4、hashMap 扩容

final Node<K,V>[] resize() {
    Node<K,V>[] oldTab = table;
    int oldCap = (oldTab == null) ? 0 : oldTab.length;
    int oldThr = threshold;
    int newCap, newThr = 0;
    // table不为空
    if (oldCap > 0) {
        // 如果原table容量已经达到最大容量限制，把threshold设置为整数的最大值2^31 - 1（之后就不会再触发调用resize()）
        // 不做扩容操作，直接返回原table
        if (oldCap >= MAXIMUM_CAPACITY) {
            threshold = Integer.MAX_VALUE;
            return oldTab;
        }
        // 判断如果扩容后，新的容量大小是否超过最大容量限制，
        // 不超过的话，直接扩容为原来的2倍
        else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
                 oldCap >= DEFAULT_INITIAL_CAPACITY)
            newThr = oldThr << 1; // double threshold
    }
    // 如果table为空，并且构造table时有初始化table容量，那么就用这个初始化的值
    else if (oldThr > 0) // initial capacity was placed in threshold
        newCap = oldThr;
    else {               // zero initial threshold signifies using defaults
        // 否则，table容量为默认的16，threshold（table进行扩容的阈值）为默认的（16 * 0.75）
        newCap = DEFAULT_INITIAL_CAPACITY;
        newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
    }
    if (newThr == 0) {
        // // 如果新的阈值是 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;
    // 如果原来的table不为空，那就要把原来table的节点转移到新的table中
    if (oldTab != null) {
        // 遍历每个节点
        for (int j = 0; j < oldCap; ++j) {
            Node<K,V> e;
            // 节点不为空,将值赋给e
            if ((e = oldTab[j]) != null) {
                //置空原来元素，方便GC回收
                oldTab[j] = null;
                // 是个单节点
                if (e.next == null)
                // 直接定位到新的table的index位置
                    newTab[e.hash & (newCap - 1)] = e;
                // 是树形节点    
                else if (e instanceof TreeNode)
                // 根据树的特性去拆分
                    ((TreeNode<K,V>)e).split(this, newTab, j, oldCap);
                 // 是链表节点，且节点个数>1   
                else { // preserve order
                    // 高效之处
                    // 利用哈希值的高低位去区分存储位置，如果高位是0，则存储在原来的位置；如果是1则存储在原来位置+oldCap。
                    // 低位链表的头结点、尾节点
                    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;
                    }
                    // 高位链表放在（原来的索引+oldCap）处
                    if (hiTail != null) {
                        hiTail.next = null;
                        newTab[j + oldCap] = hiHead;
                    }
                }
            }
        }
    }
    return newTab;
}

问题：HashMap的实现中要求容量n的长度为2的n次幂

因为在hashMap上进行存取操作都要根据key的hash定位到hashMap的某个位置上，而求余效率不如位移运算，如果n的长度为2的n次幂，那么就可以利用按位与操作来计算出位置index的值。

• 总结：

1. 如果原table为空，那就为其分配内存，如果构造时有传入table的容量，就使用该值，否则使用默认的16，更新扩容阈值为容量 * 负载因子（默认为0.75）；
2. table不为空

        2.1、如果table的容量已经超过或者等于最大容量设置，不再扩容，直接返回旧的table；

        2.2、table的容量的2倍小于最大容量设置，那就把容量扩成原来的2倍

        2.3、把原来table中的节点转移到新的table中

                2.3.1、如果当前位置只有一个节点，那么根据key的hash & （新容量 -1）得到新的index，把元素添加到新的table的index位置上

               2.3.2、如果是个树形节点，根据树的特性进行拆分节点

               2.3.3、如果是个链表节点，则根据key的hash值与原容量进行高位判断，如果为0，就在新的table上将元素添加到原索引位置上，否则添加到（原索引 + 原容量大小）的位置上。

举例：

旧table容量为64，在33位置上一个有着两个节点的链表，两节点对应的hash分别为33和97,扩容后容量为128，33 & 127 = 33, 定位到原来的位置，97 & 127 = 97 = 33 + 64，定位到（原索引 + 原容量）的位置上。

(e.hash & oldCap) == 0操作，因为oldCap二进制有且只有一个位置上为1，设为x，如果e.hash对应x位置上为1，定位到（原索引 + 原容量）的位置上，否则定位到原索引位置上。

5、get操作

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;
    // table不为空，根据key的hash计算定位到table的index位置（index = (n - 1) & hash）
    if ((tab = table) != null && (n = tab.length) > 0 &&
        (first = tab[(n - 1) & hash]) != null) {
        // 如果index位置上的节点的key的hash等于所要找的key的hash以及
        //index位置上的节点的key等于所要找的key，直接返回这个节点
        if (first.hash == hash && // always check first node
            ((k = first.key) == key || (key != null && key.equals(k))))
            return first;
       // 如果index上的节点不是所要找的，且它的nextNode不为null     
        if ((e = first.next) != null) {
            // 判断index上的节点是不是树节点，是的话根据树的特性获取节点
            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);
        }
    }
    // table为空，或者在链表中找不到所要找的节点，返回null
    return null;
}

• key的hash计算

static final int hash(Object key) {
    int h;
    // 这里做了一个处理，如果key为null的话，hash = 0，也就是强制第 0 个桶存放键为 null 的键值对
    return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
}
// h >>> 16 将key的hashCode的二进制向右移动16位
// ^ 异或操作，二进制位对应都为1或者都为0时，结果位为0，只有当二进制位对于位不相同时结果位才为1

问题：(h = key.hashCode()) ^ (h >>> 16)操作的意义或者说作用？

因为在将key定位到hashMap的index位置上时，如果直接采用key.hashCode() & （n -1）的话，当不同的key.hashCode()的低位相等，但是高位不同时，他们会计算出相同的index，这样就会引起hash冲突，如果hash冲突太多，hashMap的效率就会低下。

n = 64, n - 1 = 63 =0011 1111;
key1.hashCode()= 33=0010 0001;
key2.hashCode()= 97=0110 0001;
key2.hashCode()=161=1010 0001;

// 这三个key根据key.hashCode() & （n -1）计算出的index都是33，
//也就是高位的变化对index的计算没有影响。

// h >>> 16
// 为了方便，假设hashCode是8位的，那么就向右位移4位
(h = key.hashCode()) ^ (h >>> 4)= 0010 0001 ^ 0000 0010 = 0010 0011;
(h = key.hashCode()) ^ (h >>> 4)= 0110 0001 ^ 0000 0110 = 0110 0111;
(h = key.hashCode()) ^ (h >>> 4)= 1010 0001 ^ 0000 1010 = 1010 1011;

// 此时再与（n -1）进行按位与
key1: 0010 0011 & 0011 1111 = 0010 0011 = 35;
key2: 0110 0111 & 0011 1111 = 0010 0111 = 39;
key1: 1010 1011 & 0011 1111 = 0010 1011 = 43;

通过(h = key.hashCode()) ^ (h >>> 16)让高位的变化影响到低位，这样可以减少hash冲突，提高效率。

比较jdk7 和jdk 8 的hashMap的区别：

1、jdk8 hash的计算比jdk7的hash计算更简化

2、底层数据结构发生变化：

• JDK7：数组+链表。在极端的情况下会形成一条单链表，那么它的查找时间复杂度会达到O(n)。
• JDK8: 数组+链表+红黑树。 当容量超过最小树化容量64时，如果存在链表节点大于等于8时就会树化，形成红黑树（类似平衡查找二叉树）。所以最坏的情况下的查找时间复杂度为O(logN). 比JDK7效率要好。

3、扩容的具体操作不一样，JDK8要优于JDK7。 JDK7需要重新进行索引下标 的计算，而 JDK8 不需要，通过判断高位（与原容量比较）是 0 还是 1，要么依旧是原 index，要么是 oldCap + 原 index。