Java:HashMap源码分析-白红宇

引言

在平时需要用到键值对存储数据时,我们便会用到HashMap,这篇文章基于JDK1.8,参考前辈的文章,对HashMap进行一定的理解.

参考

HashMap之比于ArrayList和LinkedList,感觉源码复杂得多,由于才学疏浅,本文很大部分参考上面链接文章,因为注释写得很详细,有几个函数是照搬的,这里感谢原作者，以后功力足够,一定会写一篇自己的理解。

结构

实现了Map接口,对数据进行键值对操作

实现了Cloneable接口,可被进行浅拷贝

实现了Serializable接口,可被序列化

Node节点

static class Node
    
      implements Map.Entry
     
       {        final int hash; //hash值        final K key; //key        V value; //value        Node
      
        next;//下一个节点            Node(int hash, K key, V value, Node
       
         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; }        //计算节点的hashCode 将key的hashCode值和value的hashCode值异或得到        public final int hashCode() {            return Objects.hashCode(key) ^ Objects.hashCode(value);        }        //设置新的值,并返回旧的值        public final V setValue(V newValue) {            V oldValue = value;            value = newValue;            return oldValue;        }        //equals方法,两个节点的key和value都相同时返回true        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;        }    }复制代码

可以看到Node中保存了下一个节点的引用，是一个单链表结构.

构造函数

无参构造函数

//默认的初始容量为16static final int DEFAULT_INITIAL_CAPACITY = 1 << 4; // aka 16 //默认的加载因子为0.75static final float DEFAULT_LOAD_FACTOR = 0.75f;public HashMap() {//无参构造函数 使用默认的构造函数        this.loadFactor = DEFAULT_LOAD_FACTOR; // all other fields defaulted    }复制代码

带初始化容量参数的构造函数

