HashMap 源码解析（jdk1.8）

1、简述

本篇内容我们来聊聊我们日常开发中经常使用的一个类 HashMap，相信大家都不陌生。

2、归纳

• 继承了 AbstractMap 抽象类，实现了 Map 接口，实现了 Cloneable 和 Serializable 接口，所以支持复制（拷贝）、序列化。
• HashMap 的底层是基于拉链式的散列算法实现的，也就是数组+链表+红黑树，允许 null 键和 null 值存在，默认初始容量为16，默认负载因子为0.75，扩容时扩容为原来容量的2倍，且底层数组容量一定为2的整数次幂。
• HashMap 在求 hash 值的时，当 key 为 null 时，hash 值为0，当 key 不为 null 时，采用 key.hashCode()^(key.hashCode()>>>16) 进行计算，通过这种方式，让高位数据与低位数据进行按位异或操作，以此加大低位信息的随机性，变相的让高位数据参与到，从而达到降低 hash 的碰撞冲突。
• HashMap 在求位置索引是，采用 (length - 1) & hash 的方式，等价于 hash % length，但是取余运算没有按位与运算高。
• HashMap 是非线程安全的，只是用于单线程环境下，多线程环境下可以采用 java.util.concurrent 并发包下的 ConcurrentHashMap。

3、分析

3.1、接口

• 在分析 HashMap源码之前，我们先来看看集合的接口 Map。

public interface Map<K, V> {
    ...
    // 增
    V put(K key, V value);
    // 删
    V remove(Object key);
    // 查
    V get(Object key);
    ...
}

• 在上述接口中，我只抽取了比较重要的几个方法，然后以此为后续重点分析目标，其 Map 接口对应的源码中远不止上述几个方法，有兴趣的同学可以自行翻阅。

3.2、静态内部类

public class HashMap<K,V> extends AbstractMap<K,V>
    implements Map<K,V>, Cloneable, Serializable {
    ...
    // HashMap 的结构
    static class Node<K,V> implements Map.Entry<K,V> {
        // 整型的 hash 值
        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;
        }

        public final K getKey()        { return key; }
        public final V getValue()      { return value; }
        public final String toString() { return key + "=" + value; }

        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;
        }
    }
    
    // 红黑树的静态内部类
    static final class TreeNode<K,V> extends LinkedHashMap.LinkedHashMapEntry<K,V> {
        TreeNode<K,V> parent;  // red-black tree links
        TreeNode<K,V> left;
        TreeNode<K,V> right;
        TreeNode<K,V> prev;    // needed to unlink next upon deletion
        boolean red;
        TreeNode(int hash, K key, V val, Node<K,V> next) {
            super(hash, key, val, next);
        }
        ...
    }
    ...
}

3.3、成员变量

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

    // 序列化唯一表示 UID
    private static final long serialVersionUID = 362498820763181265L;
    
    // 默认初始容量为16，0000 0001 右移4位 0001 0000为16，主干数组的初始容量为16，
    // 且这个数组必须是2的整数次方幂
    static final int DEFAULT_INITIAL_CAPACITY = 1 << 4;
    
    // 最大容量为 int 的最大值除2
    static final int MAXIMUM_CAPACITY = 1 << 30;
    
    // 默认负载因子为0.75
    static final float DEFAULT_LOAD_FACTOR = 0.75f;
    
    // 阈值，如果主干数组上的链表的长度大于8，链表转化为红黑树
    static final int TREEIFY_THRESHOLD = 8;
    
    // Hash表扩容后，如果发现某一个红黑树的长度小于6，则会重新退化为链表
    static final int UNTREEIFY_THRESHOLD = 6;
    
    // 当hashmap容量大于64时，链表才能转成红黑树
    static final int MIN_TREEIFY_CAPACITY = 64;
    
    // 存储元素的数组，transient关键字表示该属性不能被序列化
    transient Node<K,V>[] table;
    
    // 将数据转换成 Set 的另一种存储形式，这个变量主要用于迭代功能
    transient Set<Map.Entry<K,V>> entrySet;
    
    // HashMap 的元素数量
    transient int size;
    
    // HashMap 结构性变化的次数
    transient int modCount;
    
    // 当前 HashMap 所能容纳键值对数量的最大值，超过这个值，则需扩容
    int threshold;
    
    // 负载因子
    final float loadFactor;
    ...
    
}

