HashMap 源码阅读笔记

注：阅读的源码版本为 Java 8

HashMap 和 HashTable 的区别

• HashMap 是线程不安全的。
• HashMap 允许 value 和 key 为 null。

HashMap 的继承关系

从关系图可以看出 HashMap 继承了 AbstractMap 类，实现了 Map、Cloneable 和 Serializable 接口。

HashMap 的属性

HashMap 有两个影响性能的参数：初始容量（initial capacity）和负载系数（load factor）。容量（capacity）是哈希表中桶的数量，初始容量是哈希表创建时的容量。负载系数是哈希表在容量自动增加之前允许达到的饱满度的度量。当哈希表中的条目数超过负载因子和当前容量的乘积时，哈希表被重新散列（rehash），使得哈希表具有大约两倍的桶数。

一般来说，默认负载系数（0. 75）在时间和空间成本之间提供了一个很好的折衷。较高的负载系数会减少空间开销，但会增加查找成本（反映在 HashMap 类的大多数操作中，包括 get 和 put ）。在设置其初始容量时，应考虑映射中的预期条目数及其负载系数，以便最大限度地减少重新散列操作的次数。如果初始容量大于最大条目数除以负载系数，则不会发生再散列操作。

TREEIFY_THRESHOLD：当一个桶中的链表大小超过该阈值时，该链表会被改造为树形结构。

table：数组被分为一个个桶，数组中的元素是链表。

entrySet：存储 entrySet() 的缓存。

size：HashMap 中键值对的数目。

threshold：需要扩容的下一个 size 值（capacity * load factor）。

modCount：当前 HashMap 修改的次数，这个变量用来保证 fail-fast 机制。

HashMap 方法

#### hash(Object key)

static final int hash(Object key) {
    int h;
    return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
}

HashMap 中计算 hash 值的方法。保留原始 hashCode 的高 16 位不变，将低 16 位与高 16 位进行异或运算。这样做是因为 table 的长度通常为 2 的幂，此时只有 hashCode 的低位是有效位，容易发生碰撞，为了将高位信息利用起来，就使用了上述的异或运算。

get(Object key)

public V get(Object key) {
    Node<K,V> e;
    return (e = getNode(hash(key), key)) == null ? null : e.value;
}

返回 key 所对应的 value。注意返回值为 null 不一定表明该 key 不存在，也可能该 key 对应的 value 就是 null，这两种情况可通过 containsKey() 方法来区分。

getNode(int hash, Object key)

final Node<K,V> getNode(int hash, Object key) {
    Node<K,V>[] tab; Node<K,V> first, e; int n; K k;
    // table 不为空且 talbe 长度大于 0 且 table[hash % length] 不为空
    if ((tab = table) != null && (n = tab.length) > 0 &&
        (first = tab[(n - 1) & hash]) != null) {
        // 检查链表头结点
        if (first.hash == hash && // always check first node
            // key 为对象引用，先比较 key 和 k 是否指向同一个对象，再判断值是否相等
            ((k = first.key) == key || (key != null && key.equals(k))))
            return first;
        // 检查之后的结点
        if ((e = first.next) != null) {
            // 如果链表已被改造为树形结构则调用 getTreeNode(hash, key)
            if (first instanceof TreeNode)
                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);
        }
    }
    return null;
}

注意代码中使用 (n - 1) & hash 来代替 hash % n，位运算速度更快。

containsKey(Object key)

public boolean containsKey(Object key) {
    return getNode(hash(key), key) != null;
}

map 中包含特定的 key 则返回 true，否则返回 false。注意，如果该 key 对应的 value 为 null，会返回 true，因为 getNode 返回的是结点，此时结点不为 null，但是结点的 value 属性为 null。

put(K key, V value)

public V put(K key, V value) {
    return putVal(hash(key), key, value, false, true);
}

如果该 key 已经在 map 中存在，返回其之前对应的 value；如果该 key 之前不存在则返回 null。

