HashMap源码分析整理

爱被打了一巴掌 2022-03-14 15:10 98阅读 0赞

## HashMap源码分析整理 ##

转自：[https://mp.weixin.qq.com/s/vRvMvNktoDSQKMMlnj5T0g][https_mp.weixin.qq.com_s_vRvMvNktoDSQKMMlnj5T0g]

### 结构 ###

Node是HashMap中一个静态内部类

// Node是单向列表
    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;
        }
    
        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;
        }
    }

TreeNode是红黑树的数据结构。

static final class TreeNode<K,V> entends LinkedHashMap.Entry<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);
        }
    
        /**
         * 返回红黑树的根节点
         */
        final TreeNode<K,V> root() {
            for (TreeNode<K,V> r = this, p;;) {
                if ((p = r.parent) == null)
                    return r;
                r = p;
            }
        }
    
        /**
         * 确保给定的根节点是第一个节点
         */
        static <K,V> void moveRootToFront(Node<K,V>[] tab, TreeNode<K,V> root) {...}
    
        /**
         * 从根节点开始，根据给出的hash值h和键k找到node
         */
        final TreeNode<K,V> find(int h, Object k, Class<?> kc) {...}
    
        /**
         * 调用寻找根节点的方法
         */
        final TreeNode<K,V> getTreeNode(int h, Object k) {
            return ((parent != null) ? root() : this).find(h, k, null);
        }
    
        /**
          * 用这个方法来比较两个对象，返回值要么大于0，要么小于0，不会为0
          * 也就是说这一步一定能确定要插入的节点要么是树的左节点，要么是右节点，不然就无继续满足二叉树结构了
          * 先比较两个对象的类名，类名是字符串对象，就按字符串的比较规则
          * 如果两个对象是同一个类型，那么调用本地方法为两个对象生成hashCode值，再进行比较，hashCode相等的话返回-1
          */
        static int tieBreakOrder(Object a, Object b) {
            int d;
            if (a == null || b == null ||
                (d = a.getClass().getName().
                 compareTo(b.getClass().getName())) == 0)
                d = (System.identityHashCode(a) <= System.identityHashCode(b) ?
                     -1 : 1);
            return d;
        }
    
        /**
         * 形成从tab节点链接的节点树
         */
        final void treeify(Node<K,V>[] tab) {...}
    
        /**
         * 将单向链表替代此节点，并返回此链表
         */
        final Node<K,V> untreeify(HashMap<K,V> map) {
            Node<K,V> hd = null, tl = null;
            for (Node<K,V> q = this; q != null; q = q.next) {
                Node<K,V> p = map.replacementNode(q, null);
                if (tl == null)
                    hd = p;
                else
                    tl.next = p;
                tl = p;
            }
            return hd;
        }
    
        /**
         * 将值存储为红黑树结构
         */
        final TreeNode<K,V> putTreeVal(HashMap<K,V> map, Node<K,V>[] tab,
                                       int h, K k, V v) {...}
    
         /**
          * 删除在此调用之前必须存在的指定节点
          */
        final void removeTreeNode(HashMap<K,V> map, Node<K,V>[] tab,
                                  boolean movable) {...}
    
        /**
         * Splits nodes in a tree bin into lower and upper tree bins,
         * 将树中的节点拆分为较低和较高的树容器，或者如果树目前太小，
         * 只会调用重置大小的方法；
         */
        final void split(HashMap<K,V> map, Node<K,V>[] tab, int index, int bit) {...}
    
        static <K,V> TreeNode<K,V> rotateLeft(TreeNode<K,V> root,
                                              TreeNode<K,V> p) {
            TreeNode<K,V> r, pp, rl;
            if (p != null && (r = p.right) != null) {
                if ((rl = p.right = r.left) != null)
                    rl.parent = p;
                if ((pp = r.parent = p.parent) == null)
                    (root = r).red = false;
                else if (pp.left == p)
                    pp.left = r;
                else
                    pp.right = r;
                r.left = p;
                p.parent = r;
            }
            return root;
        }
    
        static <K,V> TreeNode<K,V> rotateRight(TreeNode<K,V> root,
                                               TreeNode<K,V> p) {
            TreeNode<K,V> l, pp, lr;
            if (p != null && (l = p.left) != null) {
                if ((lr = p.left = l.right) != null)
                    lr.parent = p;
                if ((pp = l.parent = p.parent) == null)
                    (root = l).red = false;
                else if (pp.right == p)
                    pp.right = l;
                else
                    pp.left = l;
                l.right = p;
                p.parent = l;
            }
            return root;
        }
    
        static <K,V> TreeNode<K,V> balanceInsertion(TreeNode<K,V> root,
                                                    TreeNode<K,V> x) {...}
    
        static <K,V> TreeNode<K,V> balanceDeletion(TreeNode<K,V> root,
                                                   TreeNode<K,V> x) {...}
    
        /**
         * Recursive invariant check
         */
        static <K,V> boolean checkInvariants(TreeNode<K,V> t) {...}
    }

