HashMap 源码解读

HashMap 源码解读

在很多面试中，都会涉及到HashMap的问题，比如说问你HashMap存储结构，get、put的时间复杂度，或者扩容机制等等，这次我们来通过对源码的阅读，来实现对HashMap的理解！（大量源码源码警告！！！）
先看类的继承结构：

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

可以看到HashMap继承了抽象类AbstractMap，实现了Map、Cloneable、Serializable接口。
这边有点奇怪，明明抽象类AbstractMap已经实现了Map接口，为什么HashMap又要实现一下？可能的原因：1、为了使用getInterfaces可以获取到Map，因为这样子没法获取到父类的接口；2、笔误（据说是作者 Jpsh Bloch自己说的。。。）
对于这些接口中的方法就不单独解释了，下面一起来看源码就好。

首先是一些常量属性：

// 默认初始化容量，16。必须是 2 的幂次。
static final int DEFAULT_INITIAL_CAPACITY = 1 << 4; // aka 16

// 最大容量 2^30，在构造函数中可以设置，必须是 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;

// 变成表结构的容量，小于等于 6 就从红黑树结构变成了表结构
static final int UNTREEIFY_THRESHOLD = 6;

// 红黑树结构的最小容量，最少是 4 * TREEIFY_THRESHOLD 以避免重构时的冲突
static final int MIN_TREEIFY_CAPACITY = 64;

然后是一个静态内部类Node<K,V>：

	// 实现了 Entry 接口可用于 AbstractMap 中的方法
	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;
        }
        // Node 的 get、set 方法，用于被外部类方法调用
        public final K getKey()        { return key; }
        public final V getValue()      { return value; }
        public final String toString() { return key + "=" + value; }

        // 键的 hash 值 ^ 值的 hash 值
        // 这边我们其他的可以不了解，但是 String 的 hash 算法必须了解。
        public final int hashCode() {
            return Objects.hashCode(key) ^ Objects.hashCode(value);
        }

        public final V setValue(V newValue) {
            V oldValue = value;
            value = newValue;
            return oldValue;
        }

        // 两个节点的比较，先比较地址，否则如果是 Map.Entry 则分别比较键和值
        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;
        }
    }

看完了内部存储键值对的静态内部类，接下来看静态方法：

	// 查看某个键的 hash 值，在基础的 hashCode() 方法后又对其进行了处理
	static final int hash(Object key) {
        int h;
        return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
    }

    // x 如果直接实现了 comparable 接口，就返回 x 的 Class，否则返回 Null
    static Class<?> comparableClassFor(Object x) {
    	...
    }

    // 如果 x 是 kc 类型，返回 k.compareTo(x) 的结果，否则返回 0
    static int compareComparables(Class<?> kc, Object k, Object x) {
        return (x == null || x.getClass() != kc ? 0 :
                ((Comparable)k).compareTo(x));
    }

    // 这边是返回最小的大于 cap 的 2 的幂次，比如说 cap 为 3 则结果是 4， cap 为 5 则结果是 8 。|= 就是按位或后赋值。
    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;
    }

接下来是一些变量属性：

// 表结构是存储的内容
transient Node<K,V>[] table;

// 
transient Set<Map.Entry<K,V>> entrySet;

// 键值对数量
transient int size;

// 当发生结构性变化时增加，用于表面遍历时对HashMap进行修改操作
transient int modCount；

// 下一次 resize 的值
int threshold;

// hash table 的装载因子
final float loadFactor;

