HashMap源码笔记(一)

虽然 HashMap 的源码分析到处都是了,但是还是要自己理一遍才算是清楚,这跟小黄鸭 DEBUG 法是一样的吧。
写这个的目的只是记录自己的学习效果。
使用的 JDK 版本是 1.8。

简介

HashMap<K,V> 提供了 KV 的存储方式,继承了抽象类 AbstractMap<K,V>,实现了接口 Map<K,V>, Cloneable, Serializable.
HashMap 使用数组 + 链表/红黑树的方式实现了 Map。
HashMap 中的内部类 Node<K,V> 实现了接口 Map.Entry<K,V>,代表一个键值对,是 HashMap 储存的基本单位。

HashMap 中的 fields

table

transient Node<K,V>[] table;

table 是 HashMap 中真正存储数据的地方,在第一次put的时候才会初始化,而且会在需要额时候进行扩容。这个数组的长度永远是 2 的 n 次方。

entrySet

transient Set<Map.Entry<K,V>> entrySet;

暂存entrySet()的结果, 是一个内部类EntrySet的实例, 这个内部类将 iterator 与 nextNode()联系起来。

modCount

 transient int modCount;

这个变量记录了 HashMap 被 structurally modified 的次数。这个是有关于线程安全的,如果在使用迭代器时,数据被 structurally modify 了就会抛出ConcurrentModificationException,fail-fast 机制。

size

transient int size;

HashMap 中存储的键值对个数。

threshold

int threshold;

threshold 翻译过来是阈(yù)值, 当 size 大于这个值时,便会进行 resize。

loadFactor

final float loadFactor;

初始化时,threshold = initialCapacity * loadFactor

HashMap 中的 methods

tableSizeFor(int cap)

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

假设这个函数的返回值为 a, 则 a 是在大于cap的所有 2 的 n 次幂中,最接近cap的。
这个函数的返回值被用来作为上面所说字段Node<K,V>[] table 的数组长度。

( 雾 )index 的计算

if ((tab = table) == null || (n = tab.length) == 0)
    n = (tab = resize()).length;
if ((p = tab[i = (n - 1) & hash]) == null)
    tab[i] = newNode(hash, key, value, null);

这是在源码中的 628-631 行,其中变量 i 即为 index。

其实这不是一个方法,但是它很重要,关系到如何判断一个 key 到底应该放在 Node<K,V> table[]数组的第几个坑里。 上面说到了,这个数组的长度永远是 2 的 n 次幂,index 直接取 hash 的后 n 位。

int hash(Object key)

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

在 HashMap 中,并不是直接使用 key 的 hashCode()作为 hash。
假设 hash(Object key)的返回值为 b, 某个 key 的 hashCode()返回的值为 a, 这个方法将 a 的高 16 位放在 b 的高 16 位,将 a 的高 16 位与 a 的低 16 位做异或得到的结果放到 b 的低 16 位,然后返回 b。

这样做的目的是防止 hashCode 只存在高位的变化。

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

其实并不复杂,由于每次扩充都是扩容成以前的 2 倍,(在只考虑链表,不考虑树的情况下)只需要看 hash 的高一位就可以判断,这个键值对是要放在新的坑里, 还是“留”在旧的坑里。

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;
    if ((tab = table) == null || (n = tab.length) == 0)
        n = (tab = resize()).length;
    if ((p = tab[i = (n - 1) & hash]) == null)
        tab[i] = newNode(hash, key, value, null);
    else {
        Node<K,V> e; K k;
        if (p.hash == hash &&
            ((k = p.key) == key || (key != null && key.equals(k))))
            e = p;
        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);
                    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;
            }
        }
        if (e != null) { // existing mapping for key
            V oldValue = e.value;
            if (!onlyIfAbsent || oldValue == null)
                e.value = value;
            afterNodeAccess(e);
            return oldValue;
        }
    }
    ++modCount;
    if (++size > threshold)
        resize();
    afterNodeInsertion(evict);
    return null;
}

其实细看也不复杂,只是分的情况有点多而已(当然,也没有考虑到  树的情况)。

总结

HashMap 非常常用,在这篇文章里只是关于最基本的  计算 hash 与存储的数据结构,关于线程安全和 java 1.8 以后加入的树,将在后续的文章中接着写。