[Java知识库]我对HashMap一无所知

我对HashMap一无所知

HashMap作为java常用集合之一，仅仅停留在只会用是远远不够的，整个源码读起来简直是不要太爽，直呼NB。

下面开启我们的一无所知系列——HashMap，笔者选取其中重要的几个方法来谈谈对HashMap的理解，食用之前请先知道HashMap的基本用法，以及HashMap的数据结构。

成员变量

部分成员变量如下：
//初始值，为16，必须为2的次幂
static final int DEFAULT_INITIAL_CAPACITY = 1 << 4;    
//当容量被占满0.75时就需要reSize扩容
static final float DEFAULT_LOAD_FACTOR = 0.75f;
//链表长度到8，就转为红黑树
static final int TREEIFY_THRESHOLD = 8;
// 树大小为6，就转回链表
static final int UNTREEIFY_THRESHOLD = 6;
//hash桶，用来存放数据节点
transient Node<K,V>[] table;
//扩容的具体阈值，达到这个值后会触发扩容 默认cap * 0.75取整
int threshold;
//阈值
final float loadFactor;

构造方法

拿最重要的构造方法来说明。

//需要一个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);
    }

get方法

public V get(Object key) {
        Node<K,V> e;
    	//调用下面的getNode方法来获取到具体的结点
        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;
        //如果当前的hash桶不为空，长度也不为0，且hash算法命中的结点也不为空，再进行下一步
        if ((tab = table) != null && (n = tab.length) > 0 &&
                (first = tab[(n - 1) & hash]) != null) {
            //将上面命中的结点进行匹配
            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)
                    //红黑树就调用红黑树的方法去获取到node
                    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);
            }
        }
        //所有流程都走完，说明hashmap中没有目标结点。
        return null;
    }

get方法相对来说简单一点，下面才是重头戏。

put方法

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

	//先不用管onlyIfAbsent 与 evict
    final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
                   boolean evict) {
        Node<K,V>[] tab; Node<K,V> p; int n, i;
        //如果hash桶为空或者长度为0，就进行扩容，这样做主要是考虑到第一次put进去的时候还没有扩容的问题
        if ((tab = table) == null || (n = tab.length) == 0)
            n = (tab = resize()).length;
        
        //扩容完成后，判断待插入的结点hash后在hash桶中的位置，如果命中的位置没有结点，就new一个直接插入
        if ((p = tab[i = (n - 1) & hash]) == null)
            tab[i] = newNode(hash, key, value, null);
        //很不幸的走到这，发现待插入的node命中的位置已经有node占用了，一气之下就开始它的插入之旅
        else {
            Node<K,V> e; K k;
            //还是出于性能考虑，首先对第一个节点进行比对，如果正好是我们的key所对应的结点，就将第一个节点取出来给e，这样e就不为空，后面再判断e==null，以此来判断hash桶中是否已经存在了key,如果有，我们只需要修改value即可
            if (p.hash == hash &&
                    ((k = p.key) == key || (key != null && key.equals(k))))
                e = p;
            //如果当前命中的hash处是一颗红黑树，就掉红黑树的put方法。
            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) {
                        //遍历完整个链表，没找到key，说明带插入的key是个新的，new一个节点插入。
                        p.next = newNode(hash, key, value, null);
                        //判断当前链表长度+1（插入一个节点）的值是否大于转成红黑树的值--8，决定是否将链表转为红黑树
                        if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
                            //转红黑树咯
                            treeifyBin(tab, hash);
                        break;
                    }
                    //如果找到了key，也是同上操作，将当前key的结点给e，后面再一起清算
                    if (e.hash == hash &&
                            ((k = e.key) == key || (key != null && key.equals(k))))
                        break;
                    
                    //这句就是p=p.next的意思
                    p = e;
                }
            }
            
            //到这，发现不仅位置被人占了，连key也已经有了，这时只需要想办法修改key对应的value即可
            if (e != null) { // existing mapping for key
                V oldValue = e.value;
                if (!onlyIfAbsent || oldValue == null)
                    e.value = value;
                afterNodeAccess(e);
                //将老的put的值给取出来，返回回去
                return oldValue;
            }
        }
        //给这个hashmap的修改次数+1
        ++modCount;
        //这里就很关键了，别看就两行，当前的hashmap的size+1后是否会触发扩容机制，如果是，就扩容，那么下次put的时候一定有足够的空间让你put
        if (++size > threshold)
            resize();
        afterNodeInsertion(evict);
        return null;
    }

