一文了解HashMap源码

一、HashMap 存储结构

　　HashMap是数组+链表+红黑树（JDK1.8增加了红黑树部分）实现的，如下图所示：

先看下Node<K,V> 类用来实现数组及链表的数据结构,主要有以下成员变量，

final int hash;  //保存节点的 hash　值
final K key;     //保存节点的　key　值
V value;　       //保存节点的　value 值
Node<K,V> next;　//指向链表结构下的当前节点的　next 节点
 

还有类TreeNode<K,V> 继承 LinkedHashMap.Entry<K,V>，用来实现红黑树相关的存储结构

TreeNode<K,V> parent;  // 存储当前节点的父节点
TreeNode<K,V> left;　//存储当前节点的左孩子
TreeNode<K,V> right;　//存储当前节点的右孩子
TreeNode<K,V> prev;    // 存储当前节点的前一个节点
boolean red;　// 存储当前节点的颜色（红、黑）

在JDK1.8中加入了红黑树是为了防止哈希表碰撞攻击，当链表链长度为8时，及时转成红黑树，提高map的效率。

二、HashMap 各常量、成员变量作用

//创建 HashMap 时未指定初始容量情况下的默认容量   
static final int DEFAULT_INITIAL_CAPACITY = 1 << 4; 
//HashMap 的最大容量
static final int MAXIMUM_CAPACITY = 1 << 30;
//HashMap 默认的装载因子,当 HashMap 中元素数量超过 容量*装载因子 时，进行　resize()　操作
static final float DEFAULT_LOAD_FACTOR = 0.75f;
//用来确定何时将解决 hash 冲突的链表转变为红黑树
static final int TREEIFY_THRESHOLD = 8;
// 用来确定何时将解决 hash 冲突的红黑树转变为链表
static final int UNTREEIFY_THRESHOLD = 6;
/* 当需要将解决 hash 冲突的链表转变为红黑树时，需要判断下此时数组容量，若是由于数组容量太小（小于　MIN_TREEIFY_CAPACITY　）导致的 hash 冲突太多，则不进行链表转变为红黑树操作，转为利用　resize() 函数对　hashMap 扩容　*/
static final int MIN_TREEIFY_CAPACITY = 64;

//保存Node<K,V>节点的数组
transient Node<K,V>[] table;
//由　hashMap 中 Node<K,V>　节点构成的 set
transient Set<Map.Entry<K,V>> entrySet;
//记录 hashMap 当前存储的元素的数量
transient int size;
//记录　hashMap 发生结构性变化的次数（注意　value 的覆盖不属于结构性变化）
transient int modCount;
//threshold的值应等于 table.length * loadFactor, size 超过这个值时进行　resize()扩容
int threshold;
//记录 hashMap 装载因子
final float loadFactor;

三、HashMap 几种构造方法

// 构造方法１，指定初始容量及装载因子
public HashMap(int var1, float var2) {
        if (var1 < 0) {
            throw new IllegalArgumentException("Illegal initial capacity: " + var1);
        } else {
            if (var1 > 1073741824) {
                var1 = 1073741824;
            }

            if (var2 > 0.0F && !Float.isNaN(var2)) {
                this.loadFactor = var2;
                /* tableSizeFor(initialCapacity)　方法返回的值是最接近 initialCapacity 的2的        
                   幂，若指定初始容量为９，则实际 hashMap 容量为16
                   注意此种方法创建的 hashMap 初始容量的值存在　threshold 中
                */
                this.threshold = tableSizeFor(var1);
            } else {
                throw new IllegalArgumentException("Illegal load factor: " + var2);
            }
        }
}

//tableSizeFor(initialCapacity)　方法返回的值是最接近 initialCapacity 的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;
}

四、HashMap put 及其相关方法

1. put() 方法

//指定节点 key,value，向 hashMap 中插入节点
public V put(K var1, V var2) {
    //注意待插入节点　hash 值的计算，调用了　hash(key) 函数
    //实际调用 putVal（）进行节点的插入
    return this.putVal(hash(var1), var1, var2, false, true);
}

