「集合底层」深入浅出HashMap底层源码

「集合底层」深入浅出HashMap底层源码

一、HashMap介绍

HashMap底层采用了哈希表，而哈希表是由数组和链表实现的。数组和链表各有自己的特点：

数组：占用空间连续。 寻址容易，查询速度快。但是，增加和删除效率非常低。
链表：占用空间不连续。 寻址困难，查询速度慢。但是，增加和删除效率非常高。
所以HashMap既有数组的优点也有链表的优点（即查询快，增删效率也高）。
在哈希表中，当数组长度小于64，或数组上存储的节点个数小于等于8时数组上的链表是单链表的形式。
当数组长度达到了64或以上，且数组上存储的节点个数大于8时，则会数组上的单链表会转化为红黑树。

---

二、成员变量

 	/**
     * 默认初始化容量为16，并且必须为2的次幂
     */
    static final int DEFAULT_INITIAL_CAPACITY = 1 << 4; // 2^4 = 16

    /**
     *最大容量，如果任意一个带有参数的构造函数隐式指定更高的值，则使用该最大容量。 
     *必须是两个<= 1 << 30的幂。
     */
    static final int MAXIMUM_CAPACITY = 1 << 30;

    /**
     * 在构造函数中未指定时使用的负载系数，默认是0.75.就是当你数组的长度达到这个系数乘积值时，数组就开始扩容
     */
    static final float DEFAULT_LOAD_FACTOR = 0.75f;

    /**
     * 列表转化为红黑树的阈值（临界值）
     */
    static final int TREEIFY_THRESHOLD = 8;

    /**
     * 红黑树转化为链表的阈值
     */
    static final int UNTREEIFY_THRESHOLD = 6;

    /**
     * 当单个数组所指链表长度大于8，要转化为红黑树数组长度的阈值
     */
    static final int MIN_TREEIFY_CAPACITY = 64;
	
		/**
		* 记录map中键值对的数量的值
		 */ 
		transient int size;

		 /**
     * 存放链表或者红黑树的数组
     */
    transient Node<K,V>[] table;

熟悉以上成员变量的基本概念有助于对源代码的深入理解。

---

三、源码解析

1.构造方法

HashMap有四个构造方法

• public HashMap() 默认构造方法，默认初始容量为16，加载因子为0.75f
• public HashMap(int initialCapacity) 指定初始容量的构造方法，加载因子为默认的0.75f
• public HashMap(int initialCapacity, float loadFactor) 指定初始容量和默认加载因子的初始方法
• public HashMap(Map<? extends K, ? extends V> m) 以子map为入参，构造新的hashmap

扩容：threshold＝容量 * 加载因子。

无参构造

public HashMap() {
    // 使用默认初始容量构造一个空的HashMap(16)和默认负载因子(0.75)。
	this.loadFactor = DEFAULT_LOAD_FACTOR; 
}

单参数构造方法

// 其实与就是调用双参数构造方法，只不过这里的负载(加载)因子直接为默认值
public HashMap(int initialCapacity) {
	this(initialCapacity, DEFAULT_LOAD_FACTOR);
}

// 创建一个足够容量的集合，来存储m集合，其默认负载(加载)因子为0.75
public HashMap(Map<? extends K, ? extends V> m) {
    this.loadFactor = DEFAULT_LOAD_FACTOR;
    putMapEntries(m, false);
}

双参数构造方法

// 双参构造，initialCapacity：初始集合的容量，loadFactor ：负载因子
public HashMap(int initialCapacity, float loadFactor) {
    // 提高效率，判断传入的初始容量是否为正数，若小于0则抛出IllegalArgumentException异常
	if (initialCapacity < 0)
            throw new IllegalArgumentException("Illegal initial capacity: " + initialCapacity);
    
    // 判断初始容量是否大于，集合的最大设定容量，若为true，则初始容量等于最大容量
	if (initialCapacity > MAXIMUM_CAPACITY)
            initialCapacity = MAXIMUM_CAPACITY;
    
    // 校验负载（加载）因子是否为nan值或小于0的值，若是抛出IllegalArgumentException异常
	if (loadFactor <= 0 || Float.isNaN(loadFactor))
		throw new IllegalArgumentException("Illegal load factor: " + loadFactor);
    
    // 走到最后，初始化加载因子
	this.loadFactor = loadFactor;
    
    // 数组按initialCapacity调整容量的大小,该方法是用来保证每次扩容都是原来的2的倍数
	this.threshold = tableSizeFor(initialCapacity);
}

// 调整大小方法：返回给定目标容量的2次方大小。返回给定目标容量的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;
}

2.Node节点类

它是 HashMap 中的一个静态内部类，哈希表中的每一个节点都是 Node 类型。我们可以看到，Node 类中有 4 个属性，其中除了 key 和 value 之外，还有 hash 和 next 两个属性。hash 是用来存储 key 的哈希值的，next 是在构建链表时用来指向后继节点的。