putVal(int hash, K key, V value, boolean onlyIfAbsent, boolean 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;
    // 如果 table 为空或长度为 0，就对 table 进行初始化
    if ((tab = table) == null || (n = tab.length) == 0)
        n = (tab = resize()).length;
    // table[hash % length] 为空，即该 key 对应的桶是空的，直接创建一个结点即可
    if ((p = tab[i = (n - 1) & hash]) == null)
        tab[i] = newNode(hash, key, value, null);
    // 该 key 对应的桶不是空的，发生了碰撞
    else {
        Node<K,V> e; K k;
        // 链表头结点就是该 key 对应的结点，直接令 e 指向该结点
        if (p.hash == hash &&
            ((k = p.key) == key || (key != null && key.equals(k))))
            e = p;
        // 如果链表已被改造为树形结构则调用 putTreeVal(this, tab, hash, key, value)
        else if (p instanceof TreeNode)
            e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
        // 仍是链表结构
        else {
            for (int binCount = 0; ; ++binCount) {
                // 该 key 对应的结点不存在，创建新的结点
                if ((e = p.next) == null) {
                    p.next = newNode(hash, key, value, null);
                    // 链表中的结点个数大于阈值，对链表进行树化
                    if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
                        treeifyBin(tab, hash);
                    break;
                }
                // 链表中存在 key 对应的结点
                if (e.hash == hash &&
                    ((k = e.key) == key || (key != null && key.equals(k))))
                    break;
                p = e;
            }
        }
        // 存在 key 的映射
        if (e != null) { // existing mapping for key
            V oldValue = e.value;
            // onlyIfAbsent 为假或原始 value 为 null，用新的 value 替换原始 value
            if (!onlyIfAbsent || oldValue == null)
                e.value = value;
            afterNodeAccess(e);
            return oldValue;
        }
    }
    // 不存在 key 的映射
    ++modCount;
    // 加入新的结点后 size 超过了阈值，进行扩容
    if (++size > threshold)
        resize();
    afterNodeInsertion(evict);
    return null;
}

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;
    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
    }
    // 原始容量为 0，但原始阈值大于 0，用原始阈值初始化
    else if (oldThr > 0) // initial capacity was placed in threshold
        newCap = oldThr;
    // 原始容量为 0，原始阈值也为 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;
    @SuppressWarnings({"rawtypes","unchecked"})
    Node<K,V>[] newTab = (Node<K,V>[])new Node[newCap];
    table = newTab;
    // 原始 table 不为空，把每个节点都移动到新的桶中
    if (oldTab != null) {
        for (int j = 0; j < oldCap; ++j) {
            Node<K,V> e;
            // 该桶的头结点不为空
            if ((e = oldTab[j]) != null) {
                // 释放原数组
                oldTab[j] = null;
                // 原桶中没有发生碰撞，直接移动
                if (e.next == null)
                    newTab[e.hash & (newCap - 1)] = e;
                // 原链表已被改造为树形结构，调用 ((TreeNode<K,V>)e).split
                else if (e instanceof TreeNode)
                    ((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;
                    // 遍历链表
                    do {
                        next = e.next;
                        // 新位置 = 原位置
                        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;
                        newTab[j + oldCap] = hiHead;
                    }
                }
            }
        }
    }
    return newTab;
}

因为 table 的长度每次都变为原来的两倍，所以元素的新位置要么是在原位置，要么是在原位置再移动原 table 长度的位置。原理如下：

假设 table 长度 从 16 扩容为 32，即

可以看出，新位置只取决于 hash 值和 n - 1 最高位多出的 1 的与运算结果。因此，使用 e.hash & oldCap 判断新位置与原位置的关系。这个方法巧妙地解决了结点移动的问题，计算量低，还保留了原始的链表顺序。

treeifyBin(Node<K,V>[] tab, int hash)

