HashMap学习

部分内容参考自：https://blog.csdn.net/weixin_35586546/article/details/81153793

1. HashMap结构：
HashMap 数据结构为 数组+链表，其中：链表的节点存储的是一个 Entry 对象，每个Entry 对象存储四个属性（hash，key，value，next）

1.整体是一个数组；
2.数组每个位置是一个链表；
3.链表每个节点中的Value即我们存储的Object；

2.HashMap类：
HashMap容器继承自AbstractMap，实现了Map接口

2.1 Map接口规范
如下，Map接口中定义了一些最基本的接口规范，如get,set,isEmpty,keySet等。

2.2 AbstractMap抽象类
该类对Map接口的部分规范做了实现，如get方法和toString方法。

    public V get(Object key) {
        Iterator<Entry<K,V>> i = entrySet().iterator();
        if (key==null) {
            while (i.hasNext()) {
                Entry<K,V> e = i.next();
                if (e.getKey()==null)
                    return e.getValue();
            }
        } else {
            while (i.hasNext()) {
                Entry<K,V> e = i.next();
                if (key.equals(e.getKey()))
                    return e.getValue();
            }
        }
        return null;
    }

 public String toString() {
        Iterator<Entry<K,V>> i = entrySet().iterator();
        if (! i.hasNext())
            return "{}";

        StringBuilder sb = new StringBuilder();
        sb.append('{');
        for (;;) {
            Entry<K,V> e = i.next();
            K key = e.getKey();
            V value = e.getValue();
            sb.append(key   == this ? "(this Map)" : key);
            sb.append('=');
            sb.append(value == this ? "(this Map)" : value);
            if (! i.hasNext())
                return sb.append('}').toString();
            sb.append(',').append(' ');
        }
    }

2.3 对于部分方法未作实现，由子类去复写，如put方法。

  public V put(K key, V value) {
        throw new UnsupportedOperationException();
    }

3.HashMap重要方法分析：
以最重要的put方法为例，看下put(k,v)方法。
3.1 put(K key, V value)

public V put(K key, V value) {
        //参数1：key的hash值,决定了key在数组中存放的位置
        //参数2：key
        //参数3：value
        //参数4：是否改变已存在的值
        //参数5：是否是新建模式
        return putVal(hash(key), key, value, false, true);
    }

3.2 调用putVal()方法

 final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
                   boolean evict) {
        Node<K,V>[] tab; //Node类型的数组，即数组 + 链表，也就是HashMap的数据结构了。
        Node<K,V> p;//存放hash相同的K，即链表
        int n, i;
        //1.初始化table。
        //2.HashMap是懒加载的，只有调用其put()方法时，才会初始化，这点resize()方法中有注释说明
        if ((tab = table) == null || (n = tab.length) == 0) //table为空，
            n = (tab = resize()).length;//初始化后HashMap底层数组的长度，也即是HashMap的Capacity容量大小
        //1.这里(n-1)&hash算法是为了算出当前的key落在数组中的位置，n是初始化参数，默认16，**n必须要是2的整次幂**
        //2.判断计算出来的位置索引处是否有值
        if ((p = tab[i = (n - 1) & hash]) == null)
            tab[i] = newNode(hash, key, value, null);//没值节点则新建一个Node节点放到该索引处
        else {//hash出来的索引位置存在节点p
            Node<K,V> e; 
            K k;
            if (p.hash == hash &&//1.存在的节点p的hash和新put的值的hash相同
                ((k = p.key) == key || (key != null && key.equals(k))))//2. ==或equals比较两个Object类型对象
                e = p;
            else if (p instanceof TreeNode)//这里涉及到java8里面的链表红黑树转换，比较复杂，暂不考虑
                e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
            else {// hash出来的索引处节点与待put的key不重复，即与链表头部节点不重复，则判断链表后续节点
                //遍历链表
                for (int binCount = 0; ; ++binCount) {
                    if ((e = p.next) == null) {//链表只有一个头节点
                        p.next = newNode(hash, key, value, null);//put的新节点跟在p后面
                        if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st//链表长度超过树化阈值8，则链表转变为红黑树
                            treeifyBin(tab, hash);
                        break;
                    }
                    if (e.hash == hash && //put的值与链表中某个节点重复，直接break出死循环。
                        ((k = e.key) == key || (key != null && key.equals(k))))
                        break;
                    p = e;
                }
            }
            //根据put()时指定参数，决定是否覆盖已存在key，value及返回原来旧的值
            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) //如果当前HashMap的size大于threshold，则扩容，默认阈值threshold为: 0.75*CAPACITY
            resize();
        afterNodeInsertion(evict);
        return null;
    }

