【集合类】源码解析之HashMap类

HashMap

数组+链表+红黑树，线程不安全，允许null键null值

类声明

public class HashMap<K,V> extends AbstractMap<K,V> implements Map<K,V>, Cloneable, Serializable

主要字段

// table的缺省容量 16
static final int DEFAULT_INITIAL_CAPACITY = 1 << 4;
// table的最大容量 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;
// 树化的最小容量，当哈希表中所有元素超过64个时才允许树化，否则直接扩容
static final int MIN_TREEIFY_CAPACITY = 64

// 哈希表
transient Node<K,V>[] table;
// entry的Set视图
transient Set<Map.Entry<K,V>> entrySet;
// 哈希表中元素的个数
transient int size
// 当前哈希表结构修改的次数，put/remove
transient int modCount;
// 扩容阈值 capacity * loadFactor
int threshold;
// 负载因子 用于计算threshold
final float loadFactor;

构造函数

// 使用指定的容量大小和负载因子构造HashMap
public HashMap(int initialCapacity, float loadFactor) {
    // 检查初始容量是否小于0
    if (initialCapacity < 0)
        throw new IllegalArgumentException("Illegal initial capacity: " + initialCapacity);
    // 检查初始容量是否大于最大容量，如果大于就置为最大容量
    if (initialCapacity > MAXIMUM_CAPACITY)
        initialCapacity = MAXIMUM_CAPACITY;
    // 检查负载因子是否小于等于0或者是否是个非数
    if (loadFactor <= 0 || Float.isNaN(loadFactor))
        throw new IllegalArgumentException("Illegal load factor: " + loadFactor);
    this.loadFactor = loadFactor;
    // 计算扩容阈值
    this.threshold = tableSizeFor(initialCapacity);
}

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

// 使用默认容量和负载因子构造HashMap
public HashMap() {
    this.loadFactor = DEFAULT_LOAD_FACTOR;
}

public HashMap(Map<? extends K, ? extends V> m) {
    this.loadFactor = DEFAULT_LOAD_FACTOR;
    putMapEntries(m, false);
}

tableSizeFor

获取大于等于传入容量小于等于最大int数的2的n次幂数

static final int tableSizeFor(int cap) {
    // 2的整次方的特性是二进制有效位只有一个1，退位后当前1消失，后面bit位全补1
    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;
}

以 MAXIMUM_CAPACITY 为示例，先使 MAXIMUM_CAPACITY+1 便于观察

首先进行退位获取最高位的1，然后第一次右移1位做或运算进行bit复制，得到两个0110

第二次右移2位做或运算进行bit复制，得到四个0111 1

第三次右移4位做或运算进行bit复制，得到四个0111 1111 1

依次类推，因为int类型只有32位，只需要右移到16就可以将其余位全补1

最后再进行进位得到2的整次幂

	bit
cap	0100 0000 0000 0000 0000 0000 0000 0001
n = cap - 1	0100 0000 0000 0000 0000 0000 0000 0000
n >>> 1	0010 0000 0000 0000 0000 0000 0000 0000
n |= n >>> 1	0110 0000 0000 0000 0000 0000 0000 0000
n >>> 2	0001 1000 0000 0000 0000 0000 0000 0000
n |= n >>> 2	0111 1000 0000 0000 0000 0000 0000 0000
n >>> 4	0000 0111 1000 0000 0000 0000 0000 0000
n |= n >>> 4	0111 1111 1000 0000 0000 0000 0000 0000
n >>> 8	0000 0000 0111 1111 1000 0000 0000 0000
n |= n >>> 8	0111 1111 1111 1111 1000 0000 0000 0000
n >>> 16	0000 0000 0000 0000 0111 1111 1111 1111
n |= n >>> 16	0111 1111 1111 1111 1111 1111 1111 1111

int n = cap - 1 如果不-1，遇到2的整次幂数16,32,64等会计算出32,64,128从而浪费容量

新增方法

put方法

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

hash方法

对key的hashCode()做hash，让key的hash的高16位也参与路由运算

已知路由算法：(length - 1) & hash

hash值比较大，而在没有扩容前length-1是比较小的，导致hash值的高位大部分都不参与运算

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

以key="china"为例

	bit
key hash	0000 0101 1010 0011 1111 0101 0101 0111
key hash >>> 16	0000 0000 0000 0000 0000 0101 1010 0011
key hash ^ (key hash >>> 16)	0000 0101 1010 0011 1111 0000 1111 0100

putVal方法

/**
 * @param hash key的hash值
 * @param key key
 * @param value value
 * @param onlyIfAbsent 如果为true 对于已存在的key不更新值
 * @param evict 给LinkedHasMap实现使用
 * @return oldValue或者null
 */
