HashMap源码解析

HashMap 是 数组+链表+红黑树的结构，先付一张结构图有助于更好的理解源码：

如果对红黑树不了解，可以参考我另一片红黑树的简介：红黑树原理

HashMap实现了 Map、Cloneable、Serializable，说明其是一个Map 并能够克隆和序列化，源码如下：

public class HashMap<K,V> extends AbstractMap<K,V> implements Map<K,V>, Cloneable, Serializable {
    // 初始化容量大小
    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;
    // 树化阀值【长度达到8时，转为树结构】
    static final int TREEIFY_THRESHOLD = 8;
    // 反数化阀值【长度降低为6时，转为链式结构】
    static final int UNTREEIFY_THRESHOLD = 6;
    // 最小树化容量
    // 为了避免进行扩容、树形化选择的冲突，这个值不能小于 4 * TREEIFY_THRESHOLD
    static final int MIN_TREEIFY_CAPACITY = 64;

    transient Node<K,V>[] table;

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

    transient int size;

    transient int modCount;

    int threshold;

    final float loadFactor;
}

一、初始化

1、初始化集合容量及扩容的加载因子的构造函数【默认为16 和 0.75f 可根据自己的要求定制】

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

2、初始化集合容量构造函数

public HashMap(int initialCapacity) {
    this(initialCapacity, DEFAULT_LOAD_FACTOR);
}

可以看到，虽然是另一个构造函数，但最终还是调用第一个构造函数，只是加载因子为默认的0.75f 。

3、无参构造函数

public HashMap() {
    // all other fields defaulted
    this.loadFactor = DEFAULT_LOAD_FACTOR;
}

4、集合构造函数

 public HashMap(Map<? extends K, ? extends V> m) {
    this.loadFactor = DEFAULT_LOAD_FACTOR;
    putMapEntries(m, false);
}

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的底层结构。

二、put(k,v) 函数

