【HashMap】源码笔记

HashMap是基于哈希表的 Map 接口的实现,在实际开发中十分常用,通过分析源码和解析之后记录一下自己的理解。


每一个元素包含一个key和key对应的value

HashMap 最多只允许一条记录的键为 null,允许多条记录的值为 null

HashMap 线程不同步

不保证映射的顺序,且不保证该顺序恒久不变

HashMap底层存储结构是数组+链表(或红黑树)


继承(实现)关系

extends

|---AbstractMap<K,V>

implements

|---Map<K,V>
|---Cloneable
|---java.io.Serializable


常量字段

    
    //序列化的版本号
    private static final long serialVersionUID = 362498820763181265L;
        
    //默认的初始容量 1左移4位(16)
    static final int DEFAULT_INITIAL_CAPACITY = 1 << 4;
    
    //最大容量 1左移30位(2^30)
    static final int MAXIMUM_CAPACITY = 1 << 30;

    //默认的负载因子(0.75)
    static final float DEFAULT_LOAD_FACTOR = 0.75f;

    //链表树形化的阈值(在链表长度大于8的时候,链表转为红黑树结构)    
    static final int TREEIFY_THRESHOLD = 8;

    //树结构转为链表的阈值(在树节点小于6时,红黑树转变为链表)
    static final int UNTREEIFY_THRESHOLD = 6;

    //进行树形化,哈希表要达到的最小容量(当哈希表容量大于64时,才进行链表树形化,否则则进行哈希      
    //表的扩容)
    static final int MIN_TREEIFY_CAPACITY = 64;

变量字段

    //哈希表数组
    transient Node<K,V>[] table;

    //键值对集
    transient Set<Map.Entry<K,V>> entrySet;

    //键值对数目
    transient int size;

    //从结构上修改HashMap的次数
    transient int modCount;

    //哈希表扩容阈值(哈希表内元素超过阈值时,执行扩容resize(),容量*负载因子)
    int threshold;

    //负载因子
    final float loadFactor;

构造方法

1.无参构造

    public HashMap() {

        //初始化负载因子为默认的负载因子(0.75)
        this.loadFactor = DEFAULT_LOAD_FACTOR; 
    }

解析:使用无参的构造方法初始化一个HashMap,底层只做了一件事,将负载因子初始化为默认的负载因子,也就是0.75。

2.含参构造①

    public HashMap(int initialCapacity) {
        this(initialCapacity, DEFAULT_LOAD_FACTOR);
    }

解析:该构造方法用来指定初始容量,参数就是指定的初始容量,它的实现是调用的另一个构造方法,具体见含参构造②。

3.含参构造②

    public HashMap(int initialCapacity, float loadFactor) {

        //检查传入的初始容量是否小于0,如果小于0,抛出异常。
        if (initialCapacity < 0)
            throw new IllegalArgumentException("Illegal initial capacity: " +
                                               initialCapacity);

        //检查传入的初始容量是否大于可设置的最大容量(2^30),如果大于2^30,将初始容量设置为2^30
        if (initialCapacity > MAXIMUM_CAPACITY)
            initialCapacity = MAXIMUM_CAPACITY;

        //检查传入的负载因子是否符合要求
        //如果小于等于0,或者是一个非数字,则抛出异常
        if (loadFactor <= 0 || Float.isNaN(loadFactor))
            throw new IllegalArgumentException("Illegal load factor: " +
                                               loadFactor);

        //初始化负载因子
        this.loadFactor = loadFactor;
        //调用tableSizeFor方法,初始化哈希表扩容阈值,tableSizeFor方法见下
        this.threshold = tableSizeFor(initialCapacity);
    }

    //该方法接收一个初始容量,计算出大于该容量的最小的2的幂
    //如: 传入15 ——>  返回16
    //    传入29 ——>   返回32
    //PS:如果结果小于0,则返回1,如果结果大于等于最大容量2^30,则返回2^30
    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;
    }

解析:该构造方法可以用来指定初始容量和负载因子,首先进行两个参数的合法性判断,然后初始化负载因子和扩容阈值,扩容阈值由一个tableSizeFor()方法得到,其内部实现是返回大于等于初始容量的最小的2的幂,但不会大于最大容量2^30。