static class Node<K,V> implements Map.Entry<K,V> {
    final int hash; // 用来存储key(键)的哈希值的
    final K key; // 键，final修饰，一旦赋值不再发生变化
    V value;	// 值，可以发生改变
    Node<K,V> next; // 指向下一个节点元素

    // 构造方法，创建节点对象，并初始化赋值
    // 因为有带参构造，所以无法用默认构造初始化Node节点对象
    Node(int hash, K key, V value, Node<K,V> next) {
        this.hash = hash;
        this.key = key;
        this.value = value;
        this.next = next;
    }

    // 获取节点的key键值
    public final K getKey()        { return key; }
    // 获取节点的value值
    public final V getValue()      { return value; }
    // 重写toString方法，键值对展示
    public final String toString() { return key + "=" + 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;
    }

    // 判断两个节点对象是否相同
    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;
    }
}

2.put方法

final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
               boolean evict) {
    //声明了一个局部变量 tab,局部变量 Node 类型的数据 p,int 类型 n,i
    Node<K,V>[] tab; Node<K,V> p; int n, i;
    //首先将当前 hashmap 中的 table(哈希表，存放链表或红黑树的数组)赋值给当前的局部变量 tab,然后判断tab 是不是空或者长度是不是 0,实际上就是判断当前 hashmap 中的哈希表是不是空或者长度等于 0
    if ((tab = table) == null || (n = tab.length) == 0)
        //如果是空的或者长度等于0,代表现在还没哈希表,所以需要创建新的哈希表,默认就是创建了一个长度为 16 的哈希表
        n = (tab = resize()).length;
    //将当前哈希表中与要插入的数据位置对应的数据取出来,(n - 1) & hash])就是找当前要插入的数据应该在哈希表中的位置,如果没找到,代表哈希表中当前的位置是空的,否则就代表找到数据了, 并赋值给变量 p
    if ((p = tab[i = (n - 1) & hash]) == null)
        tab[i] = newNode(hash, key, value, null);//创建一个新的数据,这个数据没有下一条,并将数据放到当前这个位置
    else {//代表要插入的数据所在的位置是有内容的
        //声明了一个节点 e, 一个 key k
        Node<K,V> e; K k;
        //  如果键的值以及节点 hash 等于链表中的第一个键值对节点时，说明key冲突，则将 e 指向该键值对
        if (p.hash == hash && //如果当前位置上的那个数据的 hash 和我们要插入的 hash 是一样,代表没有放错位置
                //如果当前这个数据的 key 和我们要放的 key 是一样的,实际操作应该是就替换值
                ((k = p.key) == key || (key != null && key.equals(k))))
            //将当前的节点赋值给局部变量 e
            e = p;
        else if (p instanceof TreeNode)//如果当前节点的 key 和要插入的 key 不一样,然后要判断当前节点是不是一个红黑色类型的节点
            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) // 重新计算当前链表的长度是不是超出了限制，默认TREEIFY_THRESHOLD为8
                        treeifyBin(tab, hash);//超出了之后就将当前链表转换为树,注意转换树的时候,如果当前数组的长度小于MIN_TREEIFY_CAPACITY(默认 64),会触发扩容
                    break;
                }
                //如果当前遍历到的数据和要插入的数据的 key 是一样,和上面之前的一样,赋值给变量 e,下面替换内容
                if (e.hash == hash &&
                        ((k = e.key) == key || (key != null && key.equals(k))))
                    break;
                p = e;
            }
        }
        if (e != null) { //判断要插入的键值对是否存在 HashMap中
            V oldValue = e.value;//将当前节点的值赋值给 oldvalue
            // onlyIfAbsent 表示是否仅在 oldValue 为 null 的情况下更新键值对的值
            if (!onlyIfAbsent || oldValue == null)
                e.value = value; //将当前要插入的 value 替换当前的节点里面值
            afterNodeAccess(e);
            return oldValue;
        }
    }
    ++modCount;//增加长度
    if (++size > threshold)
        resize();//如果当前的 hash表的长度已经超过了当前 hash 需要扩容的长度, 重新扩容,条件是 hashmap 中存放的数据超过了临界值(经过测试),而不是数组中被使用的下标
    afterNodeInsertion(evict);
    return null;
}

4.resize()方法

