HashMap源码解读

前言

本文详细分析了JDK8中集合HashMap的几个主要方法的源码，并对其流程进行了简单的概括，相信读者耐心阅读之后肯定会有一定的收获，HashMap在日常的代码开发中HashMap的使用频率可以说是很高的，熟悉其内部的结构和原理对我们的开发工作是很有帮助的，且阅读其源码可以学习其中的编码思想，让自己编写出更优质的代码。

内部结构

JDK8中的HashMap数据结构是：数组+链表+红黑树。
数组中存放的是一个个Node节点，HashMap在put和get操作时都是基于Node节点，是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;
        }

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

四个构造方法

//该方法中最后求得的threshold为2的次方，在resize()初始化时用来作为table的大小
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);
}

//只有参数table大小，采用默认的加载因子
public HashMap(int initialCapacity) {
    this(initialCapacity, DEFAULT_LOAD_FACTOR);
}

//不带构造参数，采用默认的负载因子0.75f
public HashMap() {
    this.loadFactor = DEFAULT_LOAD_FACTOR; // all other fields defaulted
}

//构造参数为一个map
public HashMap(Map<? extends K, ? extends V> m) {
    this.loadFactor = DEFAULT_LOAD_FACTOR;
    putMapEntries(m, false);
}

• 当使用的构造方法传入的参数有初始容量时，会使用tableSizeFor方法对传入的容量大小进行初始化，调用这个方法会返回一个大于等于当前值cap的一个数字，并且这个数字一定是2的次方数。
• HashMap在调用构造函数时，并没有对位桶数组进行初始化，真正对其初始化的是resize方法，只有在HashMap进行第一次put操作时，才会进行初始化。

resize方法

resize()方法除了用来扩容外，还用来初始化table。 如果table的长度大于0代表已经初始化，进行正常的扩容，如果table的长度小于0代表还没有进行初始化，进行初始化。

扩容触发条件：

• HashMap扩容的触发条件根据源码可以看出，在HashMap插入新数据（替换不算），size会自增，当size大于扩容阈值时会进行扩容，所以HashMap扩容是根据key的个数来进行扩容，而不是位桶数组的占用情况。
• 链表长度大于等于8，尝试树化时发现数组长度小于64

  if (tab == null || (n = tab.length) < MIN_TREEIFY_CAPACITY)
            resize();

扩容原因

为了解决哈希冲突导致的链化影响查询效率的问题，扩容会缓解该问题。

resize()方法源码如下：

