HashMap源码解析【细致入微级！！】-java黑洞网

本站消息

站长简介/公众号

出租广告位,需要合作请联系站长

快起来搬砖啦

569

文章

271322

访问

+关注

分类

暂无分类

日期归档

2023-06(3)

HashMap源码解析【细致入微级！！】

发布于2021-05-29 20:31 阅读(1122) 评论(0) 点赞(25) 收藏(1)

JDK1.8

HashMap继承了AbstractMap类，实现了Map、Cloneable、Serializable接口

一些静态常量


	// 表示HashMap中默认数组长度为16(必须要为2的幂次)
	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;
    // 在数组容量大小小于64时，链表长度大于8不转化为红黑树而是扩容数组大小
    static final int MIN_TREEIFY_CAPACITY = 64;

HashMap中的数据结构为Node，实现了Map接口中的Entry

    static class Node<K,V> implements Map.Entry<K,V> {
    // 保存一个node的哈希值用于比较Map中两个元素是否相等
        final int hash;
        final K key;
        V value;
        Node<K,V> next;

Node中允许得到Key与Value，并且可以设置Value，但是不能设置Key。并且重写了hashCode和equles方法，来判断两个Node是否相等。

        public final int hashCode() {
        // 调用的都是key和value所属类的hashCode方法
            return Objects.hashCode(key) ^ Objects.hashCode(value);
        }

Node中的equals方法

        public final boolean equals(Object o) {
        // 比较此node与被比较对象o内存地址是否相等，相等直接返回true
            if (o == this)
                return true;
                // 先判断o是否属于Map.Entry的一个对象
            if (o instanceof Map.Entry) {
            // 类型强转
                Map.Entry<?,?> e = (Map.Entry<?,?>)o;
//                使用Objects.equals分别判断o和此node两者的key与value是否相同
                if (Objects.equals(key, e.getKey()) &&
                    Objects.equals(value, e.getValue()))
                    return true;
            }
            return false;
        }
    }

    // Objects.equals
    public static boolean equals(Object a, Object b) {
    // 内存地址相同返回true
    // 或者a在不为null的情况下调用a的equals方法和b相同返回true
        return (a == b) || (a != null && a.equals(b));
    }

一些静态的实用方法

// HashMap的哈希函数
    static final int hash(Object key)

// 用于判断x所属类是否实现了Comparable接口，实现了就返回x的类，否则返回null
    static Class<?> comparableClassFor(Object x)

// x属于kc类的话，调用k.compareTo(x),否则返回0
    static int compareComparables(Class<?> kc, Object k, Object x)

// 用于把给定的数组容量cap值转化为2的幂次方
// 比如15变成16
    static final int tableSizeFor(int cap)

一些字段

// 由node元素组成的table数组，在首次使用的时候被初始化，并在需要的时候重新调整数组大小。数组长度始终是2的幂次
    transient Node<K,V>[] table;

// 用于缓存
    transient Set<Map.Entry<K,V>> entrySet;

// 此map中键值对的数量
    transient int size;

// 用于记录map发生结构性更改的次数，结构性更改包括改变map的大小，以及rehash等。（是否与CAS中的ABA有关？）
    transient int modCount;

// 门限值，指map的数组大小达到了此值应该resize扩容（此值等于capacity * loadFactor）
    int threshold;

// 负载因子
    final float loadFactor;

一些公共方法

构造器


// 指定初始的数组容量（大小），和负载因子
    public HashMap(int initialCapacity, float loadFactor) {
    // 初始容量<0抛出异常
        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;
        // 这里用到前面的tableSizeFor实用方法，用来把初始容量转换为2的幂次
        // 设置threshold用来作为下一次扩容的门限
        this.threshold = tableSizeFor(initialCapacity);
    }




// 指定初始容量，使用默认负载因子
    public HashMap(int initialCapacity) {
        this(initialCapacity, DEFAULT_LOAD_FACTOR);
    }