先看下map 调用 put() 时，做了哪些事【以下基于无参构造】：

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

    //onlyIfAbsent 为true 则不改变现有值；evict为false 则表处于创建模式
    final V putVal(int hash, K key, V value, boolean onlyIfAbsent, boolean evict) {
        Node<K,V>[] tab; Node<K,V> p; int n, i;
        // 无参构造时并没有指定容量大小，所以在第一次put时会出发resize()
        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;
            // 此处判断 如果hash值相等，并且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 {
                for (int binCount = 0; ; ++binCount) {
                    // 如果 该节点的下一个节点为空 则继续进行
                    if ((e = p.next) == null) {
                        p.next = newNode(hash, key, value, null);
                        // 如果 binCount 达到树化阀值，则进行树化变形
                        if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
                            // 树化操作
                            treeifyBin(tab, hash);
                        break;
                    }
                    // 如果 hash 值碰撞且key值相同则跳出循环
                    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 时，会触发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) 
            newCap = oldThr;
        else {               
            // 初次设置为 默认大小 16
            newCap = DEFAULT_INITIAL_CAPACITY;
            // 阀值为 16*0.75=12
            newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
        }
        if (newThr == 0) {
            float ft = (float)newCap * loadFactor;
            // 每次扩容需要判断阀值，如果大于等于默认最大值，则设置为MAX_VALUES
            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 的容量置为16，阀值为12【即集合中的元素达到此值时，会再次触发扩容resize()函数】。

同理，当进行第12次put时，再次触发resize()扩容函数。

 if (++size > threshold)
     resize();

        执行结束之后HashMap 的容量为newCap = oldCap << 1 即 32 翻倍扩容，阀值为newThr = oldThr << 1; 即 24 翻倍扩容。此时HashMap仍为链式结构，我们从HashMap的全局变量可知，树化阀值为8，即长度达到8时才会进行树化操作。继续添加元素，一旦发生hash碰撞?，就会执行putval中else的部分，新添加的节点指向发生hash碰撞的节点的下一个节点【为空】：

if ((e = p.next) == null) {
    p.next = newNode(hash, key, value, null);
    if (binCount >= TREEIFY_THRESHOLD - 1)
        treeifyBin(tab, hash);
    break;
}

由此可以看出，一旦节点数量达到树化阀值，便会触发树化操作 treeifyBin(tab, hash); 具体代码如下：

    final void treeifyBin(Node<K,V>[] tab, int hash) {
        int n, index; Node<K,V> e;
        if (tab == null || (n = tab.length) < MIN_TREEIFY_CAPACITY)
            resize();
        else if ((e = tab[index = (n - 1) & hash]) != null) {
            TreeNode<K,V> hd = null, tl = null;
            do {
                TreeNode<K,V> p = replacementTreeNode(e, null);
                if (tl == null)
                    hd = p;
                else {
                    p.prev = tl;
                    tl.next = p;
                }
                tl = p;
            } while ((e = e.next) != null);
            if ((tab[index] = hd) != null)
                hd.treeify(tab);
        }
    }

        可以看出，虽然触发树化操作，但还有进一步的判断，如果集合的元素长度小于默认的最小树化容量，则继续执行resize() . 否则进行树化操作【也就是当达到树化阀值，才会进行树化操作】。

       有人可能会想，为什么设置8为树化阀值 不是4 也不是16 或者其他值呢，对此在网上搜集大量的资料，基本就是根据平均查找长度来的。如链式结构，平均查找长度为（1+2+3+...+n）/n 可以得到长度为8时的链式结构的平均查找长度为4。而树的平均查找长度为log(8)=3，由此可知 当链表长度达到8时，树的查找效率更高，就别说大于8的值了。而如果长度为4 的话 链式结构和树结构的平均查找长度都为2，表面看起来效率是差不多的，但是我们还要考虑树化操作也是需要时间的。所以选择8为树化的阀值。 

三、remove(k)函数

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

可以看出，移除元素同样是根据key的hash值及key的条件，进入removeNode函数：

    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 转为链式结构，底层是如何实现的， 所以前面的源码没有什么好看的 也都非常简单。重点我们看一下 removeTreeNode 这个方法，此方法就是用来移除树节点，并判断是否需要将树形结构转为链式结构，源码如下：

        final void removeTreeNode(HashMap<K,V> map, Node<K,V>[] tab, boolean movable) {
            int n;
            if (tab == null || (n = tab.length) == 0)
                return;
            int index = (n - 1) & hash;
            TreeNode<K,V> first = (TreeNode<K,V>)tab[index], root = first, rl;
            TreeNode<K,V> succ = (TreeNode<K,V>)next, pred = prev;
            if (pred == null)
                tab[index] = first = succ;
            else
                pred.next = succ;
            if (succ != null)
                succ.prev = pred;
            if (first == null)
                return;
            if (root.parent != null)
                root = root.root();
            if (root == null || root.right == null ||
                (rl = root.left) == null || rl.left == null) {
                tab[index] = first.untreeify(map);  // too small
                return;
            }
            TreeNode<K,V> p = this, pl = left, pr = right, replacement;
            if (pl != null && pr != null) {
                TreeNode<K,V> s = pr, sl;
                while ((sl = s.left) != null) // find successor
                    s = sl;
                boolean c = s.red; s.red = p.red; p.red = c; // swap colors
                TreeNode<K,V> sr = s.right;
                TreeNode<K,V> pp = p.parent;
                if (s == pr) { // p was s's direct parent
                    p.parent = s;
                    s.right = p;
                }
                else {
                    TreeNode<K,V> sp = s.parent;
                    if ((p.parent = sp) != null) {
                        if (s == sp.left)
                            sp.left = p;
                        else
                            sp.right = p;
                    }
                    if ((s.right = pr) != null)
                        pr.parent = s;
                }
                p.left = null;
                if ((p.right = sr) != null)
                    sr.parent = p;
                if ((s.left = pl) != null)
                    pl.parent = s;
                if ((s.parent = pp) == null)
                    root = s;
                else if (p == pp.left)
                    pp.left = s;
                else
                    pp.right = s;
                if (sr != null)
                    replacement = sr;
                else
                    replacement = p;
            }
            else if (pl != null)
                replacement = pl;
            else if (pr != null)
                replacement = pr;
            else
                replacement = p;
            if (replacement != p) {
                TreeNode<K,V> pp = replacement.parent = p.parent;
                if (pp == null)
                    root = replacement;
                else if (p == pp.left)
                    pp.left = replacement;
                else
                    pp.right = replacement;
                p.left = p.right = p.parent = null;
            }

            TreeNode<K,V> r = p.red ? root : balanceDeletion(root, replacement);

            if (replacement == p) {  // detach
                TreeNode<K,V> pp = p.parent;
                p.parent = null;
                if (pp != null) {
                    if (p == pp.left)
                        pp.left = null;
                    else if (p == pp.right)
                        pp.right = null;
                }
            }
            if (movable)
                moveRootToFront(tab, r);
        }

我们以一个临界点来说明，因为反树化的阀值为6，也就是当链表长度达到6时，就会执行untreeify 操作。当然也有人问 为什么反树化阀值是6而不是7，那是因为方式频繁的增加删除元素导致 树与链的频繁转化而影响效率。