3.3 resize()
前面说过HashMap是懒加载的，只有调用put()方法时才会去初始化table。HashMap中定义了很多的成员变量，所以为了看懂resize()法，首先需要了解这些变量的含义：

table：用来存储数据的数组，即数组+链表结构的数组部分；
threshold：阈值，表示当前允许存入的元素数量，当元素数量超过这个值时，将进行扩容；
MAXIMUM_CAPACITY：HashMap允许的最大容量，值为1<<30，也就是2^30；
DEFAULT_INITIAL_CAPACITY：HashMap的默认初始容量，值为16；
loadFactor：负载因子，表示HashMap中的元素数量可以到达总容量的百分之多少，默认是75%，也就是说，当元素数量达到总容量的75%时，将进行扩容；
DEFAULT_LOAD_FACTOR：负载因子的默认值，也就是0.75；

 /** 初始化或者双倍扩容table容量。如果为null，则分配一个阈值大小的初始容量。
     另外我们可以使用2的次方扩充table，旧的table中的值可以移到新的table中
     相同位置处，或者移到原来旧位置 + 2的次幂 位置处。
     * Initializes or doubles table size.  If null, allocates in
     * accord with initial capacity target held in field threshold.
     * Otherwise, because we are using power-of-two expansion, the
     * elements from each bin must either stay at same index, or move
     * with a power of two offset in the new table.
     *
     * @return the table
     */