// 空参构造器，需要使用默认负载因子
    public HashMap() {
        this.loadFactor = DEFAULT_LOAD_FACTOR; 
    }



// 可以使用其他键值继承与K与V的Map对象创建HashMap<K, V>
    public HashMap(Map<? extends K, ? extends V> m) {
        this.loadFactor = DEFAULT_LOAD_FACTOR;
        putMapEntries(m, false);
    }

这里可以看出，在实际new出一个HashMap对象的时候，构造器只会创建一个空的table数组，只有在后面进行实际操作的时候才进行初始化，哪怕是为构造器指定了初始容量。

// 主要执行把旧Map放入新Map的操作
    final void putMapEntries(Map<? extends K, ? extends V> m, boolean evict) {
        int s = m.size();
        if (s > 0) {
        // 设置一下新扩容门限
            if (table == null) { // pre-size
                float ft = ((float)s / loadFactor) + 1.0F;
                int t = ((ft < (float)MAXIMUM_CAPACITY) ?
                         (int)ft : MAXIMUM_CAPACITY);
                if (t > threshold)
                    threshold = tableSizeFor(t);
            }
            // 如果旧map大小大于新map门限，扩容
            else if (s > threshold)
                resize();
                // 遍历旧Map把其中元素放去新Map
            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);
            }
        }
    }

get方法

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

这里调用getNode方法，进行判断，返回非null值则返回e的value值，e是一个Node

    final Node<K,V> getNode(int hash, Object key) {
    // 创建Node数组tab、Node节点first、e，int值n，以及key类型的对象k
        Node<K,V>[] tab; Node<K,V> first, e; int n; K k;
   // 把Map中数组table赋给tab，要求其不等于null
   // 数组table长度赋给n，要求其大于0
   // first是table数组经过数组下标转换，传入的hash值对应的位置上的值，即key对应的Node在数组中的位置上的Node。要求其不能为null
        if ((tab = table) != null && (n = tab.length) > 0 &&
            (first = tab[(n - 1) & hash]) != null) {
  // 检查first的hash值是否与传入的哈希值相同
  // 相同就继续判断first的key值（赋给k）是否与传入的key值相同
  // 还相同就继续判断传入的key值是否为null且是否与k相等
  // 最后全部为true说明要get的Node就是first，直接返回first
            if (first.hash == hash && // always check first node
                ((k = first.key) == key || (key != null && key.equals(k))))
                return first;
  // 判断first的next属性是否为null（first这个Node是否是一个链表）
            if ((e = first.next) != null) {
  // 是链表的情况，再判断这个链表是不是已经转化为了一棵红黑树
                if (first instanceof TreeNode)
  // 直接调用红黑树的getTreeNode方法
                    return ((TreeNode<K,V>)first).getTreeNode(hash, key);
  // 不是红黑树那就是链表，遍历这个链表，和上方做同样的判断，找到对应Node
                do {
                    if (e.hash == hash &&
                        ((k = e.key) == key || (key != null && key.equals(k))))
                        return e;
                } while ((e = e.next) != null);
            }
        }
        return null;
    }

其中对传入的key和key的hash值做了三次检验：1、哈希值是否相同 2、key值的地址是否相等 3、key是否不为null且通过key的equals方法

containsKey方法

    public boolean containsKey(Object key) {
        return getNode(hash(key), key) != null;
    }

也是通过getNode方法来实现

put方法

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

调用了putVal方法来实现

