美文网首页
HashMap源码分析笔记

HashMap源码分析笔记

作者: 安静点就睡吧 | 来源:发表于2020-10-12 22:40 被阅读0次

    一、前言

    很早之前便看过HashMap的源码,记得自己当时是大概粗略的看了下,所以时间一久便抛诸脑后了,以至于自己总是如同猴子摘玉米,摘了玉米丢了西瓜。想来如此,还不如踏踏实实用笔记记录的形式记录下来,自己有空便可以翻阅出来看看,也不会将之前的心血白费。

    二、源码分析

    public class HashMap<K,V> extends AbstractMap<K,V> implements Map<K,V>, Cloneable, Serializable {
        /**
         * 默认初始化容量-必须是2的幂次方
         */
        static final int DEFAULT_INITIAL_CAPACITY = 1 << 4; // aka 16
    
        /**
         * 最大容量,如果某个具有参数的构造函数隐式指定了更高的值,则使用该值。必须是2的幂<=1<<30。
         */
        static final int MAXIMUM_CAPACITY = 1 << 30;
    
        /**
         * 当构造函数没有指定所使用的默认负载因子
         */
        static final float DEFAULT_LOAD_FACTOR = 0.75f;
    
        /**
         * 当链表节点转换为红黑树的阈值
         */
        static final int TREEIFY_THRESHOLD = 8;
        
        /**
         * 当红黑树转换为链表的阈值
         */
        static final int UNTREEIFY_THRESHOLD = 6;
    
        /**
         * 链表转换为红黑树的最小表容量
         */
        static final int MIN_TREEIFY_CAPACITY = 64;
    
        /**
         * 存储元素的数组,第一次使用时才会进行初始化
         */
        transient Node<K,V>[] table;
    
        /**
         * 保存缓存的entrySet
         */
        transient Set<Map.Entry<K,V>> entrySet;
    
        /**
         * map集合中存放元素的个数
         */
        transient int size;
    
        /**
         * 被修改的次数fast-fail机制
         */
        transient int modCount;
    
        /**
         * 扩容阈值(capacity * loadFactor)
         */
        int threshold;
    
        /**
         * 负载因子
         */
        final float loadFactor;
    }
    

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

    HashMap#TreeNode(红黑树节点):

    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);
        }
    
        /**
         * Returns root of tree containing this node.
         */
        final TreeNode<K,V> root() {
            for (TreeNode<K,V> r = this, p;;) {
                if ((p = r.parent) == null)
                    return r;
                r = p;
            }
        }
    }
    

    HashMap#hash工具类:

    static final int hash(Object key) {
        int h;
        //如果给定的key为null则直接返回0
        //否则先获取该key对应的hashCode然后参与该hashCode无符号向右位移16位后进行逻辑异或得出其最终hash值
        return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
    }
    

    至于为啥要与高16位做异或运算,是因为数组位置的定位用的是与运算,仅仅最后四位有效,设计者将key的哈希值与高16位做异或运算使得在做逻辑与运算确定数组的插入位置时,此时的低位实际上是高位与低位的结合,增加了随机性,减少了哈希碰撞的次数。

    HashMap存储结构图如下所示:

    HashMap存储结构

    2.1、HashMap的几种构造函数:

    //默认构造函数1:使用系统默认的参数(容量、负载因子...)
    public HashMap() {
        this.loadFactor = DEFAULT_LOAD_FACTOR; // all other fields defaulted
    }
    //默认构造函数2:使用默认的负载因子,并使用Map集合初始化散列集合
    public HashMap(Map<? extends K, ? extends V> m) {
        this.loadFactor = DEFAULT_LOAD_FACTOR;
        putMapEntries(m, false);
    }
    //默认构造函数3:使用指定的初始容量并且使用系统默认的负载因子
    public HashMap(int initialCapacity) {
        this(initialCapacity, DEFAULT_LOAD_FACTOR);
    }
    //默认构造函数4:使用指定的初始容量和负载因子
    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;
        //保证指定的初始容量是2的幂次方
        this.threshold = tableSizeFor(initialCapacity);
    }
    

    2.2、HashMap#put

    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) {
        //tab存储桶容器,p存储该hash所在的节点,n表示桶的容量,i表示该hash所在桶的索引位置
        Node<K,V>[] tab; Node<K,V> p; int n, i;
        //首次put元素时会初始化该table
        if ((tab = table) == null || (n = tab.length) == 0)
            n = (tab = resize()).length;
        //通过(n-1)&hash得到该hash所在桶的索引,利用该索引定位所在桶的节点赋值给p
        if ((p = tab[i = (n - 1) & hash]) == null)
             //如果该节点为空,代表该节点不存在任何数据则直接新建一个节点存放在该节点上
            tab[i] = newNode(hash, key, value, null);
        else {
            //如果该节点不为空的情况下所进行的逻辑处理
            Node<K,V> e; K k;
            //如果该节点的hash值以及key值都与put的相同,则执行替换操作
            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) {
                        //实例化一个节点到该节点的next节点上
                        p.next = newNode(hash, key, value, null);
                      //如果冲突的节点数已经达到8个,看是否需要改变冲突节点的存储结构,             
                //treeifyBin首先判断当前hashMap的长度,如果不足64,只进行
                     //resize,扩容table,如果达到64,那么将链表转换为红黑树
                        if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
                            treeifyBin(tab, hash);
                        break;
                    }
                    //如果有相同的key值就结束遍历
                    if (e.hash == hash && ((k = e.key) == key || (key != null && key.equals(k))))
                        break;
                    p = e;
                }
            }
            //如果存在该key映射的对象
            if (e != null) { // existing mapping for key
                V oldValue = e.value;
                if (!onlyIfAbsent || oldValue == null)
                    e.value = value;
                afterNodeAccess(e);
                return oldValue;
            }
        }
        ++modCount;
        //大小递增并且是否大于阈值,该阈值是loadFactory * capacity
        //首次采用的是默认值,这个阈值也就是0.75 * 16 = 12
        //如果大小触发了阈值则执行扩容操作,这个操作是插入元素之后触发的
        if (++size > threshold)
            resize();//扩容2倍
        //空实现
        afterNodeInsertion(evict);
        return null;
    }
    

    HashMap#put的操作流程:

    1. 通过给定的key计算出hashCode,计算方式为获取key的hashCode,向右无符号位移16位,再进行异或操作得到最终的hash值;

    2. 通过hash值定位到数组对应的节点上,如果该节点为空,直接new Node<>(hash,K,V,null);放入到容器对应的索引下即可;如果节点不为空的情况下,分为三种情况:

      2.1、如果该节点的hash和给定的hash一致,并且key也一致,则获取该节点对象并将新值替换老值,并返回该节点的旧值;
      2.2、如果该节点是红黑树,则调用TreeNode对象的putTreeVal(this, tab, hash, key, value)方法添加对象;
      2.3、如果该节点是链表,遍历该节点下的next节点,判断是否有空的对象,如果有空的则将当前存储的节点newNode存放到对应的p.next节点即可,之后再进行判断该链表节点长度是否大于红黑树阈值(8 - 1),如果大于则将链表转换为红黑树节点,否则跳出该循环;如果节点的next节点不为空的情况,则判断该hash是否相同,key是否相等,如果都匹配则将该节点用新接点进行替换操作,和之前的步骤相同。

    3. 添加该键值对象后,判断当前大小是否超过阈值,如果超过阈值则触发扩容操作,参见resize方法。

    2.3、HashMap#get

    public V get(Object key) {
        Node<K,V> e;
        //根据hash方法计算出该key的hash值,调用getNode获取所在节点,如果不存在返回null,反之返回该节点的value对象
        return (e = getNode(hash(key), key)) == null ? null : e.value;
    }
    
    final Node<K,V> getNode(int hash, Object key) {
        //tab为容器数组对象,first为对应hash所在的节点,e存放节点的下一个节点,n存放容器的大小,k存放节点的key
        Node<K,V>[] tab; Node<K,V> first, e; int n; K k;
        //通过容器的容量-1逻辑与上hash值定位到该数组的节点所在位置
        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;
    }
    

    HashMap#get的操作流程:

    1、通过hash方法计算得到该key的hash值;

    2、再调用getNode方法,通过容器的容量-1逻辑与上该keyhash值,得到该节点对象;

    3、首先检查该节点的hash值是否相等,并且key是否相等,如果相等则直接返回该节点;

    4、如果上面的情况不匹配,则判断该节点的next节点是否不为空,如果不为空则判断该节点是否为红黑树节点,如果是红黑树,则执行红黑树的getTreeNode方法获取节点对象;否则就只有下面链表的结构了,执行遍历操作遍历该链表结果,直到直到对应的节点hash值相同并且key相同的节点,然后返回;如果都不匹配则返回null

    2.4、HashMap#resize扩容:

    final Node<K,V>[] resize() {
            //将该容器数组赋值给oldTab
            Node<K,V>[] oldTab = table;
            //获取该容器的容量
            int oldCap = (oldTab == null) ? 0 : oldTab.length;
            //该容器的扩容阈值
            int oldThr = threshold;
            //新的容量大小以及新的阈值
            int newCap, newThr = 0;
            if (oldCap > 0) {
                //如果之前的容量已经大于等于1 << 30,则该阈值为Integer的最大值,并返回该容器对象
                if (oldCap >= MAXIMUM_CAPACITY) {
                    threshold = Integer.MAX_VALUE;
                    return oldTab;
                }
                //如果之前的容量向左位移1位(即*2)小于最大容量并且容量大小大于等于默认初始容量
                //则将新的阈值为当前容量向左位移1位(即*2),双倍快乐
                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
                //首次put元素的时候会执行该逻辑,使用默认的初始化容量以及负载因子
                //阈值为(12)=默认负载因子(0.75) * 默认初始化容量(16)
                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;
            //实例化容器数组
            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) {
                        //帮助GC
                        oldTab[j] = null;
                        //如果该容器数组上的节点下面没有其它节点,则直接存放到新的节点上即可
                        if (e.next == null)
                            newTab[e.hash & (newCap - 1)] = e;
                        //如果该节点是红黑树节点,则调用红黑树对象的split方法进行处理
                        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;
                                // 扩容长度为当前index位置+旧的容量
                                newTab[j + oldCap] = hiHead;
                            }
                        }
                    }
                }
            }
            return newTab;
        }
    

    三、总结

    花了一天的时间把HashMap看完了,通过源码的分析不得不佩服前辈的刀法,其中里面的很多实现也值得我们去借鉴和学习,HashMap在我们的工作过程中基本上每天都会用到,通过学习源码,它再也不是一个黑盒子了,正所谓知其然而知其所以然,希望自己以后能不断学习这些优秀的源码,不断提升自己的能力。

    参考内容:

    HashMap常见面试题整理

    jdk1.8 HashMap工作原理和扩容机制(源码解析)

    Java中HashMap底层实现原理(JDK1.8)源码分析

    相关文章

      网友评论

          本文标题:HashMap源码分析笔记

          本文链接:https://www.haomeiwen.com/subject/lcupektx.html