至此，put的方法就讲完了，里面设计到红黑树的操作自动被过滤掉啦，是不是读起来很轻松呢，哈哈哈。

resize方法

这个方法也比较难，也是hashmap的核心方法。

final Node<K,V>[] resize() {
        Node<K,V>[] oldTab = table;
        //判断hashmap是否为空
        int oldCap = (oldTab == null) ? 0 : oldTab.length;
        int oldThr = threshold;
        int newCap, newThr = 0;
        if (oldCap > 0) {
            //如果老的hashmap已经很大了，就无法再扩容，直接返回
            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
        }
        //如果hashmap的初始容量=0，就将扩容后的容量设为旧的阈值
        else if (oldThr > 0) // initial capacity was placed in threshold
            newCap = oldThr;
        //使用默认值扩容
        else {               // zero initial threshold signifies using defaults
            newCap = DEFAULT_INITIAL_CAPACITY;
            newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
        }

        //如果新的阈值仍然为0，就要设置阈值为 容量*0.75
        if (newThr == 0) {
            float ft = (float)newCap * loadFactor;
            newThr = (newCap < MAXIMUM_CAPACITY && ft < (float)MAXIMUM_CAPACITY ?
                    (int)ft : Integer.MAX_VALUE);
        }
        threshold = newThr;
        //--------------------至此确定好了扩容需要的新属性---------------

        //---------下面开始将原hashmap的结点转到新的hashmap中-----------
        @SuppressWarnings({"rawtypes","unchecked"})
        Node<K,V>[] newTab = (Node<K,V>[])new Node[newCap];//创建出新容量的一个node数组
        table = newTab;
        if (oldTab != null) {
            //hashmap是 数组 + 链表 + 红黑树结构，遍历整个hashmap需要分类别、分层次遍历
            for (int j = 0; j < oldCap; ++j) {
                Node<K,V> e;
                //依次取出oldTab中的元素
                if ((e = oldTab[j]) != null) {
                    //释放掉旧结点
                    oldTab[j] = null;
                    //说明这个节点下面没有链其他节点
                    if (e.next == null)
                        //rehash
                        newTab[e.hash & (newCap - 1)] = e;
                    //节点下有其他节点： 情况1：是一个红黑树结构 情况2：是一个链表。    两种情况互斥
                    else if (e instanceof TreeNode)
                        //调用红黑树的split方法来完成rehash
                        ((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;
                        //下面这一系列骚操作，是将链表移到新的hashmap中去
                        do {
                            /*
                             *原索引重新hash后不变，啥意思，细心的同学注意到了这里没有用oldcap-1，而是用的oldcap，下面说明原因：
                             *假设有两个节点，hash值分别为 1010、0010，oldCap为1000 
                             * rehash后的位置是 e.hash & newCap -1 我们来算一遍
                             *   1010   假如为  0010
                             *  &1111          1111
                             *   1010          0010 原地不动
                             * 
                             * 之前的hash位置为
                             *  1010
                             * &0111
                             *  0010
                             * 
                             * 举个例子，e.hash值为      1010              假如为 0010
                             * oldCap的值为            1000                    1000
                             * &以后的值为              1000, 移动到新地方        0000 = 0 保留在原地
                             *
                             * 可以看出决定rehash的位置的是e.hash中的第四位数，这就是对链表rehash的优化，链表中的一部分值，会在原地保留不动
                             * 另一部分值会被rehash到 oldposition + oldCap处
                             */
                            next = e.next;
                            //看懂上面的rehash规律以后，就明白为什么设置两个头指针两个尾指针了吧。
                            if ((e.hash & oldCap) == 0) {
                                //将rehash后不动的值，放在一个链表中
                                if (loTail == null)
                                    loHead = e;
                                else
                                    loTail.next = e;
                                loTail = e;
                            }
                            else {
                                //另一个链表用来存放rehash后会移动的结点
                                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;
    }

边边角角

tableSizeFor很有意思，他会根据你传入的cap值，找到与cap最接近的2的N次幂。

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

同样的操作在concurrenthashmap中也有，不过我觉得大哥李写的比较好，容易懂

        int sshift = 0;
        int ssize = 1;
        while (ssize < DEFAULT_CONCURRENCY_LEVEL) {
            ++sshift;
            ssize <<= 1;
        }
       

总结

hashMap源码经典设计部分还有很多，笔者也是囫囵吞枣，粒度没有很细，里面涉及到红黑树的操作，都被我封装起来了，哈哈哈，留给以后再锤咯只有。