final V putVal(int hash, K key, V value, boolean onlyIfAbsent, boolean evict) {
    	// tab 引用当前hashMap的散列表
    	// p 当前散列表的元素
    	// n 散列表数组的长度
    	// i 当前路由寻址的结果
        Node<K,V>[] tab; Node<K,V> p; int n, i;
    	// 分支一：延迟初始化，第一次调用put会会初始化HashMap中的散列表
        if ((tab = table) == null || (n = tab.length) == 0)
            n = (tab = resize()).length;
    
    	// 分支二：寻找到的桶位Buckets刚好为null,直接将k-v构建的newNode放进去
        if ((p = tab[i = (n - 1) & hash]) == null)
            tab[i] = newNode(hash, key, value, null);
        else {
            // e：临时节点  k：临时节点的key
            Node<K,V> e; K k;
            // 分支三：桶内元素与当前插入元素的key完全一致，将e指向p，后续执行更新操作
            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 {
                // 分支五：链表结构，并且链表的头元素与插入元素的key不一致
                for (int binCount = 0; ; ++binCount) {
                    // p.next = null 代表当前节点是尾节点，还是没匹配上，则将元素插入链尾
                    if ((e = p.next) == null) {
                        p.next = newNode(hash, key, value, null);
                        // 判断链表长度是否达到树化阈值
                        if (binCount >= TREEIFY_THRESHOLD - 1)
                            // 进行树化
                            treeifyBin(tab, hash);
                        break;
                    }
                    // 如果条件成立，说明找到了完全相同的key，后续执行更新操作
                    if (e.hash == hash &&
                        ((k = e.key) == key || (key != null && key.equals(k))))
                        break;
                    // 本轮循环没结束，将p(指向当前元素的引用)指向e(下个元素的引用)
                    p = e;
                }
            }
            // 如果e不为null代表有需要将新值替换旧值的
            if (e != null) { 
                V oldValue = e.value;
                if (!onlyIfAbsent || oldValue == null)
                    e.value = value;
                // 提供给LinkedHashMap的方法
                afterNodeAccess(e);
                return oldValue;
            }
        }
    	// 有新增元素，修改次数+1
        ++modCount;
    	// size自增，并判断自增后的size是否超过了扩容阈值
        if (++size > threshold)
            // 进行扩容
            resize();
    	// 提供给LinkedHashMap的方法
        afterNodeInsertion(evict);
        return null;
    }

扩容方法

resize方法

final Node<K,V>[] resize() {
    // 扩容之前的哈希表引用
    Node<K,V>[] oldTab = table;
    // 扩容之前的table容量
    int oldCap = (oldTab == null) ? 0 : oldTab.length;
    // 扩容之前的扩容阈值，也就是本次需要扩容的大小
    int oldThr = threshold;
    // newCap：扩容后的table容量 newThr：扩容后下次再触发扩容的条件
    int newCap, newThr = 0;
    
    // --------------------------计算newCap和newThr------------------------------
    
    // 代表不是初始化扩容，而是正常扩容
    if (oldCap > 0) {
        // 如果扩容之前table的大小就达到了扩容阈值，则不进行扩容，并将扩容条件设置为int的最大值
        if (oldCap >= MAXIMUM_CAPACITY) {
            threshold = Integer.MAX_VALUE;
            return oldTab;
        }
        // oldCap左移一位实现翻倍并赋值给newCap, 如果newCap小于最大容量并且oldCap大于等于16
        else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
                 oldCap >= DEFAULT_INITIAL_CAPACITY)
            // 将扩容前的扩容阈值直接翻倍赋值给新的扩容阈值
            newThr = oldThr << 1;
    }
    
    // oldCap == 0 && oldThr > 0 
    // 以下三个构造函数会导致oldThr > 0
    // HashMap(int initialCapacity, float loadFactor) 
    // HashMap(int initialCapacity)
    // HashMap(Map<? extends K, ? extends V> m) 并且 m 中存在元素
    else if (oldThr > 0) 
        // 将扩容后的table容量设值为阈值
        newCap = oldThr;
    else {
        // oldCap == 0 && oldThr == 0  
        // HashMap() 这个构造函数会导致 oldThr == 0
       	// 设置为默认大小以及计算默认扩容阈值（capacity * loadFactor）
        newCap = DEFAULT_INITIAL_CAPACITY; // 16
        newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY); // 0.75 * 16 = 12
    }
    
    // 如果通过以上几个分支还未对newThr赋值，则通过newCap和loadFactor计算
    if (newThr == 0) {
        // 扩容阈值计算公式
        float ft = (float)newCap * loadFactor;
        // 主要是将float转为int
        newThr = (newCap < MAXIMUM_CAPACITY && ft < (float)MAXIMUM_CAPACITY ?
                  (int)ft : Integer.MAX_VALUE);
    }
    threshold = newThr;
    
    // --------------------------扩容并复制数据------------------------------
    
    @SuppressWarnings({"rawtypes","unchecked"})
    // 通过上面计算出的newCap创建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) {
                // 将旧table的桶位元素置为null 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 {
                    // 低位链表：存放扩容之后数组下标位置和扩容之前一样的元素
                    Node<K,V> loHead = null, loTail = null; // loHead：头节点 loTail：尾节点
                    // 高位链表：存放扩容之后数组下标位置等于扩容之前下标位置 + 扩容之前的Node数组长度
                    Node<K,V> hiHead = null, hiTail = null;
                    // 下个节点
                    Node<K,V> next;
                    do {
                        next = e.next;
                        // 如果e.hash & oldCap == 0 代表将落在低位链表
                        if ((e.hash & oldCap) == 0) {
                            // 如果链表为null则将当前元素置为头节点，否则将下个节点指向当前元素
                            if (loTail == null)
                                loHead = e;
                            else
                                loTail.next = e;
                            // 将当前元素置为尾节点
                            loTail = e;
                        }
                        // e.hash & oldCap != 0 代表将落在高位链表
                        else {
                            if (hiTail == null)
                                hiHead = e;
                            else
                                hiTail.next = e;
                            hiTail = e;
                        }
                    } while ((e = next) != null);
                    
                    // 将低位链表的尾节点的next指向null,并且插入newTab中
                    if (loTail != null) {
                        loTail.next = null;
                        newTab[j] = loHead;
                    }
                    // 将高位链表的尾节点的next指向null,并且插入newTab中
                    if (hiTail != null) {
                        hiTail.next = null;
                        // 原下标 + 原数组容量
                        newTab[j + oldCap] = hiHead;
                    }
                }
            }
        }
    }
    return newTab;
}

