HashMap(jdk1.8)源码分析

概述

散列表(Hash table,也叫哈希表),是根据关键码值(Key value)而直接进行访问的数据结构。也就是说,它通过把关键码值映射到表中一个位置来访问记录,以加快查找的速度。这个映射函数叫做散列函数,存放记录的数组叫做散列表。
给定表M,存在函数f(key),对任意给定的关键字值key,代入函数后若能得到包含该关键字的记录在表中的地址,则称表M为哈希(Hash)表,函数f(key)为哈希(Hash) 函数。
HashMap是哈希表这种数据结构,在Java中的实现类。通过阅读源码可知,HashMap(jdk1.8)底层是通过数组+链表+红黑树实现,当链表长度超过阈值(8)时,将链表转换为红黑树,这样大大减少了查找时间。HashMap数据存储简化图如下:
《HashMap(jdk1.8)源码分析》

继承关系图

《HashMap(jdk1.8)源码分析》
说明:
HashMap继承抽象类(AbstractMap),并实现了Map、Cloneable、Serializable接口。其中,Map接口定义了一组通用的操作;Cloneable接口则表示该类可以拷贝,在HashMap中,实现的是浅拷贝,即对拷贝对象的改变会影响被拷贝的对象;Serializable接口表示HashMap实现了序列化,即可以将HashMap对象保存至本地,之后可以恢复状态。

属性及构造方法

属性
    //序列化标志ID
 private static final long serialVersionUID = 362498820763181265L;
    //默认Table(Node数组)初始容量
    static final int DEFAULT_INITIAL_CAPACITY = 1 << 4; // aka 16
    //Table的最大容量2^30次方
    static final int MAXIMUM_CAPACITY = 1 << 30;
    //默认填充因子
    static final float DEFAULT_LOAD_FACTOR = 0.75f;
    //链表节点数转红黑树的最小阈值
    static final int TREEIFY_THRESHOLD = 8;
    //红黑树节点数转链表的最大阈值
    static final int UNTREEIFY_THRESHOLD = 6;
    //链表转红黑树,Table最小阈值
    static final int MIN_TREEIFY_CAPACITY = 64;
    //Map中真正的存储数据节点类
    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;
        }
    }
    //HashMap中的存储元素数组,大小2^n次方,首次使用初始化,或扩容重新申请
    transient Node<K,V>[] table;
    //HashMap中真实存储数据的索引缓存,KeySet(),Map遍历等。
    transient Set<Map.Entry<K,V>> entrySet;
    //HashMap中数据的个数
    transient int size;
    //HashMap容量状态修改计数(删除,增加),当遍历的同时修改,通过判断此状态值,抛出ConcurrentModificationException
    transient int modCount;
    //HashMap的扩容临界值(size*loadFractor)
    int threshold;
    //填充因子,用于扩容临界值计数
    final float loadFactor;