/* key 的 hash　值的计算是通过hashCode()的高16位异或低16位实现的，主要是从速度、功效、质量来考虑的，这么做可以在数组table的length比较小的时候，也能保证考虑到高低Bit都参与到Hash的计算中，同时不会有太大的开销 */
static final int hash(Object var0) {
        int var1;
        return var0 == null ? 0 : (var1 = var0.hashCode()) ^ var1 >>> 16;
}

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;
 　　 /*根据 hash 值确定节点在数组中的插入位置，若此位置没有元素则进行插入，注意确定插入位置所用的计算方法为　(n - 1) & hash,由于　n 一定是２的幂次，这个操作相当于hash % n */
         if ((p = tab[i = (n - 1) & hash]) == null)
             tab[i] = newNode(hash, key, value, null);
         else {//说明待插入位置存在元素
             Node<K,V> e; K k;
 　　　 　　　　//比较原来元素与待插入元素的　hash 值和　key 值
             if (p.hash == hash &&
                 ((k = p.key) == key || (key != null && key.equals(k))))
                 e = p;
 　　　 　　　　//若原来元素是红黑树节点，调用红黑树的插入方法:putTreeVal
             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) {
 　　　　　　　//找到插入位置后，新建节点插入
                         p.next = newNode(hash, key, value, null);
 　　　　　　　//若链表上节点超过TREEIFY_THRESHOLD - 1，将链表变为红黑树
                         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;
                 }
             }//end else
             if (e != null) { // 待插入元素在　hashMap 中已存在
                 V oldValue = e.value;
                 if (!onlyIfAbsent || oldValue == null)
                     e.value = value;
                 afterNodeAccess(e);
                 return oldValue;
             }
         }//end else
         ++modCount;
         if (++size > threshold)
             resize();
         afterNodeInsertion(evict);
         return null;
}

其中putTreeVal()方法重点看一下

/*读懂这个函数要注意理解 hash 冲突发生的几种情况
           １、两节点　key 值相同（hash值一定相同），导致冲突
           ２、两节点　key 值不同，由于 hash 函数的局限性导致hash 值相同，冲突
  　　 　　 ３、两节点　key 值不同，hash 值不同，但 hash 值对数组长度取模后相同，冲突
*/
       final TreeNode<K,V> putTreeVal(HashMap<K,V> map, Node<K,V>[] tab,int h, K k, V v) {                      
             Class<?> kc = null;
             boolean searched = false;
             TreeNode<K,V> root = (parent != null) ? root() : this;
 　　　　　　　 //从根节点开始查找合适的插入位置（与二叉搜索树查找过程相同）
             for (TreeNode<K,V> p = root;;) {
                 int dir, ph; K pk;
                 if ((ph = p.hash) > h)
                     dir = -1;　//　dir小于０，接下来查找当前节点左孩子
                 else if (ph < h)
                     dir = 1;　//　dir大于０，接下来查找当前节点右孩子
                 else if ((pk = p.key) == k || (pk != null && k.equals(pk)))
 　　　　　　　　　　　　//进入这个else if 代表　hash 值相同，key　相同
                     return p;
 　　　　 　　　　 /*要进入下面这个else if,代表有以下几个含义:
                   1、当前节点与待插入节点　key　不同,　hash 值相同
     　　　　　　　　2、ｋ是不可比较的，即ｋ并未实现　comparable<K>　接口
　　　　　　　　　　　　　　（若 k 实现了comparable<K>　接口，comparableClassFor（k）返回的是ｋ的　class,而不是　null）或者　compareComparables(kc, k, pk)　返回值为 0
　　　　　　　　　　　　　　(pk 为空　或者　按照 k.compareTo(pk) 返回值为０，
　　　　　　　　　　　　　　返回值为０可能是由于　ｋ的compareTo 方法实现不当引起的，compareTo 判定相等，而上个 else if　中　equals 判定不等)*/
                 else if ((kc == null &&
                           (kc = comparableClassFor(k)) == null) ||
                          (dir = compareComparables(kc, k, pk)) == 0) {
                     //在以当前节点为根的整个树上搜索是否存在待插入节点（只会搜索一次）
                     if (!searched) {
                         TreeNode<K,V> q, ch;
                         searched = true;
                         if (((ch = p.left) != null &&
                              (q = ch.find(h, k, kc)) != null) ||
                             ((ch = p.right) != null &&
                              (q = ch.find(h, k, kc)) != null))
 　　　　　　　　　　　　　　　　　//若树中存在待插入节点，直接返回
                             return q;
                     }
 　　　　　 　　　　　　 // 既然ｋ是不可比较的，那我自己指定一个比较方式
                     dir = tieBreakOrder(k, pk);
                 }//end else if
 
                 TreeNode<K,V> xp = p;
                 if ((p = (dir <= 0) ? p.left : p.right) == null) {
 　　　　　　　　　　　　//找到了待插入的位置，xp 为待插入节点的父节点
 　　　　　　　　　　　　//注意TreeNode节点中既存在树状关系，也存在链式关系，并且是双端链表
                     Node<K,V> xpn = xp.next;
                     TreeNode<K,V> x = map.newTreeNode(h, k, v, xpn);
                     if (dir <= 0)
                         xp.left = x;
                     else
                         xp.right = x;
                     xp.next = x;
                     x.parent = x.prev = xp;
                     if (xpn != null)
                         ((TreeNode<K,V>)xpn).prev = x;
 　　　　　　　　　　　　//插入节点后进行二叉树的平衡操作
                     moveRootToFront(tab, balanceInsertion(root, x));
                     return null;
                 }
             }
         }
 　
 　　
 　　 　　static int tieBreakOrder(Object a, Object b) {
             int d;
             //System.identityHashCode()实际是利用对象 a,b 的内存地址进行比较
             if (a == null || b == null ||
                 (d = a.getClass().getName().
                  compareTo(b.getClass().getName())) == 0)
                 d = (System.identityHashCode(a) <= System.identityHashCode(b) ?
                      -1 : 1);
             return d;
         }

