源码笔记之HashMap

今天主要任务就是系统的看下HashMap的源码,扫一扫平时没接触到的盲点。

首先从我们先来了解一下三个参数及结构。

  1. initialCapacity (初始容量值,默认为16)
  2. threshold (阈值,最大限载量,其值=initialCapacity*loadFactor
  3. loadFactor(负载因子,用于控制扩容等操作,默认0.75。当其值越大时则扩容概略越小,存储的空间复杂度低,但是因为链表区域查询效率低于数组块区域搜寻,所以时间复杂度较大。反之亦然)

这里我们还要提前记住hashmap的结构--数组+链表,如图(网上找的图,原作者有异议,请批评我哈,我在换掉):

好了,接下来就让我们撸下源码吧

HashMap有四个构造,我们用的最多的应该就是第三个无参构造了。


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

    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方法,对阀值初始化,来看下该方法源码

    /**
     * Returns a power of two size for the given target capacity.
     */
    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;
    }

从解释也能看出该方法是返回离cap最近2的最小次幂(可能等于本身)。这里是为什么呢?

简单来撸下这个小算法(位运算忘了的点这里)。

假设n的二进制为01xxx...xxx。接着

对n右移1位:001xx...xxx,再位或运算得到了:011xx...xxx

对n右移2为:00011...xxx,再位或运算得到了:01111...xxx

此时前面已经有四个1了,再右移4位且位或可得8个1

同理,有8个1,右移8位肯定会让后八位也为1。

综上可得,该算法让最高位的1后面的位全变为1。

最后再让结果n+1,即得到了2的整数次幂的值了。

而且第一句cap-1的策略也是为了找到最接近的值。如果十进制为4的数字,经过上列操作得到8,显然不对,减一以后得到4。

接下来我们看下重中之重的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) {
        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);
        // 上边情况未发生,进行如下处理,即通过hash找到的位置有值,说明发生了碰撞
        else {
            Node<K,V> e; K k;
            // hash值相同,key也相同则是进行覆盖操作了,先赋给e
            if (p.hash == hash &&
                ((k = p.key) == key || (key != null && key.equals(k))))
                e = p;
            // 为红黑树类型,则使用其进行查找(链容量大于8时转为红黑树存储)
            else if (p instanceof TreeNode)
                e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
            else {
            // 上述情况未发生则类型是链表
                for (int binCount = 0; ; ++binCount) {
                    // 链表子节点没有值(next为空),则将链表next指向该值
                    if ((e = p.next) == null) { 
                        p.next = newNode(hash, key, value, null);
                        // 链表容量达到阈值8转为红黑树存储并终止循环
                        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;
                }
            }
            // 经过上边的操作已经确定了key对应的位置并且新值存在链表中了,但e的value没在for循环里赋值,这里赋值(yy:感觉这段代码放在for里的e = p.next) == null条件下是一样的效果?)
            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方法进行了三项操作:

1、首先检查是否初始化,如果未初始化进行初始化

2、如果已初始化,指定索引位置为空,直接存储

3、已经初始化,并且指定索引处有数据:

        1、key相同而且hash值也相同则直接进行覆盖操作

        2、桶中数据为tree类型转为红黑树插入

        3、模式为链表,进行链表操作

               1、当前值next为空,直接将next指向该值

               2、链表长度大于阈值8,使用红黑树进行插入

               3、值已经存在hash值及key值都相等,终止本次遍历

               4、通过key及hash定位的位置正确,进行value值更新

4、大于容量阈值,进行扩容操作

这里关注下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) {
            // 容量已经到达峰值,不能在扩容了,阈值设置成integer最大值
            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
        }
        // 阈值大于0时,先使用阈值暂存初始容量参数的值
        else if (oldThr > 0) // initial capacity was placed in threshold
            newCap = oldThr;
        // 尚未初始化,则对初始容量进行赋值(默认16)和阈值进行赋值。此处对应上面我们常用的无参 
           构造,因为构造未对两项进行赋值。
        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;
                            区分高低位,0为低位分配到低位表,1高位为分配到高位表。后面会具体解释下
                            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;
    }

这里的高位、低位原理通过一个小例子说明:

1、假设当前数组长度为16,表中存在数据为下

key值hash值hash & length -1(& 0000 1111)
10001 01004
20110 01004
31001 01004
40101 01004

这个几值都存储在index = 4 的位置下的链表中,当扩容时,length-double增加到32

key值hash值hash & length -1(& 0001 1111)
10001 010020
20110 01004
31001 010020
40100 01004

可以看到key的1、3位index变成了20,2、4还是4。这就是resize中为什么使用0区分高低位的巧妙之处,只看高位是否是0。

总结:该方法感觉起来也很复杂。

1、首先如果初始化状态:

       1、已初始化并容量已经最大,则直接赋予容量为integer最大值,但是如果扩容二倍未超过最大阈值并大于默认值,则进行二倍扩容操作。

       2、阈值大于0时,先使用阈值暂存初始容量参数的值

       3、未初始化,则对阈值及初始容量进行计算和赋值

2、桶中原来有数据时,因为容量发生变化所以进行重新分组赋值。

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;
        // 先决条件桶不能为null并且指定位置有元素
        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;
    }

1、首个节点有元素并且key值相同,直接返回first

2、否则如果元素是tree元素,在其中查找,如果是链表中的元素,从链表中查找返回

remove方法

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

   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;
            // 该位置hash值及key值都相等,则定位该位置并赋值给变量 
            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);
                }
            }
            // 通过判断条件,则说明已定位到所要item 
            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;
                // 如果上述情况没出现,则说明在链结构中,只需要将链节点的next节点往上调一位达到删除的目的。
                else
                    p.next = node.next;
                ++modCount;
                --size;
                afterNodeRemoval(node);
                return node;
            }
        }
        return null;
    }

1、如果index位置的key与hash都相同,则说明此处就一个值,直接记录此node

2、如果为红黑树数据,从树中寻找到该值

3、最后一种,存在于链表中,首先do-while定位值

4、寻找到值后:

  • 若为红黑树数据,交给树去删除
  • 如果index值直接找到,并且不存在链表中,直接将index定位到的node的next,达到在链表中抛弃原有值的目的
  • 如果在链表中找到,同样也直接将此位置next指向变量的next值                        

还有一个值得注意的方法hash

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

hashcode值一般默认返回的是根据数据的存储地址获取的int值,这里根据key的hashcode以及key的hashcode右移16位后进行异或运算得到的值。这其实是为了在未发生碰撞时将元素更匀称的存储到桶中。同时我们可能观察到容量长度一直都是2的n次幂,容量长度必须是2的n次幂,主要是因为运算的高效以及均匀分布元素时的分配,具体可以看下这篇文章:点这里

小案例:一文看懂HashMap扩容为什么是2的n次幂 - 腾讯云开发者社区-腾讯云

注:我们上边讲解的方法里都会有类似的字眼:(n-1)&hash来获取index等操作,其实他的结果与 取模操作是一样的,但是与运算的效率要高于取模操作数倍,想研究看这里

好了,今天的知识点扫盲就到这了。

  • 1
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值