public HashMap(int initialCapacity) {//内部调用了另一个构造函数        this(initialCapacity, DEFAULT_LOAD_FACTOR);    }复制代码

带初始化容量容量和加载因子的构造函数

static final int MAXIMUM_CAPACITY = 1 << 30;public HashMap(int initialCapacity, float loadFactor) {        if (initialCapacity < 0)//初始化容量不能小于0            throw new IllegalArgumentException("Illegal initial capacity: " +                                               initialCapacity);        if (initialCapacity > MAXIMUM_CAPACITY)//初始化容量不得大于最大容量            initialCapacity = MAXIMUM_CAPACITY;        if (loadFactor <= 0 || Float.isNaN(loadFactor)) //加载因子必须是不小于0的浮点数            throw new IllegalArgumentException("Illegal load factor: " +                                               loadFactor);        this.loadFactor = loadFactor;          //设置阈值为 >= initialCapacity 的2的n次方形式的值        this.threshold = tableSizeFor(initialCapacity);    }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;}复制代码

带Map类型参数的构造函数

public HashMap(Map
       m) {    this.loadFactor = DEFAULT_LOAD_FACTOR;    putMapEntries(m, false);}final void putMapEntries(Map
       m, boolean evict) {    int s = m.size(); //得到map的元素数量    if (s > 0) { //数量大于0        if (table == null) { // 如果表为空            float ft = ((float)s / loadFactor) + 1.0F; //根据数量计算出阈值            int t = ((ft < (float)MAXIMUM_CAPACITY) ?                      (int)ft : MAXIMUM_CAPACITY);            if (t > threshold) //如果阈值大于当前阈值 则重新计算阈值                threshold = tableSizeFor(t);        }        else if (s > threshold) //如果当前元素表不是空的，但是s的元素数量大于阈值，说明一定要扩容。            resize();        //遍历m依次加入 表中        for (Map.Entry
       e : m.entrySet()) {            K key = e.getKey();            V value = e.getValue();            putVal(hash(key), key, value, false, evict);        }    }}//resize()函数 比较重要的扩容函数final Node
      
       [] resize() {    //oldTab 为当前表的哈希桶    Node
       
        [] oldTab = table;    //当前哈希桶的容量 length    int oldCap = (oldTab == null) ? 0 : oldTab.length;    //当前的阈值    int oldThr = threshold;    //初始化新的容量和阈值为0    int newCap, newThr = 0;    //如果当前容量大于0    if (oldCap > 0) {        //如果当前容量已经到达上限        if (oldCap >= MAXIMUM_CAPACITY) {            //则设置阈值是2的31次方-1            threshold = Integer.MAX_VALUE;            //同时返回当前的哈希桶，不再扩容            return oldTab;        }//否则新的容量为旧的容量的两倍。         else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&                 oldCap >= DEFAULT_INITIAL_CAPACITY)//如果旧的容量大于等于默认初始容量16            //那么新的阈值也等于旧的阈值的两倍            newThr = oldThr << 1; // double threshold    }//如果当前表是空的，但是有阈值。代表是初始化时指定了容量、阈值的情况    else if (oldThr > 0) // initial capacity was placed in threshold        newCap = oldThr;//那么新表的容量就等于旧的阈值    else {}//如果当前表是空的，而且也没有阈值。代表是初始化时没有任何容量/阈值参数的情况               // zero initial threshold signifies using defaults        newCap = DEFAULT_INITIAL_CAPACITY;//此时新表的容量为默认的容量 16        newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);//新的阈值为默认容量16 * 默认加载因子0.75f = 12    }    if (newThr == 0) {//如果新的阈值是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
        
         [] newTab = (Node
         
          [])new Node[newCap];    //更新哈希桶引用    table = newTab;    //如果以前的哈希桶中有元素    //下面开始将当前哈希桶中的所有节点转移到新的哈希桶中    if (oldTab != null) {        //遍历老的哈希桶        for (int j = 0; j < oldCap; ++j) {            //取出当前的节点 e            Node
          
            e;            //如果当前桶中有元素,则将链表赋值给e            if ((e = oldTab[j]) != null) {                //将原哈希桶置空以便GC                oldTab[j] = null;                //如果当前链表中就一个元素，（没有发生哈希碰撞）                if (e.next == null)                    //直接将这个元素放置在新的哈希桶里。                    //注意这里取下标 是用 哈希值 与 桶的长度-1 。 由于桶的长度是2的n次方，这么做其实是等于 一个模运算。但是效率更高                    newTab[e.hash & (newCap - 1)] = e;                    //如果发生过哈希碰撞 ,而且是节点数超过8个，转化成了红黑树（暂且不谈 避免过于复杂， 后续专门研究一下红黑树）                else if (e instanceof TreeNode)                    ((TreeNode
           
            )e).split(this, newTab, j, oldCap); //如果发生过哈希碰撞，节点数小于8个。则要根据链表上每个节点的哈希值，依次放入新哈希桶对应下标位置。 else { // preserve order //因为扩容是容量翻倍，所以原链表上的每个节点，现在可能存放在原来的下标，即low位， 或者扩容后的下标，即high位。 high位= low位+原哈希桶容量 //低位链表的头结点、尾节点 Node
            
              loHead = null, loTail = null; //高位链表的头节点、尾节点 Node
             
               hiHead = null, hiTail = null; Node
              
                next;//临时节点 存放e的下一个节点 do { next = e.next; //这里又是一个利用位运算 代替常规运算的高效点： 利用哈希值 与 旧的容量，可以得到哈希值去模后，是大于等于oldCap还是小于oldCap，等于0代表小于oldCap，应该存放在低位，否则存放在高位 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); //将低位链表存放在原index处， if (loTail != null) { loTail.next = null; newTab[j] = loHead; } //将高位链表存放在新index处 if (hiTail != null) { hiTail.next = null; newTab[j + oldCap] = hiHead; } } } } } return newTab;}final V putVal(int hash, K key, V value, boolean onlyIfAbsent, boolean evict) { //tab存放 当前的哈希桶， p用作临时链表节点 Node
               
                [] tab; Node
                
                  p; int n, i; //如果当前哈希表是空的，代表是初始化 if ((tab = table) == null || (n = tab.length) == 0) //那么直接去扩容哈希表，并且将扩容后的哈希桶长度赋值给n n = (tab = resize()).length; //如果当前index的节点是空的，表示没有发生哈希碰撞。 直接构建一个新节点Node，挂载在index处即可。 //这里再啰嗦一下，index 是利用 哈希值 & 哈希桶的长度-1，替代模运算 if ((p = tab[i = (n - 1) & hash]) == null) tab[i] = newNode(hash, key, value, null); else {//否则 发生了哈希冲突。 //e Node
                 
                   e; K k; //如果哈希值相等，key也相等，则是覆盖value操作 if (p.hash == hash && ((k = p.key) == key || (key != null && key.equals(k)))) e = p;//将当前节点引用赋值给e else if (p instanceof TreeNode)//红黑树暂且不谈 e = ((TreeNode
                  
                   )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); //如果追加节点后，链表数量》=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; } } //如果e不是null，说明有需要覆盖的节点， if (e != null) { // existing mapping for key //则覆盖节点值，并返回原oldValue V oldValue = e.value; if (!onlyIfAbsent || oldValue == null) e.value = value; //这是一个空实现的函数，用作LinkedHashMap重写使用。 afterNodeAccess(e); return oldValue; } } //如果执行到了这里，说明插入了一个新的节点，所以会修改modCount，以及返回null。 //修改modCount ++modCount; //更新size，并判断是否需要扩容。 if (++size > threshold) resize(); //这是一个空实现的函数，用作LinkedHashMap重写使用。 afterNodeInsertion(evict); return null;}// Create a regular (non-tree) nodeNode
                   
                     newNode(int hash, K key, V value, Node
                    
                      next) { return new Node<>(hash, key, value, next);} // Callbacks to allow LinkedHashMap post-actionsvoid afterNodeAccess(Node
                     
                       p) { }void afterNodeInsertion(boolean evict) { }复制代码

总结：