final void treeifyBin(Node<K,V>[] tab, int hash) {
    int n, index; Node<K,V> e;
    // table 长度小于树化的最小阈值，将 table 进行扩容，不需要树化
    if (tab == null || (n = tab.length) < MIN_TREEIFY_CAPACITY)
        resize();
    else if ((e = tab[index = (n - 1) & hash]) != null) {
        // 确定链表的头结点和尾结点
        TreeNode<K,V> hd = null, tl = null;
        do {
            TreeNode<K,V> p = replacementTreeNode(e, null);
            if (tl == null)
                hd = p;
            else {
                p.prev = tl;
                tl.next = p;
            }
            tl = p;
        } while ((e = e.next) != null);
        // 进行树化
        if ((tab[index] = hd) != null)
            hd.treeify(tab);
    }
}

将链表改造为红黑树。

remove(Object key)

public V remove(Object key) {
    Node<K,V> e;
    return (e = removeNode(hash(key), key, null, false, true)) == null ?
        null : e.value;
}

如果 key 存在，返回 key 所对应的 value；如果 key 不存在，返回 null。

removeNode(int hash, Object key, Object value, boolean matchValue, boolean movable)

final Node<K,V> removeNode(int hash, Object key, Object value,
                           boolean matchValue, boolean movable) {
    Node<K,V>[] tab; Node<K,V> p; int n, index;
    // table 不为空且长度大于 0 且 table[hash % length] 不为空
    if ((tab = table) != null && (n = tab.length) > 0 &&
        (p = tab[index = (n - 1) & hash]) != null) {
        Node<K,V> node = null, e; K k; V v;
        // 链表头结点就是要删除的结点
        if (p.hash == hash &&
            ((k = p.key) == key || (key != null && key.equals(k))))
            node = p;
        else if ((e = p.next) != null) {
            // 已被改造为树形结构
            if (p instanceof TreeNode)
                node = ((TreeNode<K,V>)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);
            }
        }
        // 找到 key 所对应的结点
        // 如果 matchValue 为 true，则该结点的 value 必须和传入方法的 value 相等
        if (node != null && (!matchValue || (v = node.value) == value ||
                             (value != null && value.equals(v)))) {
            if (node instanceof TreeNode)
                ((TreeNode<K,V>)node).removeTreeNode(this, tab, movable);
            // 要删除的元素是头结点
            else if (node == p)
                tab[index] = node.next;
            // 要删除的元素不是头结点
            else
                p.next = node.next;
            ++modCount;
            --size;
            afterNodeRemoval(node);
            return node;
        }
    }
    return null;
}

containsValue(Object value)

public boolean containsValue(Object value) {
    Node<K,V>[] tab; V v;
    if ((tab = table) != null && size > 0) {
        // 遍历所有桶
        for (Node<K,V> e : tab) {
            // 遍历桶中的所有结点
            for (; e != null; e = e.next) {
                if ((v = e.value) == value ||
                    (value != null && value.equals(v)))
                    return true;
            }
        }
    }
    return false;
}

keySet()

public Set<K> keySet() {
    Set<K> ks = keySet;
    if (ks == null) {
        ks = new KeySet();
        keySet = ks;
    }
    return ks;
}

返回所有 key 组成的集合。对 KeySet 的改变会影响到原来的 HashMap，反之亦然。

values()

public Collection<V> values() {
    Collection<V> vs = values;
    if (vs == null) {
        vs = new Values();
        values = vs;
    }
    return vs;
}

返回所有 value 组成的集合。对 values 的改变会影响到原来的 HashMap，反之亦然。

entrySet()

public Set<Map.Entry<K,V>> entrySet() {
    Set<Map.Entry<K,V>> es;
    return (es = entrySet) == null ? (entrySet = new EntrySet()) : es;
}

返回所有 entrySet 组成的集合。对 entrySet 的改变会影响到原来的 HashMap，反之亦然。

getOrDefault(Object key, V defaultValue)