构造方法
    /** * 默认构造方法,构造一个空Map,并将填充因子赋值默认填充因子(0.75) */
     public HashMap() {
        this.loadFactor = DEFAULT_LOAD_FACTOR; // all other fields defaulted
    }
      /** * 构造一个空Map,指定Map的初始容量大小(计算扩容临界值),填充因子赋值默认(0.75) */
    public HashMap(int initialCapacity) {
        //内部调用双参数构造方法
        this(initialCapacity, DEFAULT_LOAD_FACTOR);
    }
     /** * 构造一个空Map,并指定Map初始容量大小,指定Map填充因子 * 当initialCapacity为负数或loadFactor为非正或Nan会抛出参数非法异常 */
   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);
    }
    //根据传入参数计算大于该值第一个2^n次方的值
     static final int tableSizeFor(int cap) {
        int n = cap - 1;//避免传入参数正好为2^n次方
        n |= n >>> 1;//确保第一位为1后全1
        n |= n >>> 2;//确保第二位为1后全1
        n |= n >>> 4;//....
        n |= n >>> 8;//...
        n |= n >>> 16;//确保第16位为1后全1(1+2+4+8+16 31位全1)
        //经过以上运算 ,返回值可能为1、MAXIMUM_CAPACITY、n+1,均为2^n次方
        return (n < 0) ? 1 : (n >= MAXIMUM_CAPACITY) ? MAXIMUM_CAPACITY : n + 1;
    }
      /** * * 构造一个含有传入Mapy元素的的HashMap、加载因子为默认0.75 */
    public HashMap(Map<? extends K, ? extends V> m) {
        this.loadFactor = DEFAULT_LOAD_FACTOR;
        //根据传入Map的大小,若table为null生成table,并将Map中的元素数据插入。
        putMapEntries(m, false);
    }

    final void putMapEntries(Map<? extends K, ? extends V> m, boolean evict) {
        int s = m.size();
        if (s > 0) {
            if (table == null) { // pre-size
            //通过加载因子计算,table扩容初始长度
                float ft = ((float)s / loadFactor) + 1.0F;
                int t = ((ft < (float)MAXIMUM_CAPACITY) ?
                         (int)ft : MAXIMUM_CAPACITY);
                if (t > threshold)
                    //通过tableSizefor获得一个大于t的最小2^n次方数 作为扩容临界变量值
                    threshold = tableSizeFor(t);
            }
            else if (s > threshold)
                resize();//tabel不为null,且s大于扩容临界值,则调用
            for (Map.Entry<? extends K, ? extends V> e : m.entrySet()) {
                K key = e.getKey();
                V value = e.getValue();
                //真正的插入数据
                putVal(hash(key), key, value, false, evict);
            }
        }
    }
    //当HashMap中的容量大于扩容临界值,会调用此方法扩容
   final Node<K,V>[] resize() {
        //缓存旧table 旧容量,旧扩容临界值
        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;//HashMap table数组超过最大值,不扩容
            }
            else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
                     oldCap >= DEFAULT_INITIAL_CAPACITY)
                newThr = oldThr << 1; // table容量和下次扩容临界值都乘以2(翻倍)
        }
        else if (oldThr > 0) // oldCap<0且就扩容临界值大于0,则将新的table容量为旧的扩容临界值(指定初始容量的构造函数,第一次插入数据会走此逻辑)
            newCap = oldThr;//
        else {               // 无参构造,第一次插入数据,会走此逻辑。
            newCap = DEFAULT_INITIAL_CAPACITY;//容量16
            newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);//扩容临界值 16*0.75
        }
        if (newThr == 0) {
        (指定初始容量的构造函数,第一次插入数据会走此逻辑)计算Map下次扩容临界值
            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数组。
        table = newTab;//将新生成的table数组,赋值给table成员变量
        //将就缓存的oldTab中的数据节点赋值到新的table中
        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;//头节点没有下一个节点,通过节点hash求余找到在新table中的位置,并赋值
                    else if (e instanceof TreeNode)
                        ((TreeNode<K,V>)e).split(this, newTab, j, oldCap);//头结点为TreeNode 
                    else { // 头节点不为空,切不是TreeNode则遍历链表,并将每个节点,放到新表中的合适位置
                    //新旧table同样位置节点构造新链表
                        Node<K,V> loHead = null, loTail = null;
                    //新旧table不同位置节点构造新链表
                        Node<K,V> hiHead = null, hiTail = null;
                        Node<K,V> next;
                        do {
                            next = e.next;
                            if ((e.hash & oldCap) == 0) {//节点在旧table中的位置,与在新表中也在同样位置,构造一个新链表
                                if (loTail == null)
                                    loHead = e;//头结点赋值
                                else
                                    loTail.next = e;//添加到链表尾部
                                loTail = e;//移动尾指针
                            }
                            else {
                            //节点在旧table中的位置,与在新表中不在同样位置,构造一个新链表
                                if (hiTail == null)
                                    hiHead = e;
                                else
                                    hiTail.next = e;
                                hiTail = e;
                            }
                        } while ((e = next) != null);
                        if (loTail != null) {
                            loTail.next = null;
                            newTab[j] = loHead;//将新旧同样位置的链表移动到新table数组的相应位置
                        }
                        if (hiTail != null) {
                        //将新旧不同样位置的链表移动到新table数组的相应位置(在新table表中的高位)
                            hiTail.next = null;
                            newTab[j + oldCap] = hiHead;
                        }
                    }
                }
            }
        }
        //返回扩容后的table。
        return newTab;
    }

说明:
构造函数构造的都是空Map,真正存储节点数据时候,才会真正构造table数组。
table数组的长度总为2^n次方,由tableForSize函数求出。
resize方法中通过与运算,代替了求余运算。
hashMap扩容的时候,新表长度扩容临界值均为旧表的2倍,就table中的node在新table中的位置,要么不变,要么是原来索引位置平移oldCap长度。由e.hash & oldCap是否等于0计算得出。

新增元素/修改元素