final Node<K,V>[] resize() {
        //当前table
        Node<K,V>[] oldTab = table;
       //当前table的容量，这里是容量Capcity，而非size，即只要初始化过，容量就大于0，即使没有put任何值。这时size=0
        int oldCap = (oldTab == null) ? 0 : oldTab.length;
        //当前table的阈值
        int oldThr = threshold;
        //扩容后的table的新容量，新阈值
        int newCap, newThr = 0;
        //1.当前容量>0，代表已初始化过
        if (oldCap > 0) {
            if (oldCap >= MAXIMUM_CAPACITY) {//如果当前容量超过HashMap允许最大容量，则不再扩容。
                threshold = Integer.MAX_VALUE;//将阈值设置为最大值，
                return oldTab;
            }
            //当前容量扩容两倍后 < HashMap允许的最大容量并且当前容量大于等于默认初始化容量
            else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
                     oldCap >= DEFAULT_INITIAL_CAPACITY)
                newThr = oldThr << 1; // double threshold//阈值扩大两倍
        }
        //2. 未初始化过
        //2.1 调用HashMap的无参构造函数，此时阈值由指定初始容量计算得来。public HashMap(int ){。。。}
        else if (oldThr > 0) // initial capacity was placed in threshold
            newCap = oldThr;
         //2.2 调用HashMap的无参构造函数，此时阈值，容量均为0，设置默认值，容量16，阈值16*0.75=12
        else {               // zero initial threshold signifies using defaults
            newCap = DEFAULT_INITIAL_CAPACITY;
            newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
        }
        //通过调用HashMap的有参构造初始化，newCap = oldThr ，newThr = 0
        if (newThr == 0) {//计算newThr，保证在合理允许范围之内。
            float ft = (float)newCap * loadFactor;
            newThr = (newCap < MAXIMUM_CAPACITY && ft < (float)MAXIMUM_CAPACITY ?
                      (int)ft : Integer.MAX_VALUE);
        }
        //计算 (构造函数初始化或者扩容) 出来的新阈值更新到成员变量上，以便其它方法能拿到该值。
        threshold = newThr;
        @SuppressWarnings({"rawtypes","unchecked"})
        //新建节点类型数组，将当前table中的数据拷贝到新的table中 （table就是存储节点的数组）
        Node<K,V>[] newTab = (Node<K,V>[])new Node[newCap];
        table = newTab;
        if (oldTab != null) { //resize()为扩容过程
            for (int j = 0; j < oldCap; ++j) {//遍历当前table
                Node<K,V> e;
                if ((e = oldTab[j]) != null) {//如果当前数组索引处不为空，取出该节点赋给节点e
                    oldTab[j] = null;//原节点置空，应该是help GC的作用
                    if (e.next == null)//该索引处只有一个节点，即链表只有一个节点
                        //使用hash算法算出节点在新table中的位置并赋值。
                        //capacity是2的次幂，capacity-1的二进制是以1结尾的，key.hash是随机值，所以 key.hash & (capacity-1)
                        //计算出来的位置理论上是均匀分布在数组内的，避免了数组空间浪费和链表长度过长导致查询效率低下。
                        newTab[e.hash & (newCap - 1)] = e;
                     //节点为树节点类型，链表长度超过了树化阈值(链表长度 >= 8-1 )，链表转为了红黑树，这里暂不讨论。
                    else if (e instanceof TreeNode)
                        ((TreeNode<K,V>)e).split(this, newTab, j, oldCap);
                    else { // preserve order
                        // 新建了2条链表
                        Node<K,V> loHead = null, loTail = null;
                        Node<K,V> hiHead = null, hiTail = null;
                        Node<K,V> next;
                        do {
                            
                //1. 首先要知道oldCap一定是2的次幂，即使构造传入的不是，也会被tableSizeFor(int capacity)转为2的次幂。
                //2. oldCap的二进制只有一位为1，其余位置都是0
                //3. e节点hash值的二进制与oldCap的二进制1位置对应的值只会是0或者1
                //4. 如果e.hash的二进制对应位置为0，则节点存入loHead 链表；为1则存入hiHead链表。
                //5. 上述过程将oldTable一个索引处的链表拆分为2条链表存入新的table中，一条在在oldTable相同索引位置上(e.hash的二进制对应位置为0)，一条存在相同索引 + 旧的table容量位置处。
                            next = e.next;
                            if ((e.hash & oldCap) == 0) { //e.hash 二进制对应容量位置为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;//一条链表挂在与旧table相同索引处
                        }
                        if (hiTail != null) {
                            hiTail.next = null;
                            newTab[j + oldCap] = hiHead;//另一条链表挂在了旧索引 + 旧容量 的新索引处。
                        }
                    }
                }
            }
        }
        return newTab;
    }

HashMap大致工作原理
第一步：通过 HashMap 自己提供的hash 算法算出当前 key 的hash 值
第二步：通过计算出的hash 值去调用 (n - 1) & hash "位运算 &"计算当前对象应该存储在数组的几号位置(也可以同求余 %算出位置，但是效率差)。
第三步：判断size 是否已经达到了当前阈值，如果没有，继续；如果已经达到阈值，则先进性数组扩容，将数组长度扩容为原来的2倍。
第四步：将当前对应的 hash，key，value封装成一个 Entry，去数组中查找当前位置有没有元素，如果没有，放在这个位置上；如果此位置上已经存在链表，那么遍历链表，如果链表上某个节点的 key 与当前key 进行 equals 比较后结果为 true，则把原来节点上的value 返回，将当前新的 value替换掉原来的value，如果遍历完链表，没有找到key 与当前 key equals为 true的，就把刚才封装的新的 Entry中next 指向当前链表的尾节点，也就是说当前节点现在在链表的最后一个位置(这是JAVA8情况，JAVA7情况相反，新的节点放置了头节点位置)。