手撕 JDK1.8 HashMap源码

╰+哭是因爲堅強的太久メ 2022-12-18 03:55 150阅读 0赞

### 手撕 JDK1.8 HashMap源码 ###

*  1.HashMap核心属性
 *  2.构造方法
 *  3.HashMap put 方法分析 => putVal方法分析
 *  4.HashMap resize 扩容方法分析(核心)
 *  5.HashMap get 方法分析
 *  6.HashMap remove 方法分析
 *  7.HashMap replace 方法分析
 *  8.视频讲解

[什么是哈希][Link 1]：把任意长度的输入，通过Hash算法变成固定长度的输出。

看源码之前也可以先看看[hashMap原理][hashMap]

前言：  
由于HashMap源码涉及了红黑树的操作，但是这里我没有对源码中涉及红黑树展开，但是并不影响学习，有兴趣的可以先研究一下[红黑树][Link 2]再自己看看HashMap的源码涉及红黑树的部分。

# 1.HashMap核心属性 #

//树化阈值
    static final int TREEIFY_THRESHOLD = 8;
    
    //缺省负载因子大小
    static final float DEFAULT_LOAD_FACTOR = 0.75f;
    
    //数组的默认长度16
    static final int DEFAULT_INITIAL_CAPACITY = 1 << 4;
    
    //负载因子
    final float loadFactor;
    
    //扩容阈值，当你的哈希表中的元素超过阈值时，触发扩容
    //threshold = capacity * loadFactor，即扩容阈值 = 数组长度 * 负载因子
    int threshold;
    
    //当前哈希表中元素个数
    transient int size;
    
    //当前哈希表结构修改次数，替换不算结构修改
    transient int modCount;
    
    //table最大长度
    static final int MAXIMUM_CAPACITY = 1 << 30;
    
    //树降级称为链表的阈值
    static final int UNTREEIFY_THRESHOLD = 6;
    
    //树化的另一个参数，当哈希表中的所有元素个数超过64时，才会允许树化
    static final int MIN_TREEIFY_CAPACITY = 64;

# 2.构造方法 #

//主要构造方法，initialCapacity数组长度，loadFactor负载因子
    public HashMap(int initialCapacity, float loadFactor) { 
    
        //其实就是做了一些校验
        //capacity必须是大于0 ，最大值也就是 MAX_CAP
        if (initialCapacity < 0)
            throw new IllegalArgumentException("Illegal initial capacity: " +
                    initialCapacity);
        if (initialCapacity > MAXIMUM_CAPACITY)
            initialCapacity = MAXIMUM_CAPACITY;
    
        //loadFactor必须大于0
        if (loadFactor <= 0 || Float.isNaN(loadFactor))
            throw new IllegalArgumentException("Illegal load factor: " +
                    loadFactor);
    
        this.loadFactor = loadFactor;
        this.threshold = tableSizeFor(initialCapacity);	 //tableSizeFor方法返回一个大于或等于initialCapacity的数，同时这个数要保证是2的n次方
    }
    
    //套娃了上面两个参数的HashMap方法
    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);
    }

上面两个参数的构造方法中调用了tableSizeFor方法，下面看看这是怎么实现的

/** * 作用：返回一个大于等于当前值cap的一个数字，并且这个数字一定是2的次方数 * * 如果cap是10 * cap = 10 * n = 10 - 1 => 9 * 0b1001 | 0b0100 => 0b1101 * 0b1101 | 0b0011 => 0b1111 * 0b1111 | 0b0000 => 0b1111 * 0b1111 => 15 * return 15 + 1; * * 如果cap是16，而且不要cap - 1； * cap = 16 * n = 16; * 0b10000 | 0b01000 =>0b11000 * 0b11000 | 0b00110 =>0b11110 * 0b11110 | 0b00001 =>0b11111 * =>0b11111 => 31 * return 31 + 1; * * 0001 1101 1100 => 0001 1111 1111 + 1 => 0010 0000 0000 一定是2的次方数 * */
    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;
    }

# 3.HashMap put 方法分析 => putVal方法分析 #

//put方法调用了putVal方法
    public V put(K key, V value) { 
        return putVal(hash(key), key, value, false, true);
    }

我们先不看putVal方法，我们先看看putVal方法里的参数hash(key)方法

/** * 作用：让key的hash值的高16位也参与路由运算 * 异或：相同则返回0，不同返回1 * * 示例： * h = 0b 0010 0101 1010 1100 0011 1111 0010 1110 * 0b 0010 0101 1010 1100 0011 1111 0010 1110 * ^ * 0b 0000 0000 0000 0000 0010 0101 1010 1100 * => 0010 0101 1010 1100 0001 1010 1000 0010 */
    static final int hash(Object key) { 
        int h;
        return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
    }

接下来看看put中最重要的方法putVal