3.3、构造函数

• 构造函数是一个类最常见的，同样也是最常被使用到的，接着我们分析 HashMap 的四个不同的构造函数。

public class HashMap<K,V> extends AbstractMap<K,V>
    implements Map<K,V>, Cloneable, Serializable {
    ...
    /**
     * 无参构造函数
     */
    public HashMap() {
        this.loadFactor = DEFAULT_LOAD_FACTOR; 
    }
    
    /**
     * 有参构造函数
     *
     * @param initialCapacity 数组容量
     */
    public HashMap(int initialCapacity) {
        this(initialCapacity, DEFAULT_LOAD_FACTOR);
    }
    
    /**
     * 有参构造函数
     *
     * @param initialCapacity 数组容量
     * @param initialCapacity 负载因子
     */
    public HashMap(int initialCapacity, float loadFactor) {
        if (initialCapacity < 0)
            throw new IllegalArgumentException("Illegal initial capacity: " +
                                               initialCapacity);
        if (initialCapacity > MAXIMUM_CAPACITY)
            initialCapacity = MAXIMUM_CAPACITY;
        if (loadFactor <= 0 || Float.isNaN(loadFactor))
            throw new IllegalArgumentException("Illegal load factor: " +
                                               loadFactor);
        this.loadFactor = loadFactor;
        this.threshold = tableSizeFor(initialCapacity);
    }
    
    /**
     * 有参构造函数
     *
     * @param m 传入 Map 集合
     */
    public HashMap(Map<? extends K, ? extends V> m) {
        this.loadFactor = DEFAULT_LOAD_FACTOR;
        putMapEntries(m, false);
    }
    
    /** 
     * 返回一个比给定整数大且最接近的2的幂次方整数
     * 例如：给定10，返回2的4次方16，因为 HashMap 要求容量必须是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;
    }
    
    /**
     * 将m的所有元素存入本 HashMap 实例中
     *
     * @param m map 集合
     * @param evict 如果为 false，则表处于创建模式。
     */
    final void putMapEntries(Map<? extends K, ? extends V> m, boolean evict) {
        // 得到 m 中元素的个数
        int s = m.size();
        // 当 m 中有元素时，则需将map中元素放入本 HashMap 实例。
        if (s > 0) {
            // 判断 table 是否已经初始化，如果未初始化，则先初始化一些变量。
            if (table == null) { // pre-size
                // 根据待插入的 map 的 size 计算要创建的 HashMap 的容量。
                float ft = ((float)s / loadFactor) + 1.0F;
                int t = ((ft < (float)MAXIMUM_CAPACITY) ?
                         (int)ft : MAXIMUM_CAPACITY);
                // 把要创建的 HashMap 的容量存在 threshold 中
                if (t > threshold)
                    threshold = tableSizeFor(t);
            }
            // 如果 table 初始化过，因为别的函数也会调用它，所以有可能 HashMap 已经被初始化过了。
            // 判断待插入的 map 的 size，若 size 大于 threshold，则先进行 resize()，进行扩容
            else if (s > threshold)
                resize();
            // 然后就开始遍历带插入的 map ，将每一个 <Key ,Value> 插入到本 HashMap 实例。
            for (Map.Entry<? extends K, ? extends V> e : m.entrySet()) {
                K key = e.getKey();
                V value = e.getValue();
                // put(K,V) 也是调用 putVal 函数进行元素的插入
                putVal(hash(key), key, value, false, evict);
            }
        }
    }
    ...
}

• 注意：默认情况下，threshold=capacity*loadFactor，但是在其它情况下也会由 tableSizeFor() 方法计算得出。

-------------------------------
假设cap = 10
n = cap - 1;// 9    0000 1001
-------------------------------
n | n >>> 1;        0000 1001
                OR  0000 0100
                    0000 1101
-------------------------------
n |= n >>> 2;       0000 1101
                OR  0000 0011
                    0000 1111