运算尽量都用位运算代替，更高效。

对于扩容导致需要新建数组存放更多元素时，除了要将老数组中的元素迁移过来，也记得将老数组中的引用置null，以便GC

取下标是用 哈希值 与运算（桶的长度-1） i = (n - 1) & hash。

由于桶的长度是2的n次方，这么做其实是等于一个模运算。但是效率更高

扩容时，如果发生过哈希碰撞，节点数小于8个。则要根据链表上每个节点的哈希值，依次放入新哈希桶对应下标位置。

因为扩容是容量翻倍，所以原链表上的每个节点，现在可能存放在原来的下标，即low位，或者扩容后的下标，即high位。high位=low位+原哈希桶容量 利用哈希值与运算旧的容量，if ((e.hash & oldCap) == 0),可以得到哈希值去模后，是大于等于oldCap还是小于oldCap，等于0代表小于oldCap，应该存放在低位，否则存放在高位。这里又是一个利用位运算代替常规运算的高效点如果追加节点后，链表数量>=8，则转化为红黑树

插入节点操作时，有一些空实现的函数，用作LinkedHashMap重写使用。

增加元素(改动元素)

put(K key,V value)
```
public V put(K key, V value) {        return putVal(hash(key), key, value, false, true);    }    //搅动函数static final int hash(Object key) {    int h;    return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);}复制代码
```
key的hash值，并不仅仅只是key对象的hashCode()方法的返回值，还会经过扰动函数的扰动，以使hash值更加均衡。因为hashCode()是int类型，取值范围是40多亿，只要哈希函数映射的比较均匀松散，碰撞几率是很小的。但就算原本的hashCode()取得很好，每个key的hashCode()不同，但是由于HashMap的哈希桶的长度远比hash取值范围小，默认是16，所以当对hash值以桶的长度取余，以找到存放该key的桶的下标时，由于取余是通过与操作完成的，会忽略hash值的高位。因此只有hashCode()的低位参加运算，发生不同的hash值，但是得到的index相同的情况的几率会大大增加，这种情况称之为hash碰撞。即，碰撞率会增大。

扰动函数就是为了解决hash碰撞的。它会综合hash值 高位和低位的特征，并存放在低位，因此在与运算时，相当于高低位一起参与了运算，以减少hash碰撞的概率。（在JDK8之前，扰动函数会扰动四次，JDK8简化了这个操作）

删除元素

remove(Object key)

public V remove(Object key) {        Node
    
      e;        return (e = removeNode(hash(key), key, null, false, true)) == null ?            null : e.value;    }      final Node
     
       removeNode(int hash, Object key, Object value,                               boolean matchValue, boolean movable) {        // p 是待删除节点的前置节点        Node
      
       [] tab; Node
       
         p; int n, index;        //如果哈希表不为空，则根据hash值算出的index下 有节点的话。        if ((tab = table) != null && (n = tab.length) > 0 &&            (p = tab[index = (n - 1) & hash]) != null) {            //node是待删除节点            Node
        
          node = null, e; K k; V v;            //如果链表头的就是需要删除的节点            if (p.hash == hash &&                ((k = p.key) == key || (key != null && key.equals(k))))                node = p;//将待删除节点引用赋给node            else if ((e = p.next) != null) {//否则循环遍历 找到待删除节点，赋值给node                if (p instanceof TreeNode)                    node = ((TreeNode
         
          )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， 且 matchValue为false，或者值也相等 if (node != null && (!matchValue || (v = node.value) == value || (value != null && value.equals(v)))) { if (node instanceof TreeNode) ((TreeNode
          
           )node).removeTreeNode(this, tab, movable); else if (node == p)//如果node == p，说明是链表头是待删除节点 tab[index] = node.next; else//否则待删除节点在表中间 p.next = node.next; ++modCount;//修改modCount --size;//修改size afterNodeRemoval(node);//LinkedHashMap回调函数 return node; } } return null; }复制代码

查找元素

get()

public V get(Object key) {        Node
      
        e;        return (e = getNode(hash(key), key)) == null ? null : e.value;    }            //传入扰动后的哈希值 和 key 找到目标节点Nodefinal Node
       
         getNode(int hash, Object key) {    Node
        
         [] tab; Node
         
           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
          
           )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;}复制代码

判断是否包含某value

containsValue(Object value)

public boolean containsValue(Object value) {        Node
      
       [] tab; V v;        //遍历哈希桶上的每一个链表        if ((tab = table) != null && size > 0) {            for (int i = 0; i < tab.length; ++i) {                for (Node
       
         e = tab[i]; e != null; e = e.next) {                    //如果找到value一致的返回true                    if ((v = e.value) == value ||                        (value != null && value.equals(v)))                        return true;                }            }        }        return false;    }复制代码

总结

HashMap采用数组加链表的数据结构存储数据.

当元素的数量超过阈值，HashMap扩容,扩容数量为2的n次方

允许key为null,value为null

线程不安全,如果需要并发工作使用ConcurrentHashMap