### 类定义 ###

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

### 属性 ###

/**
         * 默认初始容量，必须是2的整数倍。（1 << 4运算符效率高于直接写16）
         */
        static final int DEFAULT_INITIAL_CAPACITY = 1 << 4; // aka 16
    
        /**
         * 最大容量
         */
        static final int MAXIMUM_CAPACITY = 1 << 30;
    
        /**
         * 默认负载因子的值，用于计算threshold
         */
        static final float DEFAULT_LOAD_FACTOR = 0.75f;
    
        /**
         * 单向链表转成树的阈值，当前桶中的链表的长度大于8时转换成树
         * threshold = capacity * loadFactor
         */
        static final int TREEIFY_THRESHOLD = 8;
    
        /**
         * 进行resize操作时，若桶中的数量少于6则从树转成链表
         */
        static final int UNTREEIFY_THRESHOLD = 6;
    
        /**
         * 表的大小超过64这个阈值时，桶才可以被转换成树。
         * 若小于MIN_TREEIFY_CAPACITY导致hash冲突天多，则不进行链表转变为树的操作。
         */
        static final int MIN_TREEIFY_CAPACITY = 64;
        
        /**
         * 保存Node节点的数组，在首次使用时初始化，并根据需要调整大小。
         * 分配时，长度始终是2的幂。
         */
        transient Node<K,V>[] table;
        
        /**
         * 存放具体元素的集合
         */
        transient Set<Map.Entry<K,V>> entrySet;
        
        /**
         * 记录HashMap当前存储元素的数量
         */
        transient int size;
        
        /**
         * 每次更改map结构的计数器
         */
        transient int modCount;
        
        /**
         * 临界值 当实际大小（容量*负载因子）超过临界值时，进行扩容
         */
        int threshold;
        
        /**
         * 负载因子，要调整大小的下一个临界值(容量*负载因子)
         */
        final float loadFactor;

### 构造方法 ###