-------------------------------
n |= n >>> 4;       0000 1111
                OR  0000 0000
                    0000 1111
-------------------------------
n |= n >>> 8;       0000 1111
                OR  0000 0000
                    0000 1111
-------------------------------
n |= n >>> 16;      0000 1111
                OR  0000 0000
                    0000 1111
-------------------------------
n = n + 1;          0001 0000（16）

3.4、增操作

public class HashMap<K,V> extends AbstractMap<K,V>
    implements Map<K,V>, Cloneable, Serializable {
    ...
    /**
     * 增
     *
     * @param 指定值要与之关联的键
     * @param 与指定键相关联的值
     * @return 返回其指定键对应的旧值，如果 key 原本没存入，则返回 null
     */
    public V put(K key, V value) {
        return putVal(hash(key), key, value, false, true);
    }
    
    /**
     * 增
     *
     * @param 指定值要与之关联的键
     * @param 与指定键相关联的值
     * @return 返回其指定键对应的旧值，如果 key 原本没存入，则返回null
     */
    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，则 resize()
        if ((tab = table) == null || (n = tab.length) == 0)
            n = (tab = resize()).length;
        // 确定插入 table 的位置，算法是(n - 1) & hash，在 n 为2的幂时，相当于取摸操作。
        // 找到 key 值对应的槽并且是第一个，直接加入
        if ((p = tab[i = (n - 1) & hash]) == null)
            tab[i] = newNode(hash, key, value, null);
        // 在 table 的 i 位置发生碰撞，有两种情况
        // 1、key 值是一样的，替换value值
        // 2、key 值不一样的有两种处理方式：2.1、存储在i位置的链表；2.2、存储在红黑树中
        else {
            Node<K,V> e; K k;
            // 第一个 node 的 hash 值即为要加入元素的 hash
            if (p.hash == hash &&
                ((k = p.key) == key || (key != null && key.equals(k))))
                e = p;
            // 2.2
            else if (p instanceof TreeNode)
                e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
            // 2.1
            else {
                // 不是 TreeNode，即为链表，遍历链表
                for (int binCount = 0; ; ++binCount) {
                    // 链表的尾端也没有找到 key 值相同的节点，则生成一个新的 Node，
                    // 并且判断链表的节点个数是不是到达转换成红黑树的上界达到，则转换成红黑树。
                    if ((e = p.next) == null) {
                        // 创建链表节点并插入尾部
                        p.next = newNode(hash, key, value, null);
                        // 超过了链表的设置长度8就转换成红黑树
                        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;
                }
            }
            // 如果 e 不为空就替换旧的 oldValue 值
            if (e != null) {
                V oldValue = e.value;
                if (!onlyIfAbsent || oldValue == null)
                    e.value = value;
                afterNodeAccess(e);
                return oldValue;
            }
        }
        ++modCount;
        if (++size > threshold)
            resize();
        afterNodeInsertion(evict);
        return null;
    }
    
    /**
     * 计算 key 的 hash 值
     *
     * key 的 hash 值是通过其 hashCode() 高16位按位异或低16位实现的
     * 主要目的是通过这样方式降低其 hash 碰撞
     */
    static final int hash(Object key) {
        int h;
        return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
    }
    
    /**
     * 扩容
     *
     * @return 返回新的一维数组
     */
    final Node<K,V>[] resize() {
        // 保存当前 table
        Node<K,V>[] oldTab = table;
        // 保存当前 table 的容量
        int oldCap = (oldTab == null) ? 0 : oldTab.length;
        // 保存当前阈值
        int oldThr = threshold;
        // 初始化新的 table 容量和阈值 
        int newCap, newThr = 0;
        //  1. resize() 函数在 size　> threshold 时被调用。oldCap 大于0代表原来的 table 表非空，
        // oldCap 为原表的大小，oldThr（threshold）为 oldCap × load_factor
        if (oldCap > 0) {
            // 若旧 table 容量已超过最大容量，更新阈值为 Integer.MAX_VALUE（最大整形值），
            // 这样以后就不会自动扩容了。
            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
        }
        // 2. resize() 函数在 table 为空被调用。oldCap 小于等于 0 且 oldThr 大于0，
        // 代表用户创建了一个 HashMap，但是使用的构造函数为 HashMap(int initialCapacity,
        // float loadFactor) 或 HashMap(int initialCapacity) 或 HashMap(Map<? extends K, 
        // ? extends V> m)，导致 oldTab 为 null，oldCap 为0， oldThr 为用户指定的    
        // HashMap 的初始容量。
        else if (oldThr > 0) // initial capacity was placed in threshold
            // 当 table 没初始化时，threshold 持有初始容量。
            newCap = oldThr;
        // 3. resize() 函数在 table 为空被调用。oldCap 小于等于 0 且 oldThr 等于0，
        // 用户调用 HashMap() 构造函数创建的 HashMap，所有值均采用默认值，oldTab（Table）表为空，
        // oldCap 为0，oldThr 等于0。
        else { 
            newCap = DEFAULT_INITIAL_CAPACITY;
            newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
        }
        // 新阈值为0
        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"})
        // 初始化 table
        Node<K,V>[] newTab = (Node<K,V>[])new Node[newCap];
        table = newTab;
        if (oldTab != null) {
            // 把 oldTab 中的节点 reHash 到 newTab 中去
            for (int j = 0; j < oldCap; ++j) {
                Node<K,V> e;
                if ((e = oldTab[j]) != null) {
                    oldTab[j] = null;
                    // 若节点是单个节点，直接在 newTab 中进行重定位
                    if (e.next == null)
                        newTab[e.hash & (newCap - 1)] = e;
                    // 若节点是 TreeNode 节点，要进行红黑树的 rehash 操作
                    else if (e instanceof TreeNode)
                        ((TreeNode<K,V>)e).split(this, newTab, j, oldCap);
                    // 若是链表，进行链表的 rehash 操作
                    else { // preserve order
                        Node<K,V> loHead = null, loTail = null;
                        Node<K,V> hiHead = null, hiTail = null;
                        Node<K,V> next;
                        // 将同一桶中的元素根据 (e.hash & oldCap) 是否为0进行分割，
                        // 分成两个不同的链表，完成rehash。
                        do {
                            next = e.next;
                            // 根据算法 e.hash & oldCap 判断节点位置 rehash 后是否发生改变
                            // 最高位==0，这是索引不变的链表。
                            if ((e.hash & oldCap) == 0) {
                                if (loTail == null)
                                    loHead = e;
                                else
                                    loTail.next = e;
                                loTail = e;
                            }
                            // 最高位==1 （这是索引发生改变的链表）
                            else {
                                if (hiTail == null)
                                    hiHead = e;
                                else
                                    hiTail.next = e;
                                hiTail = e;
                            }
                        } while ((e = next) != null);
                        if (loTail != null) {// 原 bucket 位置的尾指针不为空（即还有 node）  
                            loTail.next = null;// 链表最后得有个 null
                            newTab[j] = loHead;// 链表头指针放在新桶的相同下标 (j) 处
                        }
                        if (hiTail != null) {
                            hiTail.next = null;
                            // rehash 后节点新的位置一定为原来基础上加上 oldCap
                            newTab[j + oldCap] = hiHead;
                        }
                    }
                }
            }
        }
        return newTab;
    }
    ...
}