再下面是 public 的操作：

	/** 
	* 构造函数们
	*/

	// 传入初始容量和装载因子的构造函数，这里可以看到，initialCapacity 并不是直接去创建这个大小的数组，而是使用 tableSizeFor 函数后传递给了 threshold 属性
	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);
    }

    // 传入初始容量，并使用默认的装载因子调用上面的构造函数
    public HashMap(int initialCapacity) {
        this(initialCapacity, DEFAULT_LOAD_FACTOR);
    }

    // 无参的构造函数，默认调用
    public HashMap() {
        this.loadFactor = DEFAULT_LOAD_FACTOR; // all other fields defaulted
    }

    // 将 m 的节点放入表或者树中
    public HashMap(Map<? extends K, ? extends V> m) {
        this.loadFactor = DEFAULT_LOAD_FACTOR;
        putMapEntries(m, false);
    }

    // 实现了 Map 接口中的 putAll 方法
    final void putMapEntries(Map<? extends K, ? extends V> m, boolean evict) {
        // 获取 m 的大小
        int s = m.size();
        if (s > 0) {
        	// 当 HashMap 为空时，也就是没有内容时，计算 t 和 threshhold进行比较
            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);
            }
            // 如果 m 的大小比下一次 resize 的值要大，直接 resize
            else if (s > threshold)
                resize();
             // 遍历 m 将节点进行保存
            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);
            }
        }
    }

    // 返回键值对数量
    public int size() {
        return size;
    }

    // 返回键值对数量是否为0（即 HashMap 是否还没有键值对）
    public boolean isEmpty() {
        return size == 0;
    }

    // 通过 getNode 的方法获取对应 key 的节点的 value
    public V get(Object key) {
        Node<K,V> e;
        return (e = getNode(hash(key), key)) == null ? null : e.value;
    }

    // 利用 key 的 hash 值以及 key 获取对应 key 的 Node
    final Node<K,V> getNode(int hash, Object key) {
        Node<K,V>[] tab; Node<K,V> first, e; int n; K k;
        // 这个判断有三部分，第一部分判断存储数组是否为空，第二部分判断数组长度是否为0，第三部分判断 (n-1) & hash 值的位置是否存在该 key 对应的节点（这样主要是因为 put 的时候就是这么存的）
        if ((tab = table) != null && (n = tab.length) > 0 &&
            (first = tab[(n - 1) & hash]) != null) {
            // 如果 key 的 hash 值和对应节点 key 的 hash 值相等并且 key 相等或者 equals 之后相等且不为 null，则返回该节点
            if (first.hash == hash && // always check first node
                ((k = first.key) == key || (key != null && key.equals(k))))
                return first;
            // 如果上面的不成立，并且 first 节点上有 next（next 应该是解决 hash 冲突的解决方案）
            if ((e = first.next) != null) {
            	// 如果是 TreeNode（表明是红黑树的结构），那么利用 hash 值和 key 找到红黑树中的节点
                if (first instanceof TreeNode)
                    return ((TreeNode<K,V>)first).getTreeNode(hash, key);
                // 否则，不断的找冲突解决方案中的 next 直到找到对应节点或者找完
                do {
                    if (e.hash == hash &&
                        ((k = e.key) == key || (key != null && key.equals(k))))
                        return e;
                } while ((e = e.next) != null);
            }
        }
        return null;
    }

    // 利用 key 和 getNode 方法找到节点，没找到就没有该 key 对应的节点  
    public boolean containsKey(Object key) {
        return getNode(hash(key), key) != 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;
        // 如果存储数组为 null 或者数组长度为0，那么将存储从结构 resize 一下后赋值给数组并将长度赋值给 n
        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);
        // 如果对应地方有节点，那么只可能有两种情况：1、对应的键存在，那么修改值；2、表结构起冲突了不够存了，要么在该节点的位置增加 next 冲突节点，或者转换成树结构的 putval 方法
        else {
            Node<K,V> e; K k;
            // 表结构对应位置存在对应的 key 的节点，那么将 e 赋值成为该节点
            if (p.hash == hash &&
                ((k = p.key) == key || (key != null && key.equals(k))))
                e = p;
            // 如果表结构对应位置的 key 跟说好的不一样，并且该位置是个 TreeNode，那么调用树结构的 putVal 操作
            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);
                        if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
                            treeifyBin(tab, hash);
                        break;
                    }
                    // 找到该位置冲突节点中需要的值了，赋值给 e
                    if (e.hash == hash &&
                        ((k = e.key) == key || (key != null && key.equals(k))))
                        break;
                    p = e;
                }
            }
            // 对已经有的对应 key 的键值对，进行值的替换并返回旧的值
            if (e != null) { // existing mapping for key
                V oldValue = e.value;
                if (!onlyIfAbsent || oldValue == null)
                    e.value = value;
                // 这边是一个回调函数，对节点进行修改后会调用这个函数，HashMap中没有定义具体方法
                afterNodeAccess(e);
                return oldValue;
            }
        }
        // 新增节点后的处理工作：增加修改次数、增加键值对数量并决定要不要 resize、增加节点后的方法（同样是回调函数，HashMap中没定义）
        ++modCount;
        if (++size > threshold)
            resize();
        afterNodeInsertion(evict);
        return null;
    }

    // resize 方法是将数组进行扩容，不是将表结构转换成树结构
    final Node<K,V>[] resize() {
        Node<K,V>[] oldTab = table;
        int oldCap = (oldTab == null) ? 0 : oldTab.length;
        int oldThr = threshold;
        int newCap, newThr = 0;
        if (oldCap > 0) {
        	// 如果原本的长度大于等于最大值，就把 threshold设置成最大值
            if (oldCap >= MAXIMUM_CAPACITY) {
                threshold = Integer.MAX_VALUE;
                return oldTab;
            }
            // 否则将新长度变成旧长度 * 2, 将 threshold * 2
            else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
                     oldCap >= DEFAULT_INITIAL_CAPACITY)
                newThr = oldThr << 1; // double threshold
        }
        // 如果原来容量为0，那么把原来的 threshold 赋值给新的容量
        else if (oldThr > 0) // initial capacity was placed in threshold
            newCap = oldThr;
        // 如果原来的 threshold 为0，那么使用默认值进行赋值
        else {               // zero initial threshold signifies using defaults
            newCap = DEFAULT_INITIAL_CAPACITY;
            newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
        }
        // 如果新的 threshold 为0，就使用默认值计算出新的 threshold
        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;
    }

    // 如果原来的数组长度小于最小变成树的值，那么 resize，否则把指定 hash 位置的普通的 Node 转化成 TreeNode（TreeNode也是个静态内部类