//新增一个元素/或修改一个元素
     public V put(K key, V value) {
     //内部真实插入数据方法
        return putVal(hash(key), key, value, false, true);
    }
  //计算key值的hash值
  static final int hash(Object key) {
        int h;
        key==null返回0,其余值返回key值的hashCode并加入扰动处理,与自己低位异或运算,减少碰撞次数。
        return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
    }
    //hashMap的内部插入数据函数
    /** * @param key在hash值 * @param 插入数据的key * @param 插入数据的Value * @param onlyIfAbsent 当为true的时候不覆盖已存在的Value * @param evict 当为false的时候,表示Map为创建状态 * @return previous value, or null if none */
    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;//空Map调用resize()构造table数组
        if ((p = tab[i = (n - 1) & hash]) == null)//求余查找table位置,该位置为空,表示无节点,则直接构造节点,并赋值。
            tab[i] = newNode(hash, key, value, null);//newNode构造新节点
        else {//对应table位置已有值,则分为两种逻辑,一种key相同,则onlyIfAbsent||valueNULL决定是否覆盖,一种key不同发生碰撞,则构造链表或转换红黑树存储。
            Node<K,V> e; K k;
            if (p.hash == hash &&
                ((k = p.key) == key || (key != null && key.equals(k))))
                e = p;//key相同,缓存当前节点
            else if (p instanceof TreeNode)//当前节点为红黑树,分析TreeMap再说
                e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
            else {//key不相同,有可能首次出现碰撞
                for (int binCount = 0; ; ++binCount) {
                    if ((e = p.next) == null) {//遍历当到单向链表尾部,没有找到key相同的节点,发生首次碰撞,放到链表尾部,并结束循环
                        p.next = newNode(hash, key, value, null);//构造一个新节点
                        if (binCount >= TREEIFY_THRESHOLD - 1) //链表数量大于等于8个转换为红黑树
                            treeifyBin(tab, hash);
                        break;
                    }
                    if (e.hash == hash &&
                        ((k = e.key) == key || (key != null && key.equals(k))))
                        break;//若在链表中找到相同的key(已处理过的碰撞)则缓存查找到的节点并结束循环
                    p = e;
                }
            }
            if (e != null) { // existing mapping for key
                V oldValue = e.value;
                if (!onlyIfAbsent || oldValue == null)//更加是否覆盖标志和value值,选择对已存在的节点数据赋值。
                    e.value = value;
                afterNodeAccess(e);//空实现
                return oldValue;//返回旧节点
            }
        }
        ++modCount;//对新增加数据,则修改Map结构变化状态值。
        if (++size > threshold)
            resize();//大于临界扩容值,进行扩容。
        afterNodeInsertion(evict);//空实现
        return null;//对于新增数据则,返回null
    }
    //向Map中插入一个Map
   public void putAll(Map<? extends K, ? extends V> m) {
        putMapEntries(m, true);//在构造函数部分已经做过注释介绍。
    }

查找元素

//通过key获取Value值
    public V get(Object key) {
        Node<K,V> e;
        return (e = getNode(hash(key), key)) == null ? null : e.value;
    }

  //通过key的hash值,和Key查找对应节点
    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)
                    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;//没有找到对应节点
    }

删除元素

//通过key移除某个value
    public V remove(Object key) {
        Node<K,V> e;
        //调用removeNode移除hash表中的对应节点
        return (e = removeNode(hash(key), key, null, false, true)) == null ?
            null : e.value;
    }
//移除节点 matchValue表示是否通过value匹配移除,
    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;
        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;
            if (p.hash == hash &&
                ((k = p.key) == key || (key != null && key.equals(k))))
                node = p;//直接通过索引获取节点
            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);
                }
            }
            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;//直接移除,将table[i]置null
                else
                    p.next = node.next;//将节点从链表中移除
                ++modCount;//修改map结构改变变量值
                --size;//容量减一
                afterNodeRemoval(node);//空实现
                return node;//返回移除节点
            }
        }
        return null;//返回空
    }

其它方法

迭代器
//抽象迭代器类
    abstract class HashIterator {
        Node<K,V> next;        //下一个节点
        Node<K,V> current;     // 当前节点
        int expectedModCount;  // 是否发生过变化modeCount
        int index;             // 遍历到数组的那个位置
        //默认构造方法
        HashIterator() {
            expectedModCount = modCount;//赋值modeCount 
            Node<K,V>[] t = table;//缓存当前table数组
            current = next = null;//节点置空
            index = 0;//数组索引置0
            if (t != null && size > 0) { // advance to first entry
                do {} while (index < t.length && (next = t[index++]) == null);//index指向数组中第一个不为空的索引位置next!=NULL
            }
        }
//是否有下一个元素
        public final boolean hasNext() {
            return next != null;
        }
//获取下一个节点
        final Node<K,V> nextNode() {
            Node<K,V>[] t;
            Node<K,V> e = next;
            if (modCount != expectedModCount)//遍历的时候,发生变化,fast-fail
                throw new ConcurrentModificationException();
            if (e == null)
                throw new NoSuchElementException();
            if ((next = (current = e).next) == null && (t = table) != null) {//下一个节点为空,且table不为空
                do {} while (index < t.length && (next = t[index++]) == null);//index指向下一个不为空的table索引位置
            }
            return e;返回当前节点
        }
//移除当迭代器的节点
        public final void remove() {
            Node<K,V> p = current;
            if (p == null)
                throw new IllegalStateException();
            if (modCount != expectedModCount)
                throw new ConcurrentModificationException();
            current = null;
            K key = p.key;
            removeNode(hash(key), key, null, false, false);
            expectedModCount = modCount;
        }
    }
    //key迭代器实现类
    final class KeyIterator extends HashIterator implements Iterator<K> {
        public final K next() { return nextNode().key; }
    }
    //Value迭代器实现类
    final class ValueIterator extends HashIterator implements Iterator<V> {
        public final V next() { return nextNode().value; }
    }
    //Entry迭代器实现类
    final class EntryIterator extends HashIterator implements Iterator<Map.Entry<K,V>> {
        public final Map.Entry<K,V> next() { return nextNode(); }
    }

说明:通过迭代器可以实现对Map的key遍历,Value遍历,Entry遍历。
希望对您有所帮助!

    原文作者:GeeK_1024Wei
    原文地址: https://blog.csdn.net/qq_22494029/article/details/81485868
    本文转自网络文章,转载此文章仅为分享知识,如有侵权,请联系博主进行删除。
点赞