HashMap源码解析

本文主要通过分析HashMap的各个字段的意义，常用方法的大致逻辑来大致了解HashMap的源码。

一、HashMap的主要字段

1、hashmap中有一个静态内部类Node，其结构并不复杂，下面请看它的代码：

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

这个node类其实就是存放我们key value的节点
它有三个内部字段，hash、key、value、next
其中hash就是这个节点的hash值，key就是节点的key，value就是节点的value值，next就是这个节点指向同一个槽位中下一个节点的地址（hash冲突时候的链表）。

2、table字段就是一个node类型的数组
它代表hashmap中桶的组织形式，每个槽位有一个keyvalue键值对，或者是一个链表或者树结构。

3、entrySet字段是以一个set的形式组织好hashmap中的所有节点。

4、size字段代表key value键值对的数量

5、modCount字段代表hashmap被修改的次数

6、threshold字段代表hashmap扩容的阈值，当hashmap的keyvalue键值对的数量达到这个值时候，会进行扩容。这里一定要注意是键值对的总数量而不是桶被使用的数量。

7、loadFactor字段代表加载因子，就是用于计算阈值的，比如：threshold = capacity * loadFactor，默认是0.75，可以在hashmap初始化的时候指定。

二、HashMap的结构图

三HashMap的主要方法分析

1、构造方法

HashMap有三个构造方法，一个是无参的，另外两个是有参的，无参和只传一个参数的构造函数最终都是调用有参构造，只不过两个参数使用的是默认值罢了，所以我们着重分析有两个参数的那个构造，其中两个参数的默认值分别是16和0.75，代表默认桶的容量是16，加载因子是0.75.
先上有两个参数的构造函数的代码：

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

请注意最后一行代码的tableSizeFor方法：

static final int tableSizeFor(int cap) {
        int n = -1 >>> Integer.numberOfLeadingZeros(cap - 1);
        return (n < 0) ? 1 : (n >= MAXIMUM_CAPACITY) ? MAXIMUM_CAPACITY : n + 1;
    }
    

这段代码的意思就是：
（1）、先计算cap参数减一后的二进制值的高位连续0的位数。
（2）、让-1的二进制值往右移第一步计算得到的位数值，然后高位补零
（3）、如果这个值大于零就返回小于等于MAXIMUM_CAPACITY值的n+1值，否则返回1。

大家知道-1的二进制字符串是“11111111111111111111111111111111”
这个二进制数右移后高位补零后的值肯定大于等于任何一个有相同位数的数的值。也就是说这个值是大于等于cap值的。
所以我们在初始化HashMap时候，最好把cap的值入参为2的N次方。这样cap的值和threshold的值就相等了。

2、put方法

put方法是HashMap最常用也是最重要的方法。先看代码：

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

首先对key进行了hash，然后调用了putVal方法，真正的核心逻辑在putVal方法里面，下面就是它的代码：

final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
                   boolean evict) {
        Node<K,V>[] tab; Node<K,V> p; int n, i;
        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;
            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);
                        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;
                }
            }
            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;
    }

代码块儿很长，但是我们理清楚还是容易理解的。
首先看第一个if分支，代表hashMap是空的时候执行的逻辑。
其实HashMap在我们new的时候只是初始化了一些字段的值，并没有对实际的容器进行初始化，这个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) // 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;
        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;
    }

（一）这个方法第一个if-else if -else分支体的大致逻辑就是：
1、如果旧的容量大于零，说明有老数据，那么扩容后的新的容量就是老的容量的两倍
2、否则，如果老的阈值大于等于零，扩容后的容量就等于老的阈值
3、如果老的阈值和老的容量都小于等于零，就用默认值。

（二）然后就是设置阈值，如果阈值之前没有设置，那么阈值就等于容量与加载因子的乘积，否则新的阈值就是之前阈值的两倍。
（三）如果老的table不为空，即有旧的数据，那么就把老数据放进新的table，把就table的指针指向新table。
这里要注意的是，如果旧table 里面的某一个槽的数据是二叉树结构，需要拆分成链表重新放进新table里面。

这个时候空HashMap的容器就初始化完了，那么如果putVal方法就真正的开始往容器里面放数据了。
这个时候分成两种情况，第一种情况就是如果通过hash算法的到的hash值对应的槽位没有被其他数据占用，就直接将数据包装成一个Node类型的节点放进这个槽位

如果这个槽位被占用了，就需要把之前的数据取出来，放到之前的数据组成的数据结构中，这个时候又要分两种情况，一种是如果之前是链表，一种是之前是红黑树结构。

如果是树形结构，就直接把当前节点放到树形结构中去

如果是链表，就需要判断放进去新节点后链表的长度是否达到了TREEIFY_THRESHOLD阈值，达到了这个值，就需要把链表拆开重新组装为红黑树结构，否则新节点直接放在链表末尾。

3、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;
        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);
            }
        }
        return null;
    }

如果搞懂了put方法，这个方法就很简单了，就是先算出key的hash值，通过hash值把对应槽位的数据取出来，由于可能存在hash冲突的情况，可能有多个数据有相同hash值。
这个时候就需要通过key的equals方法选择出各个节点中key值相等的节点。

其他很多方法都是get和put方法的包装。

注意putAll方法其实就是循环需要放进去的那个map参数对象，一个一个键值对的放到外层的map中，请看代码：

forEach方法：