final Node<K,V>[] resize() {
    Node<K,V>[] oldTab = table;
    //这里的oldCap等于null对应了前面hashmap介绍时，put第一个元素resize的场景
    int oldCap = (oldTab == null) ? 0 : oldTab.length;
    int oldThr = threshold;
    int newCap, newThr = 0;
    // 1.老表的容量不为0，即老表不为空
    if (oldCap > 0) {
        // 1.1 判断老表的容量是否超过最大容量值：如果超过则将阈值设置为Integer.MAX_VALUE，并直接返回老表,
        // 此时oldCap * 2比Integer.MAX_VALUE大，因此无法进行重新分布，只是单纯的将阈值扩容到最大
        if (oldCap >= MAXIMUM_CAPACITY) {
            threshold = Integer.MAX_VALUE;
            return oldTab;
        }
        // 1.2 将newCap赋值为oldCap的2倍，如果newCap<最大容量并且oldCap>=16, 则将新阈值设置为原来的两倍
        else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
                 oldCap >= DEFAULT_INITIAL_CAPACITY)
            newThr = oldThr << 1; // double threshold
    }
    // 2.如果老表的容量为0, 老表的阈值大于0, 是因为初始容量被放入阈值，则将新表的容量设置为老表的阈值
    else if (oldThr > 0)
        newCap = oldThr;
    else {
        // 3.老表的容量为0, 老表的阈值为0，这种情况是没有传初始容量的new方法创建的空表，将阈值和容量设置为默认值
        newCap = DEFAULT_INITIAL_CAPACITY;
        newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
    }
    // 4.如果新表的阈值为0, 则通过新的容量*负载因子获得阈值
    if (newThr == 0) {
        float ft = (float)newCap * loadFactor;
        newThr = (newCap < MAXIMUM_CAPACITY && ft < (float)MAXIMUM_CAPACITY ?
                  (int)ft : Integer.MAX_VALUE);
    }
    // 5.将当前阈值设置为刚计算出来的新的阈值，定义新表，容量为刚计算出来的新容量，将table设置为新定义的表。
    threshold = newThr;
    @SuppressWarnings({"rawtypes","unchecked"})
    Node<K,V>[] newTab = (Node<K,V>[])new Node[newCap];
    table = newTab;
    // 6.如果老表不为空，则需遍历所有节点，将节点赋值给新表
    if (oldTab != null) {
        for (int j = 0; j < oldCap; ++j) {
            Node<K,V> e;
            if ((e = oldTab[j]) != null) {  // 将索引值为j的老表头节点赋值给e
                oldTab[j] = null; // 将老表的节点设置为空, 以便垃圾收集器回收空间
                // 7.如果e.next为空, 则代表老表的该位置只有1个节点，计算新表的索引位置, 直接将该节点放在该位置
                if (e.next == null)
                    newTab[e.hash & (newCap - 1)] = e;
                // 8.如果是红黑树节点，则进行红黑树的重hash分布(跟链表的hash分布基本相同)
                else if (e instanceof TreeNode)
                    ((TreeNode<K,V>)e).split(this, newTab, j, oldCap);
                else { // preserve order
                    // 9.如果是普通的链表节点，则进行普通的重hash分布
                    Node<K,V> loHead = null, loTail = null; // 存储索引位置为:“原索引位置”的节点
                    Node<K,V> hiHead = null, hiTail = null; // 存储索引位置为:“原索引位置+oldCap”的节点
                    Node<K,V> next;
                    do {
                        next = e.next;
                        // 9.1 如果e的hash值与老表的容量进行与运算为0,则扩容后的索引位置跟老表的索引位置一样
                        if ((e.hash & oldCap) == 0) {
                            if (loTail == null) // 如果loTail为空, 代表该节点为第一个节点
                                loHead = e; // 则将loHead赋值为第一个节点
                            else
                                loTail.next = e;    // 否则将节点添加在loTail后面
                            loTail = e; // 并将loTail赋值为新增的节点
                        }
                        // 9.2 如果e的hash值与老表的容量进行与运算为非0,则扩容后的索引位置为:老表的索引位置＋oldCap
                        else {
                            if (hiTail == null) // 如果hiTail为空, 代表该节点为第一个节点
                                hiHead = e; // 则将hiHead赋值为第一个节点
                            else
                                hiTail.next = e;    // 否则将节点添加在hiTail后面
                            hiTail = e; // 并将hiTail赋值为新增的节点
                        }
                    } while ((e = next) != null);
                    // 10.如果loTail不为空（说明老表的数据有分布到新表上“原索引位置”的节点），则将最后一个节点
                    // 的next设为空，并将新表上索引位置为“原索引位置”的节点设置为对应的头节点
                    if (loTail != null) {
                        loTail.next = null;
                        newTab[j] = loHead;
                    }
                    // 11.如果hiTail不为空（说明老表的数据有分布到新表上“原索引+oldCap位置”的节点），则将最后
                    // 一个节点的next设为空，并将新表上索引位置为“原索引+oldCap”的节点设置为对应的头节点
                    if (hiTail != null) {
                        hiTail.next = null;
                        newTab[j + oldCap] = hiHead;
                    }
                }
            }
        }
    }
    // 12.返回新表
    return newTab;
}

参考

hashMap底层源码浅析

HashMap 的底层源码分析