3.5、删操作

public class HashMap<K,V> extends AbstractMap<K,V>
    implements Map<K,V>, Cloneable, Serializable {
    ...
    /**
     * 如果存在，则从此映射中删除指定键的映射。
     *
     * @param  要从映射中删除其映射的键
     * @return the previous value associated with <tt>key</tt>, or
     *         <tt>null</tt> if there was no mapping for <tt>key</tt>.
     *         (A <tt>null</tt> return can also indicate that the map
     *         previously associated <tt>null</tt> with <tt>key</tt>.)
     */
    public V remove(Object key) {
        Node<K,V> e;
        return (e = removeNode(hash(key), key, null, false, true)) == null ?
            null : e.value;
    }
    
    /**
     * 删除一个 Node 节点
     *
     * @param hash hash for key
     * @param key the key
     * @param value the value to match if matchValue, else ignored
     * @param matchValue if true only remove if value is equal
     * @param movable if false do not move other nodes while removing
     * @return the node, or null if none
     */
    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;
        // 1. 定位桶位置
        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;
            // 如果键的值与链表第一个节点相等，则将 node 指向该节点
            if (p.hash == hash &&
                ((k = p.key) == key || (key != null && key.equals(k))))
                node = p;
            // 如果是 TreeNode 类型，调用红黑树的查找逻辑定位待删除节点
            else if ((e = p.next) != null) {
                if (p instanceof TreeNode)
                    node = ((TreeNode<K,V>)p).getTreeNode(hash, key);
                else {
                    // 2. 遍历链表，找到待删除节点
                    do {
                        if (e.hash == hash &&
                            ((k = e.key) == key ||
                             (key != null && key.equals(k)))) {
                            node = e;
                            break;
                        }
                        p = e;
                    } while ((e = e.next) != null);
                }
            }
            // 3. 删除节点，并修复链表或红黑树
            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;
    }
    ...
}