4.含参构造③

    public HashMap(Map<? extends K, ? extends V> m) {

        //初始化负载因子为默认的负载因子(0.75)
        this.loadFactor = DEFAULT_LOAD_FACTOR;

        //调用putMapEntries方法 来构造新的HashMap,putMapEntries见下
        putMapEntries(m, false);
    }

    final void putMapEntries(Map<? extends K, ? extends V> m, boolean evict) {

        //传入的集合的长度
        int s = m.size();

        //如果传入的集合不为空
        if (s > 0) {
            //判断当前哈希表数组,如果为空
            if (table == null) 
            { 
                //计算ft = 传入的集合长度/负载因子(0.75)+1
                float ft = ((float)s / loadFactor) + 1.0F;

                int t = ((ft < (float)MAXIMUM_CAPACITY) ?
                         (int)ft : MAXIMUM_CAPACITY);

                //如果计算出的t大于当前的扩容阈值,调用tableSizeFor方法计算新的扩容阈值
                if (t > threshold)
                    threshold = tableSizeFor(t);
            }
            //如果传入集合的长度大于扩容阈值,则进行扩容
            else if (s > threshold)
                resize();

            //遍历传入的map集合,将内容保存到当前hashMap中
            for (Map.Entry<? extends K, ? extends V> e : m.entrySet()) 
            {
                K key = e.getKey();
                V value = e.getValue();
                putVal(hash(key), key, value, false, evict);
            }
        }
    }

解析:这个构造函数是一个根据旧Map集合来构造一个新的HashMap集合的过程,先初始化负载因子为默认的0.75,然后调用putMapEntries方法,初始化一个新的HashMap,将原集合中的内容添加到新的HashMap中,中间进行了对扩容阈值和容量的检查和更新。


关键方法

1.static final int hash(Object key)

    static final int hash(Object key) {
        int h;
        //如果传入的key为空,则返回0
        //如果不为空,返回key的哈希值h(Object.hashCode()得到)与(h右移16位的值)相异或的结果         
        return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
    }

解析:HashMap中通过这个方法计算key的hash值,来加大hash值的随机性,减少hash冲突。具体实现是,先通过Object的hashCode方法得到一个值h,然后将h与h的高16位进行异或运算,其结果就作为最终的hash值。


2. public V put(K key, V value)

    public V put(K key, V value) {
        //调用hash方法计算hash值,然后调用putVal进行添加
        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;

        //判断当前哈希表数组是否为空,或者长度是否为0,如果是则进行初始化且记录下初始化长度为n
        if ((tab = table) == null || (n = tab.length) == 0)
            n = (tab = resize()).length;

        //(n-1)&hash 其实就是一个求余运算的高效写法 用来求出元素存放在tab数组中的位置i
        //p = tab[i],p就是元素该存放的位置上的链节点
        //如果p为空,说明没有hash冲突,就直接创建节点,放在i位置上即可
        if ((p = tab[i = (n - 1) & hash]) == null)
            tab[i] = newNode(hash, key, value, null);
        else 
        {
            //如果发生hash冲突
            Node<K,V> e; K k;

            //如果p的hash与传入的hash相同
            //key也相同,就让e指向冲突位置的头结点
            if (p.hash == hash &&
                ((k = p.key) == key || (key != null && key.equals(k))))
                e = p;

            else if (p instanceof TreeNode)
            //如果p是一个树结构,基于红黑树的方式,进行插入
                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)
                            treeifyBin(tab, hash);
                        break;
                    }
                    //冲突链表中包含要插入的元素,就退出循环
                    if (e.hash == hash &&
                        ((k = e.key) == key || (key != null && key.equals(k))))
                        break;
                    p = e;
                }
            }

            //原来已经存在相同key的键值对,只需要覆盖值
            if (e != null) 
            { 
                V oldValue = e.value;
                if (!onlyIfAbsent || oldValue == null)
                    e.value = value;
                afterNodeAccess(e);
                return oldValue;
            }
        }
        //修改次数+1
        ++modCount;
        //判断当前哈希表数组大小是否大于扩容阈值,如果是,进行扩容
        if (++size > threshold)
            resize();
        afterNodeInsertion(evict);
        return null;
    }