2. putAll() 方法

public void putAll(Map<? extends K, ? extends V> m) {
         putMapEntries(m, true);
     }
 　
/*把Map<? extends K, ? extends V> m 中的元素插入到　hashMap 中,若 evict 为 false,代表是在创建 hashMap 时调用了这个函数，例如利用上述构造函数３创建 hashMap;若 evict　为true,代表是在创建　hashMap 后才调用这个函数，例如上述的　putAll 函数。*/
final void putMapEntries(Map<? extends K, ? extends V> m, boolean evict) {
         int s = m.size();
         if (s > 0) {
             /*如果是在创建 hashMap 时调用的这个函数则 table 一定为空*/
             if (table == null) { 
 　　　　  //根据待插入的map 的 size 计算要创建的　hashMap 的容量。
                 float ft = ((float)s / loadFactor) + 1.0F;
                 int t = ((ft < (float)MAXIMUM_CAPACITY) ?
                          (int)ft : MAXIMUM_CAPACITY);
 　　　　  //把要创建的　hashMap 的容量存在　threshold　中
                 if (t > threshold)
                     threshold = tableSizeFor(t);
             }
 　　　 //判断待插入的　map 的 size,若　size 大于　threshold，则先进行　resize()
             else if (s > threshold)
                 resize();
             for (Map.Entry<? extends K, ? extends V> e : m.entrySet()) {
                 K key = e.getKey();
                 V value = e.getValue();
                 //实际也是调用　putVal　函数进行元素的插入
                 putVal(hash(key), key, value, false, evict);
             }
         }
}

五、HashMap get 及其相关方法

1. get()方法

public V get(Object var1) {
        HashMap.Node var2;
        //实际上是根据输入节点的 hash 值和 key 值利用getNode 方法进行查找
        return (var2 = this.getNode(hash(var1), var1)) == null ? null : var2.value;
}

final HashMap.Node<K, V> getNode(int var1, Object var2) {
        HashMap.Node[] var3;
        HashMap.Node var4;
        int var6;
        if ((var3 = this.table) != null && (var6 = var3.length) > 0 && (var4 = var3[var6 - 1 & var1]) != null) {
            Object var7;
            if (var4.hash == var1 && ((var7 = var4.key) == var2 || var2 != null && var2.equals(var7))) {
                return var4;
            }

            HashMap.Node var5;
            if ((var5 = var4.next) != null) {
                //若定位到的节点是　TreeNode 节点，则在树中进行查找
                if (var4 instanceof HashMap.TreeNode) {
                    return ((HashMap.TreeNode)var4).getTreeNode(var1, var2);
                }
                //否则在链表中进行查找
                do {
                    if (var5.hash == var1 && ((var7 = var5.key) == var2 || var2 != null && var2.equals(var7))) {
                        return var5;
                    }
                } while((var5 = var5.next) != null);
            }
        }

        return null;
}

2. get方法中的getTreeNode()方法

    final TreeNode<K,V> getTreeNode(int h, Object k) {
  　　　　　　　　//从根节点开始，调用 find 方法进行查找
              return ((parent != null) ? root() : this).find(h, k, null);
    }
  　
    final TreeNode<K,V> find(int h, Object k, Class<?> kc) {
              TreeNode<K,V> p = this;
              do {                  int ph, dir; K pk;
                 TreeNode<K,V> pl = p.left, pr = p.right, q;
 　　　　　　　　　//首先进行hash 值的比较，若不同令当前节点变为它的左孩子或者右孩子
                 if ((ph = p.hash) > h)
                     p = pl;
                 else if (ph < h)
                     p = pr;
 　　　　　　　　　//hash 值相同，进行 key　值的比较 
                 else if ((pk = p.key) == k || (k != null && k.equals(pk)))
                     return p;
                 else if (pl == null)
                     p = pr;
                 else if (pr == null)
                     p = pl;
 　　　　　　　　　//执行到这儿，意味着hash 值相同，key 值不同 
    　　　　　　　　//若k 是可比较的并且k.compareTo(pk) 返回结果不为０可进入下面elseif   
                 else if ((kc != null ||
                           (kc = comparableClassFor(k)) != null) &&
                          (dir = compareComparables(kc, k, pk)) != 0)
                     p = (dir < 0) ? pl : pr;
                 /*若 k 是不可比较的　或者　k.compareTo(pk) 返回结果为０则在整棵树中进行查找，先找右子树，右子树没有再找左子树*/
                 else if ((q = pr.find(h, k, kc)) != null)
                     return q;
                 else
                     p = pl;
             } while (p != null);
             return null;
    }