链表节点扩容图

以16扩容到32为例

查询方法

get方法

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

getNode方法

/**
 * @param key经过hash的hash值
 * @param 需要查找元素的key
 * @return 返回查找到的节点或者null
 */
final Node<K,V> getNode(int hash, Object key) {
   	// tab 引用当前hashMap的散列表
    // first 当前桶位的第一个的元素
    // e 当前节点
    // n 散列表数组的长度
    // k 当前元素的key
    Node<K,V>[] tab; Node<K,V> first, e; int n; K k;
    // 对tab、frist赋值，数组存在元素并且当前桶位中有元素
    if ((tab = table) != null && (n = tab.length) > 0 && (first = tab[(n - 1) & hash]) != null) {
        // 第一种情况：第一个元素就是所需要查找的，那么不需要管是链表还是红黑树结构直接返回第一个元素
        if (first.hash == hash && ((k = first.key) == key || (key != null && key.equals(k))))
            return first;
        // 还存在下一个节点
        if ((e = first.next) != null) {
            // 第二种情况：当前节点是红黑树结构
            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;
}

删除方法

remove方法

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

removeNode方法

/**
 * @param key经过hash的hash值
 * @param 需要删除元素的key
 * @param 需要删除元素的值
 * @param 需要匹配的值，如果为true则查找到的节点value需要和传入的value相同才删除
 * @param 如果为false，则在删除时不要移动其他节点，树节点才会用到
 * @return 返回已删除的节点或者null
 */
final Node<K,V> removeNode(int hash, Object key, Object value,
                           boolean matchValue, boolean movable) {
    // tab 引用当前hashMap的散列表
    // p 通过路由寻址找到的当前桶位的第一个节点
    // n 散列表数组的长度
    // index 当前路由寻址的结果
    Node<K,V>[] tab; Node<K,V> p; int n, index;
    // 对tab、p赋值，数组存在元素并且当前桶位中有元素
    if ((tab = table) != null && (n = tab.length) > 0 && (p = tab[index = (n - 1) & hash]) != null) {
        // node: 需要删除的节点 当前节点: e 
        Node<K,V> node = null, e; K k; V v;
        // 第一种情况：第一个元素就是所需要删除的，那么不需要管是链表还是红黑树结构将当前节点赋值给node
        if (p.hash == hash && ((k = p.key) == key || (key != null && key.equals(k))))
            node = p;
        // 还存在下一个节点 将下个节点赋值给e
        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);
            }
        }
    
        // 删除逻辑 对于remove(Object key)  !matchVale恒为true所以不会走后半部分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;
            // 对应上面第三种情况 链表结构 将上个节点的next指向当前需要删除的元素的下个元素
            else
                p.next = node.next;
            // 有删除元素，修改次数+1 容量-1
            ++modCount;
            --size;
            // 提供给LinkedHashMap的方法
            afterNodeRemoval(node);
            return node;
        }
    }
    return null;
}

替换方法

replace方法

@Override
public boolean replace(K key, V oldValue, V newValue) {
    Node<K,V> e; V v;
    // 通过通过getNode找到节点并判断旧value与传入的oldValue是否相同，相同则用newValue覆盖
    if ((e = getNode(hash(key), key)) != null &&
        ((v = e.value) == oldValue || (v != null && v.equals(oldValue)))) {
        e.value = newValue;
        afterNodeAccess(e);
        return true;
    }
    return false;
}

@Override
public V replace(K key, V value) {
    Node<K,V> e;
    // 通过getNode找到节点，用旧值替换新值并返回旧值
    if ((e = getNode(hash(key), key)) != null) {
        V oldValue = e.value;
        e.value = value;
        afterNodeAccess(e);
        return oldValue;
    }
    return null;
}