final Node<K,V>[] resize() {
    //oldTab：引用扩容前的哈希表
    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) {
        //扩容之前的table数组大小已经达到 最大阈值后，则不扩容，且设置扩容条件为 int 最大值。
        if (oldCap >= MAXIMUM_CAPACITY) {
            threshold = Integer.MAX_VALUE;
            return oldTab;
        }

        //oldCap左移一位实现数值翻倍，并且赋值给newCap， newCap 小于数组最大值限制 且 扩容之前的阈值 >= 16
        //这种情况下，则 下一次扩容的阈值 等于当前阈值翻倍
        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有数据
    else if (oldThr > 0) // initial capacity was placed in threshold
        newCap = oldThr;

    //oldCap == 0，oldThr == 0
    //new HashMap();空参构造方法的情况
    else {               // zero initial threshold signifies using defaults
        newCap = DEFAULT_INITIAL_CAPACITY;//16
        newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);//12
    }

    //newThr为零时，通过newCap和loadFactor计算出一个newThr
    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;

    //说明，hashMap本次扩容之前，table不为null
    if (oldTab != null) {

        for (int j = 0; j < oldCap; ++j) {
            //当前node节点
            Node<K,V> e;
            //说明当前桶位中有数据，但是数据具体是 单个数据，还是链表 还是 红黑树 并不知道
            if ((e = oldTab[j]) != null) {
                //方便JVM GC时回收内存
                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;
                        //hash-> .... 1 1111
                        //hash-> .... 0 1111
                        // 0b 10000

                        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()方法的前半部分就是用来计算newCap（扩容之后table数组的大小 ）和 newThr（扩容之后新的扩容阈值），后半部分是核心部分，进行数据迁移等操作。

方法前半部分流程

在判断已经初始化的情况：

• 如果oldCap大于0，证明该hashMap已经初始化过了，进行正常的扩容，会在进行一个判断，判断老的数组大小是否已经大于最大值，如果是，数组大小不变，扩容阈值变为Integer的最大值，return，结束扩容操作。
• 如果oldCap没有达到最大值，将oldCap变为原来的两倍（左移一位），进行判断如果oldCap在左移之后没有大于最大值并且oldCap要大于默认（16）才进行扩容阈值的左移一位。
  没有初始化的情况：
• 如果oldCap小于0，证明没有初始化，如果在该条件下旧的扩容阈值oldThr大于0，将新的数组大小等于老的扩容阈值oldThr（调用有初始容量入参的构造方法时计算出来的）
• 如果oldCap和oldThr都为0的话，新的数组大小设置为默认值16，扩容阈值使用默认值进行计算（负载因子×数组容量），这种情况只有在无参构造时才会出现。
• 最后判断新的扩容阈值是否计算出来，如果没有，再一次进行计算，因为在前面几种情况中有可能因为没满足条件而没有计算出newThr，所以再用计算出来的newCap进行一遍计算（负载因子×数组容量）

方法后半部分流程

• 首先会根据计算出来的newCap初始化一个新的数组
• 之后循环旧的位桶数组，如果位桶数组的位置上只有一个元素（即不是链表也不是红黑树），直接将该元素放入重新计算路由之后的新的位桶数组的位置上（newTab[e.hash & (newCap - 1)] = e;）
• 如果不只有一个元素，判断如果是红黑树，进行红黑树相关操作
• 如果是链表，循环该链表，通过判断(e.hash & oldCap) == 0，来划分是高位链表还是低位链表
• 将这个链表分成两个链表高位链表和低位链表按照如下规则放入新位桶数组中

newTab[j] = loHead;		
newTab[j + oldCap] = hiHead;

getNode方法

源码分析

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

流程：

首先用户调用 get(Object key)方法
get()方法调用 final Node<K,V> getNode(int hash, Object key) 方法 getNode方法流程如下：

• 首先判断该HashMap是否已经初始化，且其中的位桶数组长度大于0，且经过路由寻址运算后，找到对应的位桶数组上的值不为空
• 之后判断位桶上的第一个元素是否就是要查找的元素，如果是直接返回一个Node（具体判断如下）
• 如果不是第一个元素，则判断第一个元素是否为空，不为空的话可能是红黑树也可能是链表，进行判断
• 如果是红黑树，进行红黑树的取值
• 如果是链表，循环该链表，一直进行比较，直到找到返回为止

putVal方法

源码分析

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，这个时候，直接将当前k-v=>node 扔进去就可以了
        if ((p = tab[i = (n - 1) & hash]) == null)
            tab[i] = newNode(hash, key, value, null);

        else {
            //e：不为null的话，找到了一个与当前要插入的key-value一致的key的元素
            //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) {
                    //条件成立的话，说明迭代到最后一个元素了，也没找到一个与你要插入的key一致的node
                    //说明需要加入到当前链表的末尾
                    if ((e = p.next) == null) {
                        p.next = newNode(hash, key, value, null);
                        //条件成立的话，说明当前链表的长度，达到树化标准了，需要进行树化
                        if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
                            //树化操作
                            treeifyBin(tab, hash);
                        break;
                    }
                    //条件成立的话，说明找到了相同key的node元素，需要进行替换操作
                    if (e.hash == hash &&
                            ((k = e.key) == key || (key != null && key.equals(k))))
                        break;
                    p = e;
                }
            }

            //e不等于null，条件成立说明，找到了一个与你插入元素key完全一致的数据，需要进行替换
            if (e != null) { // existing mapping for key
                V oldValue = e.value;
                if (!onlyIfAbsent || oldValue == null)
                    e.value = value;
                afterNodeAccess(e);
                return oldValue;//这里是替换，直接return，不会进入后续的size自增
            }
        }

        //modCount：表示散列表结构被修改的次数，替换Node元素的value不计数
        ++modCount;
        //插入新元素，size自增，如果自增后的值大于扩容阈值，则触发扩容。
        if (++size > threshold)
            resize();
        afterNodeInsertion(evict);
        return null;
    }

流程：

1）首先会进行判断位桶table是否初始化，如果没有会进行初始化。
2）然后根据传进来的hash值进行路由寻址，找到位桶中的位置。
3）判断上一步找到的位置上是否为空，如果为空，new一个node直接放进去。
4）如果不为空，判断key值是否相等，如果相等记录该元素为e，之后进行替换操作，如果不等 判断该位置的元素是否为红黑树，是进行红黑树的插值操作。
6）如果不是则在该位置上是一个链表，进行比较插入操作。循环看能否找到key值相等的已经在链表中的元素，如果有，同样记录为e，后续进行替换操作。
7）每次进行插入（替换不算，替换后会进行return）size都会自增，当size大于扩容阈值时会进行resize()扩容操作

hash方法

Hash就是把任意长度的输入,通过散列算法,变换成固定长度的输出,该输出就是散列值。

static final int hash(Object key) {
    int h;
    return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
}

该算法用来计算key的hash值，key的hash值异或其右移16位后的数字，让key的高16位也参与路由寻址运算，对hash算法的一个优化，使计算出来的路由索引更加散列，降低hash冲突概率。

路由寻址算法

HashMap中使用的路由寻址算法路由，通过如下算法计算node节点对应的位桶数组的下标

(table.length-1) & node.hash

结语：

至此HashMap几个主要方法的源码分析完毕，但是需要注意的是HashMap是线程不安全，在需要保证线程安全的情况下可以使用线程安全的ConcurrentHashMap集合，如果想要了解可以查看我的另一篇有关ConcurrentHashMap的文章。