public V getOrDefault(Object key, V defaultValue) {
    Node<K,V> e;
    // Map 中存在 key，返回 key 所对应的 value；不存在 key，返回 defaultValue 
    return (e = getNode(hash(key), key)) == null ? defaultValue : e.value;
}

putIfAbsent(K key, V value)

public V putIfAbsent(K key, V value) {
    // 如果 key 不存在，插入新的 <key, value> 对；key 存在则不改变原始 value
    return putVal(hash(key), key, value, true, true);
}

remove(Object key, Object value)

public boolean remove(Object key, Object value) {
    // key 和 value 都相等才删除
	return removeNode(hash(key), key, value, true, true) != null;
}

replace(K key, V oldValue, V newValue)

public boolean replace(K key, V oldValue, V newValue) {
    Node<K,V> e; V v;
    // key 存在
    if ((e = getNode(hash(key), key)) != null &&
        // 原始 value 等于 oldValue
        ((v = e.value) == oldValue || (v != null && v.equals(oldValue)))) {
        e.value = newValue;
        afterNodeAccess(e);
        return true;
    }
    return false;
}

replace(K key, V value)

public V replace(K key, V value) {
    Node<K,V> e;
    // key 存在
    if ((e = getNode(hash(key), key)) != null) {
        V oldValue = e.value;
        e.value = value;
        afterNodeAccess(e);
        // 返回原始 value
        return oldValue;
    }
    return null;
}

HashMap 内部类

HashMap 三个视图返回的迭代器都是 fail-fast 的：如果在迭代时使用非迭代器方法修改了 Map 的内容、结构，迭代器就会抛出 ConcurrentModificationException 异常。例如下面的 KeySet 类和 HashIterator 类：

KeySet

final class KeySet extends AbstractSet<K> {
    public final int size()                 { return size; }
    public final void clear()               { HashMap.this.clear(); }
    public final Iterator<K> iterator()     { return new KeyIterator(); }
    public final boolean contains(Object o) { return containsKey(o); }
    public final boolean remove(Object key) {
        return removeNode(hash(key), key, null, false, true) != null;
    }
    public final Spliterator<K> spliterator() {
        return new KeySpliterator<>(HashMap.this, 0, -1, 0, 0);
    }
    public final void forEach(Consumer<? super K> action) {
        Node<K,V>[] tab;
        if (action == null)
            throw new NullPointerException();
        if (size > 0 && (tab = table) != null) {
            int mc = modCount;
            for (Node<K,V> e : tab) {
                for (; e != null; e = e.next)
                    action.accept(e.key);
            }
            // 在遍历过程中对 Map 做出了修改，抛出 ConcurrentModificationException 异常
            if (modCount != mc)
                throw new ConcurrentModificationException();
        }
    }
}

HashIterator

abstract class HashIterator {
    Node<K,V> next;        // next entry to return
    Node<K,V> current;     // current entry
    int expectedModCount;  // for fast-fail
    int index;             // current slot

    HashIterator() {
        expectedModCount = modCount;
        Node<K,V>[] t = table;
        current = next = null;
        index = 0;
        // 找到第一个不为空的桶
        if (t != null && size > 0) { // advance to first entry
            do {} while (index < t.length && (next = t[index++]) == null);
        }
    }

    public final boolean hasNext() {
        return next != null;
    }

    final Node<K,V> nextNode() {
        Node<K,V>[] t;
        Node<K,V> e = next;
        if (modCount != expectedModCount)
            throw new ConcurrentModificationException();
        if (e == null)
            throw new NoSuchElementException();
        if ((next = (current = e).next) == null && (t = table) != null) {
            do {} while (index < t.length && (next = t[index++]) == null);
        }
        return e;
    }

    public final void remove() {
        Node<K,V> p = current;
        if (p == null)
            throw new IllegalStateException();
        if (modCount != expectedModCount)
            throw new ConcurrentModificationException();
        current = null;
        removeNode(p.hash, p.key, null, false, false);
        expectedModCount = modCount;
    }
}