3.6、查操作

public class HashMap<K,V> extends AbstractMap<K,V>
    implements Map<K,V>, Cloneable, Serializable {
    ...
    /**
     * 获取键对应的值
     *
     * @return 返回对应的值，如果不存在则返回 null
     */
    public V get(Object key) {
        Node<K,V> e;
        return (e = getNode(hash(key), key)) == null ? null : e.value;
    }
    
    /**
     * 通过 hash 和 key 获取其对应的 Node 节点
     *
     * @param hash 通过 key 计算的 hash 值
     * @param key 键
     * @return 返回对应的 Node 节点，如果不存在则返回 null
     */
    final Node<K,V> getNode(int hash, Object key) {
        Node<K,V>[] tab; Node<K,V> first, e; int n; K k;
        // 1. 定位键值对所在桶的位置
        if ((tab = table) != null && (n = tab.length) > 0 &&
            (first = tab[(n - 1) & hash]) != null) {
            if (first.hash == hash && // always check first node
                ((k = first.key) == key || (key != null && key.equals(k))))
                return first;
            if ((e = first.next) != null) {
                // 2. 如果 first 是 TreeNode 类型，则调用黑红树查找方法
                if (first instanceof TreeNode)
                    return ((TreeNode<K,V>)first).getTreeNode(hash, key);
                    
                // 2. 对链表进行查找
                do {
                    if (e.hash == hash &&
                        ((k = e.key) == key || (key != null && key.equals(k))))
                        return e;
                } while ((e = e.next) != null);
            }
        }
        return null;
    }
    ...
}

4、HashMap 在 jdk1.7 和 jdk1.8 的区别？

• 底层结构不一样，1.7是数组+链表结构，1.8是数组+链表+红黑树结构；
• 1.7中当哈希表为空时，会调用inflateTable()方法初始化一个数组，而1.8则是直接调用resize()方法扩容；
• 插入键值对 put 方法的区别，1.7采用头插法，1.8采用尾插法；
• hash()函数哈希值的计算，1.7中使用 key 的 hashCode 值，1.8中则是使用 key 的 hashCode 异或上 key 的 hashCode 进行无符号右移16位的结果，避免了只靠低位数据来计算哈希时导致的冲突，计算结果由高低位结合决定，使元素分布更均匀；
• 扩容时，1.7会颠倒链表的顺序，1.8则保持原链表的顺序，1.7则是在元素插入前检测是否需要扩容，1.8是在元素插入后检测是否需要扩容；
• 1.7是通过更新 hashSeed 来修改 hash 值达到分散的目的，1.8则是扩容时通过 hash&cap==0 将链表分散，无需改变 hash 值；
• 1.7中是只要不小于阈值就直接扩容2倍，而1.8的扩容策略会更优化，当数组容量未达到64时，以2倍进行扩容，超过64之后若桶中元素个数大于等于8就将链表转换为红黑树，但如果红黑树中的元素个数小于6就会还原为链表，当红黑树中元素不小于32的时候才会再次扩容。