七、HashMap 扩容方法　resize()

       resize()方法中比较重要的是链表和红黑树的 rehash 操作，先来说下 rehash 的实现原理：

　　我们在扩容的时候，一般是把长度扩为原来2倍，所以，元素的位置要么是在原位置，要么是在原位置再移动2次幂的位置。

看下图可以明白这句话的意思，n为table的长度，图（a）表示扩容前的key1和key2两种key确定索引位置的示例，图（b）表示扩容后key1和key2两种key确定索引位置的示例，其中hash1是key1对应的哈希与高位运算结果。

元素在重新计算hash之后，因为n变为2倍，那么n-1的mask范围在高位多1bit(红色)，因此新的index就会发生这样的变化：

因此，我们在扩充HashMap的时候，只需要看看原来的hash值新增的那个bit是1还是0就好了，是0的话索引没变，是1的话索引变成“原索引+oldCap”，可以看看下图为16扩充为32的resize示意图：

这个算法很巧妙，既省去了重新计算hash值的时间，而且同时，由于新增的1bit是0还是1可以认为是随机的，因此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;
　　/*
        1、resize（）函数在size　> threshold时被调用。
            oldCap大于 0 代表原来的 table 表非空， oldCap 为原表的大小，
            oldThr（threshold） 为 oldCap × load_factor
    　*/
        if (oldCap > 0) {
            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
        }
　　　　/*
        2、resize（）函数在table为空被调用。
        oldCap 小于等于 0 且 oldThr 大于0，代表用户创建了一个 HashMap，但是使用的构造函数为
        HashMap(int initialCapacity, float loadFactor) 或 HashMap(int initialCapacity)
        或 HashMap(Map<? extends K, ? extends V> m)，导致 oldTab 为 null，oldCap 为0，
        oldThr 为用户指定的 HashMap的初始容量。
    　　*/
        else if (oldThr > 0) // initial capacity was placed in threshold
            newCap = oldThr;
　　　　　/*
            3、resize（）函数在table为空被调用。
            oldCap 小于等于 0 且 oldThr 等于0，用户调用 HashMap()构造函数创建的　HashMap，所有值均采用默认值，
       　　 oldTab（Table）表为空，oldCap为0，oldThr等于0，
    　　*/
        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;        
        Node<K,V>[] newTab = (Node<K,V>[])new Node[newCap];
        table = newTab;
        if (oldTab != null) {
　　　　　　　//把　oldTab 中的节点　reHash 到　newTab 中去
            for (int j = 0; j < oldCap; ++j) {
                Node<K,V> e;
                if ((e = oldTab[j]) != null) {
                    oldTab[j] = null;
　　　　　　　　　　　　//若节点是单个节点，直接在 newTab　中进行重定位
                    if (e.next == null)
                        newTab[e.hash & (newCap - 1)] = e;
　　　　　　　　　　　　//若节点是　TreeNode 节点，要进行 红黑树的 rehash　操作
                    else if (e instanceof TreeNode)
                        ((TreeNode<K,V>)e).split(this, newTab, j, oldCap);
　　　　　　　　　　　　//若是链表，进行链表的 rehash　操作
                    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;
　　　　　　　　　　　　　　　　　　//根据算法　e.hash & oldCap　判断节点位置　rehash　后是否发生改变
                            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;
　　　　　　　　　　　　　　　　// rehash　后节点新的位置一定为原来基础上加上　oldCap
                            newTab[j + oldCap] = hiHead;
                        }
                    }
                }
            }
        }
        return newTab;
    }

PS：

1. Hashmap为什么大小是2的幂次？ 

因为在计算元素该存放的位置的时候，用到的算法是将元素的hashcode与当前map长度-1进行与运算。

static int indexFor(int h, int length) {
    return h & (length-1);
}

如果map长度为2的幂次，那长度-1的二进制一定为11111...这种形式，进行与运算就看元素的hashcode，但是如果map的长度不是2的幂次，比如为15，那长度-1就是14，二进制为1110，无论与谁相与最后一位一定是0，0001，0011，0101，1001，1011，0111，1101这几个位置就永远都不能存放元素了，空间浪费相当大。也增加了添加元素是发生碰撞的机会。减慢了查询效率。所以Hashmap的大小是2的幂次。
2. 总览图