// onlyIfAbsent:如果为true就不要改动已经存在的value，因此上面的put方法传入false就要求替换原有value
    final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
                   boolean evict) {
  // tab：现在的table数组，p传入的key的hash值所对应现在数组中的数组下标映射的Node
  // n：table数组长度，i
        Node<K,V>[] tab; Node<K,V> p; int n, i;
  // 如果put的时候数组还未初始化，或者数组长度为0，执行resize方法扩容
        if ((tab = table) == null || (n = tab.length) == 0)
            n = (tab = resize()).length;
  // 如果传入key的hash对应的table中位置是空的，直接new一个Node放在此位置上
        if ((p = tab[i = (n - 1) & hash]) == null)
            tab[i] = newNode(hash, key, value, null);
  // 否则就是老一套，查看哈希值相等不、key值内存地址相等不、key的equals方法相等不
        else {
            Node<K,V> e; K k;
            if (p.hash == hash &&
                ((k = p.key) == key || (key != null && key.equals(k))))
  // 通过说明此处就是要找的Node，赋给e
                e = p;
  // 发现p所在位置是个红黑树，调用putTreeVal方法把新值放进去
            else if (p instanceof TreeNode)
                e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
  // 当前Node的Key不等且不是红黑树，说明可以转化成链表来放置新Node，也或者原来就存在链表
            else {
                for (int binCount = 0; ; ++binCount) {
  // 采用尾插法，发现当前Node的next为空，就把新Node插到当前Node后面也就是指向next
                    if ((e = p.next) == null) {
                        p.next = newNode(hash, key, value, null);
  // 如果发现当前遍历到的节点已经>=转化为红黑树的阈值-1，说明再查一个就到达阈值8，该调用treeifyBin转化成红黑树了
                        if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
                            treeifyBin(tab, hash);
                        break;
                    }
 // 这里是如果发现了当前遍历到的Node和新Node匹配，即Key相同，就直接跳出，说明后面要给当前Node赋值value了
                    if (e.hash == hash &&
                        ((k = e.key) == key || (key != null && key.equals(k))))
                        break;
                  // 执行遍历链表用
                    p = e;
                }
            }
            if (e != null) { // existing mapping for key
            // 记录下当前Node的旧value值
                V oldValue = e.value;
     // 表示当前map是可以修改或者旧value值为空的情况下，把新传入的value值赋给旧Node上
                if (!onlyIfAbsent || oldValue == null)
                    e.value = value;
          // 留给子类去重写的方法，比如LinkedHashMap中用来把新加入的值加入最后的节点
                afterNodeAccess(e);
             // 返回旧值
                return oldValue;
            }
        }
    // modCount自增，记录一下map发生结构性变化的次数
        ++modCount;
    // 如果当前数组大小等于门限值了，就要扩容
        if (++size > threshold)
            resize();
    // 也是提供给LinkedHashMap重写的方法
        afterNodeInsertion(evict);
     // 没成功就返回null
        return null;
    }

总结一下，如果根据put的key的hash值计算出的数组位置是空的，就直接把这个Node放进去，否则看当前位置Node的key是否与put进来的key相同（要检查三步：hash值、内存地址、equals方法），相同直接替换。不相同检查此位置上是不是保存红黑树，保存红黑树就放入红黑树中。否则直接在此位置上创建一个链表（如果之前没有链表）把新值通过尾插法放进去。

resize()方法

    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;
            }
            // 这里把新表大小设置为旧表大小的两倍
            else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
                     oldCap >= DEFAULT_INITIAL_CAPACITY)
            // 还要旧表大小大于默认值，把新表门限设为旧表门限的两倍
                newThr = oldThr << 1; // double threshold
        }
        // 表示旧表为空，但门限不为0，此种情况在使用带有initialCapacity参数
        // 的构造器生成的map中会发生。这会把门限设置为自定义的值（转化为对应的2次幂的大小）
        // 此时容量没有被指定，table数组没有被初始化，一切等到到了put的这步操作开始
        else if (oldThr > 0) // initial capacity was placed in threshold
            newCap = oldThr;    // 把旧门限赋给新容量
        // 数组为空，门限为0
        else {               // zero initial threshold signifies using defaults
        // 使用默认16的容量
            newCap = DEFAULT_INITIAL_CAPACITY;
        // 门限为容量*负载因子
            newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
        }
        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数组作为新表
        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;
    }