解析:HashMap中插入映射的方法,在计算hash值后直接调用底层的putVal方法实现插入。putVal中需要注意的是,在发生hash冲突之后,会先判断该位置上的结构是链表还是红黑树结构,分别采用不同的插入方式,在基于链表插入之后,还会判断该链表长度是否超过了树形化的阈值,如果超过,会将链表转化为红黑树结构。最后插入完成后修改次数加1,切判断是否需要扩容。


3.final Node<K,V>[] 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;

        //如果当前的容量大于0
        if (oldCap > 0) {
            //如果当前容量大于等于最大容量2^30,无法再扩容,直接返回原数组
            if (oldCap >= MAXIMUM_CAPACITY) {
                threshold = Integer.MAX_VALUE;
                return oldTab;
            }
            //如果当前容量小于最大容量2^30,当前容量的两倍小于最大容量2^30且当前容量大于等于默认的初始容量16,新容量=当前容量*2
            else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
                     oldCap >= DEFAULT_INITIAL_CAPACITY)
                //设置新的扩容阈值为当前扩容阈值的两倍
                newThr = oldThr << 1; 
        }
        // oldCap=0, 说明原来的table数组为null 
        else if (oldThr > 0) 
            //将原来的扩容阈值设置为新的容量
            newCap = oldThr;

        // oldCap=0,oldThr=0 那么所有参数都采用默认值
        else {               
            //容量 = 默认的初始容量16
            newCap = DEFAULT_INITIAL_CAPACITY;
            //扩容阈值=默认负载因子(0.75)*默认初始容量(16)
            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"})
            //创建新数组,并让table指向它
            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)        //如果没有hash冲突,该位置上是节点
                        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;
                            //重新计算元素在新数组中的hash,并复制进来
                            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;
    }

解析:哈希表数组扩容。在哈希表数组为空时初始化一个数组,在不为空时进行扩容,扩容为原容量的两倍,并且将原数组中的内容重新计算hash存入到新数组中。(由于原数组与新数组容量相差两倍,所以新的hash要么不变,要么等于原hash+原容量)


4.public V remove(Object key)

    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不冲突
            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即为要删除的元素
            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.next = node.next;
                //修改次数+1
                ++modCount;
                //长度-1
                --size;
                afterNodeRemoval(node);
                return node;
            }
        }
        return null;
    }

解析:根据键key删除一个元素,在计算hash值后直接调用底层的removeNode方法实现删除。重点是根据不同的结构执行不同的删除操作。


5.public V get(Object key)

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

    //hash:根据key算出的hash值
    //key:要查找的key
    final Node<K,V> getNode(int hash, Object key) {
        Node<K,V>[] tab; 
        Node<K,V> first, e; 
        int n; 
        K k;
        //判断当前哈希表数组和根据hash计算出的位置都不为空
        if ((tab = table) != null && (n = tab.length) > 0 &&
            (first = tab[(n - 1) & hash]) != null) {
                
            //如果first节点对应的hash和key的hash相等,并且first对应的key也相等的话
            //first节点就是要查找的元素
            if (first.hash == hash && ((k = first.key) == key 
                                    || (key != null && key.equals(k))))
                return first;

            //如果该位置上发生了hash冲突
            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;
    }

解析:根据键key获得一个元素的值,在计算hash值后直接调用底层的getNode方法实现查找。


键值对存储结构

static class Node<K,V> implements Map.Entry<K,V> {

        //hash值
        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中由一个静态内部类来描述键值对的存储结构。


遍历报错

当在遍历的过程中,进行了添加/删除操作,会抛出ConcurrentModificationException异常

    final Node<K,V> nextNode() {
            Node<K,V>[] t;
            Node<K,V> e = next;

            //在操作次数与迭代器构造时就记录下的操作次数不相同时,说明在遍历期间执行了增删操作
            //会有并发修改的问题
            if (modCount != expectedModCount)
                throw new ConcurrentModificationException();
            if (e == null)
                throw new NoSuchElementException();
            if ((next = (current = e).next) == null && (t = table) != null) {
                do {} while (index < t.length && (next = t[index++]) == null);
            }
            return e;
        }

猜你喜欢

转载自blog.csdn.net/QiuBika_061/article/details/92380213