/** * 参数说明 * hash：key的hash值 * key * value * onlyIfAbsent： 如果为 true，当找到与key相同的元素时不会重新修改它的值 * 如果为 false，找到与要插入的元素相同的元素就会进行重新插入或替换 */
    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;
            }
        }
    
        //modCount：表示散列表结构被修改的次数，替换Node元素的value不计数
        ++modCount;
        //插入新元素，size自增，如果自增后的值大于扩容阈值，则触发扩容。
        if (++size > threshold)
            resize();
        afterNodeInsertion(evict);
        return null;
    }

# 4.HashMap 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
            //这种情况下，则 下一次扩容的阈值 等于当前阈值翻倍(5 << 1 = 10)
            else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
                    oldCap >= DEFAULT_INITIAL_CAPACITY)
                newThr = oldThr << 1;
        }
    
        //oldCap == 0,说明hashMap中的散列表是null
        //1.new HashMap(initCap, loadFactor);
        //2.new HashMap(initCap);
        //3.new HashMap(map); 并且这个map有数据
        else if (oldThr > 0)
            newCap = oldThr;
    
        //oldCap == 0，oldThr == 0
        //new HashMap();
        else { 
            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;
    	
    //上面代码计算出newCap和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 { 
                        //第三种情况：桶位已经形成链表
    
                        //低位链表：存放在扩容之后的数组的下标位置，与当前数组的下标位置一致。
                        Node<K,V> loHead = null, loTail = null;
                        //高位链表：存放在扩容之后的数组的下表位置为 当前数组下标位置 + 扩容之前数组的长度
                        Node<K,V> hiHead = null, hiTail = null;
    
                        Node<K,V> next;
                        do { 
                            next = e.next;
                            /** * e.hash & oldCap 把一条链表上的数据分为高链和低链 * 例如： * hash只能是以下两种形式，倒数第五位要么是0要么是1，与上oldCap也只有0和非0两种情况，如果为0则放低链，非0则放高链 * hash-> .... 1 1111 * hash-> .... 0 1111 */
    
                            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;
    }

# 5.HashMap get 方法分析 #

public V get(Object key) { 
        Node<K,V> e;
        return (e = getNode(hash(key), key)) == null ? null : e.value;
    }

get方法套娃一个getNode()方法，这是get方法的重点，hash(key)方法在上面put方法已经说过了

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

# 6.HashMap remove 方法分析 #

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

remove方法套娃了一个removeNode方法，重点就是这个removeNode方法了

/** * hash * key * value * matchValue：如果为true，需要同时匹配上key和value才删除，如果为false，只需要匹配上key就删除 */
    final Node<K,V> removeNode(int hash, Object key, Object value,
                               boolean matchValue, boolean movable) { 
        //tab：引用当前hashMap中的散列表
        //p：当前node元素
        //n：表示散列表数组长度
        //index：表示寻址结果
        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：查找到的结果
            //e：当前Node的下一个元素
            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);
                }
            }
    
    
            //判断node不为空的话，说明按照key查找到需要删除的数据了
            if (node != null && (!matchValue || (v = node.value) == value ||
                    (value != null && value.equals(v)))) { 
    
                //第一种情况：node是树节点，说明需要进行树节点移除操作
                if (node instanceof TreeNode)
                    ((TreeNode<K,V>)node).removeTreeNode(this, tab, movable);
    
                //第二种情况：桶位元素即为查找结果，则将该元素的下一个元素放至桶位中
                else if (node == p)
                    tab[index] = node.next;
    
                else
                    //第三种情况：将当前元素p的下一个元素 设置成 要删除元素的 下一个元素。
                    p.next = node.next;
    
                ++modCount;
                --size;
                afterNodeRemoval(node);
                return node;
            }
        }
        return null;
    }

# 7.HashMap replace 方法分析 #

两个replace方法，getNode方法上面已经说过了

@Override
        public boolean replace(K key, V oldValue, V newValue) { 
            Node<K,V> e; V v;
            if ((e = getNode(hash(key), key)) != null &&
                    ((v = e.value) == oldValue || (v != null && v.equals(oldValue)))) { 
                e.value = newValue;
                afterNodeAccess(e);
                return true;
            }
            return false;
        }
    
        @Override
        public V replace(K key, V value) { 
            Node<K,V> e;
            if ((e = getNode(hash(key), key)) != null) { 
                V oldValue = e.value;
                e.value = value;
                afterNodeAccess(e);
                return oldValue;
            }
            return null;
        }

# 8.视频讲解 #

B站有讲解[HahMap源码][HahMap]的视频

[Link 1]: https://blog.csdn.net/weixin_44624410/article/details/106433619
[hashMap]: https://blog.csdn.net/weixin_44624410/article/details/109279297
[Link 2]: https://blog.csdn.net/weixin_44624410/article/details/109217530
[HahMap]: https://www.bilibili.com/video/BV1LJ411W7dP