/**
     * 默认容量和负载因子
     */
    public HashMap() {
        this.loadFactor = DEFAULT_LOAD_FACTOR; // all other fields defaulted
    }
    
    /**
     * 传入指定初始容量大小，使用默认负载因子
     */
    public HashMap(int initialCapacity) {
        this(initialCapacity, DEFAULT_LOAD_FACTOR);
    }
    
    /**
     * 传入指定初始容量大小和指定负载因子
     */
    public HashMap(int initialCapacity, float loadFactor) {
        // 初始容量小于0，抛出IllegalArgumentException异常
        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;
        // 初始化threshold大小
        this.threshold = tableSizeFor(initialCapacity);
    }
    
    /**
     * 找到大于或等于 cap 的最小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;
    }

**loadFactor负载因子：**  
  
当调低loadFactor时，HashMap所能容纳的键值对数量变少。扩容时重新将键值对存储新的桶数组里，键之间的hash碰撞几率下降，链表的长度变短。此时增删改查的操作效率会变高，以空间换时间。  
  
相反，如果调高loadFactor时(可以大于1)，HashMap所能容纳的键值对数量变多，空间利用率变高，但碰撞率也变高。这意味着链表长度变长，效率随之降低，以时间换空间。

### get方法 ###

public V get(Object key) {
        Node<K,V> e;
        return (e = getNode(hash(key), key)) == null ? null : e.value;
    }
    
    static final int hash(Object key) {
        int h;
        // key不为null时将key调用HashCode方法后，与其符号右移16位异或运算。
        // 通过这种方式，让高位数据与低位数据进行异或，以此加大低位信息的随机性，变相的让高位数据参与到计算中。
        return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
    }
    
    final Node<K,V> getNode(int hash, Object key) {
        Node<K,V>[] tab; Node<K,V> first, e; int n; K k;
        // 定位键值对所在桶的位置
        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) {
                // 判断是否是红黑树
                if (first instanceof TreeNode)
                    // 树结构调用getTreeNode方法
                    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;
    }

### 添加 ###

public V put(K key, V value) {
        return putVal(hash(key), key, value, false, true);
    }
    
    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为空时，则调用resize()方法来初始化容器
        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;
            // 比较桶中第一个元素(数组中的节点)的hash值和key值是否相等
            if (p.hash == hash &&
                ((k = p.key) == key || (key != null && key.equals(k))))
                // 如果键的值以及节点hashCode等于链表中的第一个键值对节点时，则将e指向该键值对
                e = p;
            // 如果桶中引用的类型是TreeNode，则调用红黑树的插入方法。
            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);
                        // 如果节点达到阈值(默认8)，转化为红黑树
                        if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
                            treeifyBin(tab, hash);
                        break;
                    }
                    // 判断链表中的节点的key值与插入的元素的key值是否相等
                    if (e.hash == hash &&
                        ((k = e.key) == key || (key != null && key.equals(k))))
                        break;
                    p = e;
                }
            }
            // 判断要插入的键值对是否存在HashMap中
            if (e != null) { // existing mapping for key
                V oldValue = e.value;
                // onlyIfAbsent表示是否仅在oldValue为null的情况下更新键值对的值
                if (!onlyIfAbsent || oldValue == null)
                    e.value = value;
                afterNodeAccess(e);
                return oldValue;
            }
        }
        ++modCount;
        // 键值对数量超过阈值时，则进行扩容
        if (++size > threshold)
            resize();
        afterNodeInsertion(evict);
        return null;
    }

初始化容器后没有进行put操作时，是不会分配存储空间的。  
  
1、当桶数组table为空时，通过扩容的方式初始化table。  
  
2、查找要插入的键值对是否已经存在，存在的话判断是否用心智替换旧制。  
  
3、如果不存在，则将键值对链入链表中，并根据链表长度决定是否将链表转为红黑树。  
  
4、判断键值对数量是否大于阈值，大于的话则进行扩容操作。

### 扩容机制 ###

final Node<K,V> resie() {
        // 拿到数组桶
        Node<K,V>[] oldTab = table;
        int oldCap = (oldTab == null) ? 0 : oldTab.length;
        int oldThr = threshold;
        int newCap, newThr = 0;
        // 如果数组桶的容量大于0
        if (oldCap > 0) {
            // 如果比最大值还大，则赋值为最大值
            if (oldCap >= MAXIMUM_CAPACITY) {
                threshold = Integer.MAX_VALUE;
                return oldTab;
            }
            // 如果扩容后旧数组桶大于初始容量并且小于最大值，则扩大两倍(阈值左移1位)
            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);
        }
        // 如果新阈值为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"})
            // 创建新数组桶
            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;
    }

**扩容步骤：**  
  
1、计算新桶数组的容量newCap和新阈值newThr。  
  
2、根据计算出的newCap创建新的桶数组，桶数组table也是在这里进行初始化的。  
  
3、将键值对节点重新映射到新的桶数组中。如果节点时TreeNode类型，则需要拆分红黑树；如果是普通节点，按原顺序进行分组。

**三种扩容方式：**  
  
1、使用默认构造方法初始化HashMap，此时table为空，thershold为0。因此第一次扩容的容量为默认值DEFAULT\_INITIAL\_CAPACITY=16,threshold = DEFAULT\_INITIAL\_CAPACITY \* DEFAULT\_LOAD\_FACTOR = 12  
  
2、指定初始容量的构造方法初始化HashMap。初始容量会等于threshold，接着threshold = 当前的容量（threshold） \* DEFAULT\_LOAD\_FACTOR  
  
3、HashMap不是第一次扩容。如果HashMap已经扩容过，那每次table的容量以及threshold量为原有的两倍。

### 相关问答 ###

JDK1.7是基于数组+单链表实现，为什么不用双链表？  
双链表需要更大的存储空间。

为什么使用红黑树，而不是平衡二叉树？  
插入效率比平衡二叉树搞，查询效率比普通二叉树搞。所以选择性能折中的红黑树。

HashMap为什么不直接使用对象的原始hash值?  
通过移位和异或运算，可以让hash变得更复杂，进而影响hash的分布性。

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

HashMap为什么不直接使用红黑树，而是在大于9个元素时才转换？  
如果元素小于8个，查询成本高，新增成本低。元素大于8个，查询成本低，新增成本高。

[https_mp.weixin.qq.com_s_vRvMvNktoDSQKMMlnj5T0g]: https://mp.weixin.qq.com/s/vRvMvNktoDSQKMMlnj5T0g