源码学习——HashMap

继承关系

UML 图示

内部节点类

与之前介绍的 LinkedList 使用的节点类有所不同，LinkedList 使用的节点类中荷载的只有数据，而这里需要一个 K-V 键值对。

static class Node<K,V> implements Map.Entry<K,V> {
    final int hash;
    final K key;
    V value;
    Node<K,V> next;

    Node(int hash, K key, V value, Node<K,V> next) {
        this.hash = hash;
        this.key = key;
        this.value = value;
        this.next = next;
    }
}

静态常量

/**
 * 默认的初始容量 16
 */
static final int DEFAULT_INITIAL_CAPACITY = 1 << 4; // aka 16

/**
 * 最大的容量限额 2^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;

/**
 * 最小树化容量
 */
static final int MIN_TREEIFY_CAPACITY = 64;

成员变量

/**
 * 存放 Node 节点的数组指针，第一次使用时初始化
 */
transient Node<K,V>[] table;

/**
 * 该 map 中存在 k-v 键值对的数量
 */
transient int size;

/**
 * 该 map 结构被修改的次数，多用于 fail-fast 场景
 */
transient int modCount;

/**
 * 触发 map 扩容的门限值。
 * 即容量值 * 负载因子
 */
int threshold;

/**
 * 负载因子
 */
final float loadFactor;

构造方法

无参构造

负载因子默认，其他字段也默认

public HashMap() {
    this.loadFactor = DEFAULT_LOAD_FACTOR; // all other fields defaulted
}

传入初始化容量大小和负载因子

public HashMap(int initialCapacity, float loadFactor) {
    // ***
    // 忽略一些边界处理代码
    this.loadFactor = loadFactor;
    // 处理一下传入的初始化容量值
    // 但是并没有达成门限的概念
    this.threshold = tableSizeFor(initialCapacity);
}

构造 map 时传入的初始化容量值可能不是 2 的 N 次幂，这样会在扩容的时候带来巨大的麻烦（暂时回避该问题），此函数的目的是将生成一个大于传入值而且离传入值最近的 2 的 N 次幂（可以尝试一下）。

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

传入初始化容量大小

public HashMap(int initialCapacity) {
    this(initialCapacity, DEFAULT_LOAD_FACTOR);
}

添加

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 的哈希码的高 16 位与低 16 位按位异或，这个算法的意义是让哈希码的高16 位也参与了生成索引的运算，避免了更多的哈希冲突。

// 简化版，32->16 16->8
1111 1110 1100 1000
0000 0000 1111 1110

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)
        // 如果目前 table 数组为空，去 resize
        // 可先看 resize()
        n = (tab = resize()).length;
    if ((p = tab[i = (n - 1) & hash]) == null)
    	// 找到了 key 应该待的索引位置，此处为空，新建一个节点安置进去
        tab[i] = newNode(hash, key, value, null);
    else {
    	// 找到了 key 应该待的索引位置，此处已有节点/链表/树
        Node<K,V> e; K k;
        if (p.hash == hash &&
            ((k = p.key) == key || (key != null && key.equals(k))))
            // 同一个 key，只需要修改 value
            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))))
                    // 同一个 key
                    break;
                p = e;
            }
        }
        // 判断是插入了重复的 key 
        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;
}

扩容

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) {
    	// 1.数组已被初始化
    	// *****忽略了边界处理*****
    	// double capacity
    	newCap = oldCap << 1;
    	// double threshold
        newThr = oldThr << 1; 
    }
    else if (oldThr > 0) 
    	// 2.数组并没有被初始化，但是传入了初始化容量大小（initCapacity、threshold）
        newCap = oldThr;
    else {
    	// 3.无参构造来的，啥也没传 使用默认的容量 16，默认的阈值 12
        newCap = DEFAULT_INITIAL_CAPACITY;
        newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
    }
    if (newThr == 0) {
    	// 2.情况里
        float ft = (float)newCap * loadFactor;
        newThr = (newCap < MAXIMUM_CAPACITY && ft < (float)MAXIMUM_CAPACITY ?
                  (int)ft : Integer.MAX_VALUE);
    }
    // 总结下上述代码，就是计算新的容量和门限，加倍关系
    threshold = newThr;
    @SuppressWarnings({"rawtypes","unchecked"})
    // 构造新的 node 数组
    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) {
            	// help gc
                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;
                    }
                    // 放在原索引+oldCap 处
                    if (hiTail != null) {
                        hiTail.next = null;
                        newTab[j + oldCap] = hiHead;
                    }
                }
            }
        }
    }
    return newTab;
}

总结下扩容方法

首先计算出扩容后的容量和扩容门限

• 数组已被初始化，直接将容量和扩容门限加倍
• 数组未被初始化
  • 传入了初始化容量，使用该容量，计算出扩容门限
  • 无参构造，使用默认容量，计算出扩容门限

然后使用新的容量构造新的数组，遍历旧数组中节点（和链表、树）重新放入新数组

• 只有一个节点，根据规则放入新数组
• 节点后跟着一棵树
• 节点后跟着普通链表，遍历链表

根据一个节点放入数组的索引规则，这个节点进入新数组的索引只有两种情况

• 留在旧数组的索引
• 在旧数组的索引 + oldCapacity(oldTable.length)

树化

final void treeifyBin(Node<K,V>[] tab, int hash) {
    int n, index; Node<K,V> e;
    if (tab == null || (n = tab.length) < MIN_TREEIFY_CAPACITY)
        resize();
    else if ((e = tab[index = (n - 1) & hash]) != null) {
        // ***树化，我看不懂*** //
    }
}

注意事项

树化时机

• 单条链表上节点个数达到了树化阈值（8），进入到 treeifyBin 函数
• 判断数组的长度（不是整个 map 的 size）是否到达 MIN_TREEIFY_CAPACITY 树化容量
  • 否，进行扩容
  • 是，进行树化

扩容时机

• 数组为空
• 达到扩容门限前夕
• 单条链表上节点个数达到了树化阈值，整个数组没有达到树化容量

为什么使用 8 作为树化阈值

当一条链表上长度达到 8，如果此时还没有达到树化容量，那么整个 Map 容量小于等于 32，阈值才24；意味着往 map 里放了不到 24 个节点，有 1/3 在同一条链表上，数据冲突太严重。