【类集源码】HashMap的源码分析

HashMap

一、成员变量。

先简单解释一下，下面查看方法的时候，会具体解释。

transient Node<K,V>[] table;     //这个Node是HashMap中的一个内部类，用它的对象数组来存储K,V值
 
transient Set<Map.Entry<K,V>> entrySet;  //这个变量主要是为了保存将map转换为set之后的数据。

transient int size;     //这个是map中的元素个数

transient int modCount;    //map被修改的次数

final float loadFactor;    //这个值是装载因子，就是 存储的元素/数组最大容量 的值。

 int threshold;      //一个临界值，计算方法是  数组最大容量*装载因子。也就是map中最多存储的值，如果超过这个值map就要扩容

二、构造方法

1.无参构造

 public HashMap() {
        this.loadFactor = DEFAULT_LOAD_FACTOR; // all other fields defaulted
    }

 static final float DEFAULT_LOAD_FACTOR = 0.75f;

对装载因子，进行初始化赋值。默认值为0.75

2.有参构造，参数类型为int。

public HashMap(int initialCapacity) {
        this(initialCapacity, DEFAULT_LOAD_FACTOR);
    }

传入整型，然后方法内，这个整型配合默认的装载因子，一起调用另一个有参构造。下面介绍。

3.有参构造，参数类型为int和float

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);
    }

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;
    }

方法内进行安全检查，不能小于0并且不能太大。
然后调用tableSizeFor方法，这个方法很巧妙，返回大于输入参数且最近的2的整数次幂的数，n移位的部分，就是将n的最高位为1的位置之后的位置全部变为了1.。然后最终返回n+1。就变为了2的整数次幂。一开始cap-1，是因为如果参数为8，也就是1000，那么当它位移操作结束就是1111，最终+1之后是10000为16，显然我们需要返回8.

4.有参构造，参数类型为Map

 public HashMap(Map<? extends K, ? extends V> m) {
        this.loadFactor = DEFAULT_LOAD_FACTOR;
        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
                float ft = ((float)s / loadFactor) + 1.0F;
                int t = ((ft < (float)MAXIMUM_CAPACITY) ?
                         (int)ft : MAXIMUM_CAPACITY);
                if (t > threshold)
                    threshold = tableSizeFor(t);
            }
            else if (s > threshold)
                resize();
            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);
            }
        }
    }

//putAll方法调用的就上面这个方法。
public void putAll(Map<? extends K, ? extends V> m) {
        putMapEntries(m, true);
    }

这个HashMap(Map<? extends K, ? extends V> m)功能，最终实现的就是用参数中map内所有的元素，创建一个新的map。
具体实现就是先将默认值0.75赋值给当前map的负载因子，然后调用putMapEntries，此方法主要任务就是，判断当前map中的table（保存数组的哈希表），是否为null。
因为我们是用构造方法调用的此方法，所以table必定为空，所以将参数中的 （map数量/负载因子）调用tableSizeFor（上面讲解的方法）方法 返回的值 作为新的table容量。
所以不会调用resize方法（HashMap的扩容策略，下面讲）。
遍历 参数中的Map集合，取出它的key和value值，调用putVal方法。

final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
                   boolean evict) {
        Node<K,V>[] tab; Node<K,V> p; int n, i;
        //判断当前调用此方法的hashmap是否为null，因为目前是构造方法中调用此方法，所以table为null。
        if ((tab = table) == null || (n = tab.length) == 0)
            n = (tab = resize()).length;   
            //如果根据哈希值，获取的当前数组下标处的元素为null。就直接创建一个节点放到此下标处。
        if ((p = tab[i = (n - 1) & hash]) == null)
            tab[i] = newNode(hash, key, value, null);
        else {//说明当前下标处有元素，发生哈希冲突了
            Node<K,V> e; K k;
            //判断当前下标处的元素p是否和需要插入元素的key值相同
            if (p.hash == hash &&
                ((k = p.key) == key || (key != null && key.equals(k))))
                e = p;
                //判断元素p是否已经是树化之后的节点，
            else if (p instanceof TreeNode) 
            		//如果是    当前需要插入的key，value就需要遵循树的规则插入
                e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
            else {
                for (int binCount = 0; ; ++binCount) {
                 	//判断p链表的下一个节点是否为null，并且将e指向下一个节点
                    if ((e = p.next) == null) {
                    //如果为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;
                    //每次循环走到这一步，e的指向都是p的下一个节点，所以这一步实现链表遍历。
                    p = e;
                }
            }
            //如果e不等于null。说明是在遍历链表途中遇到了相同节点。
            if (e != null) { // existing mapping for key
                V oldValue = e.value;
                //如果此方法传入的参数，允许覆盖旧值或者旧值本身就为null。
                if (!onlyIfAbsent || oldValue == null)
                	//新值覆盖旧值
                    e.value = value;
                 //此方法是预留给子类LinkedHashMap的回调方法。
                afterNodeAccess(e);
                return oldValue;
            }
        }
        ++modCount;
        //在这次添加元素之后，如果size的值大于threshold了，就扩容。
        if (++size > threshold)
            resize();
           //此方法是预留给子类LinkedHashMap的回调方法。
        afterNodeInsertion(evict);
        return null;
    }

HashMap的put方法调用的就是上面这个方法。

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

三、包方法comparableClassFor(Object x)和compareComparables(Class<?> kc, Object k, Object x)

只有当传入对象的运行时类型符合”class C implements Comparable”这个条件时，返回对象的运行时类型，否则返回null。下面看一下这个方法的过程。

static Class<?> comparableClassFor(Object x) {
		//判断x在继承链上是否实现了Comparable接口。
        if (x instanceof Comparable) {
            Class<?> c; Type[] ts, as; Type t; ParameterizedType p;
            //返回x的运行时类型，赋值给c，判断是否是String类
            if ((c = x.getClass()) == String.class) // bypass checks
                return c;
              //返回c对象的运行时类型“直接实现”的接口
            if ((ts = c.getGenericInterfaces()) != null) {
                for (int i = 0; i < ts.length; ++i) {
                    if (((t = ts[i]) instanceof ParameterizedType) &&
                        ((p = (ParameterizedType)t).getRawType() ==
                         Comparable.class) &&
                        (as = p.getActualTypeArguments()) != null &&
                        as.length == 1 && as[0] == c) // type arg is c
                        return c;
                }
            }
        }
        return null;
    }

compareComparables(Class<?> kc, Object k, Object x)方法，就是当x的类型为kc的时候，返回k.compareTo(x)的比较结果。
否则如果x为null，或者类型不是kc的时候，返回0.

四、get方法

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


final Node<K,V> getNode(int hash, Object key) {
        Node<K,V>[] tab; Node<K,V> first, e; int n; K k;
        //如果当前table不为null，并且长度大于0，并且当前hash位置的元素不为null。
        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);
                //否则就遍历链表，如果碰到需要查找的key，就返回此节点。
                do {
                    if (e.hash == hash &&
                        ((k = e.key) == key || (key != null && key.equals(k))))
                        return e;
                } while ((e = e.next) != null);
            }
        }
        return null;
    }

containsKey方法底层调用的也是getNode方法。

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

五、replaceAll方法和replace方法

public void replaceAll(BiFunction<? super K, ? super V, ? extends V> function) {
        Node<K,V>[] tab;
        if (function == null)
            throw new NullPointerException();
        if (size > 0 && (tab = table) != null) {
            int mc = modCount;
            for (int i = 0; i < tab.length; ++i) {
                for (Node<K,V> e = tab[i]; e != null; e = e.next) {
                    e.value = function.apply(e.key, e.value);
                }
            }
            if (modCount != mc)
                throw new ConcurrentModificationException();
        }
    }

遍历整个map集合的元素，然后每一个k，v键值对，都执行apply方法（一般在调用此方法时候，参数部分用匿名内部类方式定义此方法）。方法内部一般定义一个正则表达式去寻找匹配的key，value值，然后将方法的返回值赋值给当前节点的value。

@Override
    public boolean replace(K key, V oldValue, V newValue) {
        Node<K,V> e; V v;
        //根据hash和key找到对应的节点不为null，此节点的value值必须和所期望的一样
        if ((e = getNode(hash(key), key)) != null &&
            ((v = e.value) == oldValue || (v != null && v.equals(oldValue)))) {
            //替换为新节点的value值
            e.value = newValue;
            afterNodeAccess(e);
            return true;
        }
        return false;
    }

    @Override
    public V replace(K key, V value) {
        Node<K,V> e;
        //找到此节点不为null
        if ((e = getNode(hash(key), key)) != null) {
        	//记录此节点的旧节点
            V oldValue = e.value;
            //替换为新节点
            e.value = value;
            afterNodeAccess(e);
            return oldValue;
        }
        return null;
    }

六、resize方法（重要、扩容策略）

这个方法就是初始化table或者将table的长度变为原来的2倍。

final Node<K,V>[] resize() {
		//获取旧map中的各种信息
        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;
            }
            //扩容操作，将oldCap的二倍赋值给newCap。
            else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
                     oldCap >= DEFAULT_INITIAL_CAPACITY)
                //oldThr也扩容为原来的二倍。
                newThr = oldThr << 1; // double threshold
        }
        else if (oldThr > 0) // initial capacity was placed in threshold
        	//如果旧的阈值大于0，就将阈值设置为新的容量
            newCap = oldThr;
        else {               // zero initial threshold signifies using defaults
        	//如果表长度为0，并且它的threshold阈值为0.就是用默认值。
            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]; //创建新表，长度为newCap
        table = newTab;
        //如果旧表为null，直接返回初始化好的表就行了
        if (oldTab != null) {
        	//遍历旧表的所有下标
            for (int j = 0; j < oldCap; ++j) {
                Node<K,V> e;
                //如果这个下标处是有元素的
                if ((e = oldTab[j]) != null) {
                	//将旧表数组的引用置为null，垃圾回收交给JVM
                    oldTab[j] = null;
                    //如果此下标处元素的下一个节点为null，说明只有一个节点
                    if (e.next == null)
                    	//将这个节点存入新表的hash值处。
                        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;
                            //如果节点的哈希值，与旧容量（二进制只有一个1）进行与操作。
                            //结果为0，说明节点和新容量进行与操作，也还是旧的下标。(下面详解）
                            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;
    }

在JDK1.7中，重新哈希元素是用元素的 hash%（newCap-1），重新计算下标。并且遍历就数组中的链表是从后往前的，往新数组中插入是头插（为了效率），所以插入到新数组之后的链表，将会逆序。
在JDK1.8中，HashMap的重新计算哈希值方法发生了变化。

七、treeifyBin方法（树化）

final void treeifyBin(Node<K,V>[] tab, int hash) {
        int n, index; Node<K,V> e;
        //判断如果表为null，或者表的总长度没有达到64.只需要初始化表或者扩容，不需要树化。
        if (tab == null || (n = tab.length) < MIN_TREEIFY_CAPACITY)
            resize();
        else if ((e = tab[index = (n - 1) & hash]) != null) {
            TreeNode<K,V> hd = null, tl = null;
            do {
            	//根据Node节点，创建树的节点。
                TreeNode<K,V> p = replacementTreeNode(e, null);
                //如果尾节点为null，说明还没有节点，将头节点置为当前p节点。
                if (tl == null)
                    hd = p;
                else {
                    p.prev = tl;  //当前p节点的前一个指向尾节点
                    tl.next = p;   //尾节点的next指向当前p节点，这里treeNode可以掉next
                    					//是因为它继承链上，继承了Node
                }
                //每次循环都将尾节点指向当前插入的p节点。
                tl = p;
            } while ((e = e.next) != null);
            //到目前为止将单向链表转换为了双向链表。
            if ((tab[index] = hd) != null)
            	//具体的树化 在↓面
                hd.treeify(tab);
        }
    }

TreeNode<K,V> replacementTreeNode(Node<K,V> p, Node<K,V> next) {
        return new TreeNode<>(p.hash, p.key, p.value, next);
    }

final void treeify(Node<K,V>[] tab) {
            TreeNode<K,V> root = null;
            //遍历整个树（目前是双向链表）
            for (TreeNode<K,V> x = this, next; x != null; x = next) {
                next = (TreeNode<K,V>)x.next;
                x.left = x.right = null;
                if (root == null) { //如果根节点为null，就先给root节点赋值
                    x.parent = null;
                    x.red = false;
                    root = x;
                }
                else {
                    K k = x.key;   //保存当前需要插入的双向链表节点的key值
                    int h = x.hash;    //保存~hash值
                    Class<?> kc = null;
                    for (TreeNode<K,V> p = root;;) {  //遍历整个树
                        int dir, ph;   //dir标志需要将节点存入左边还是右边,ph树节点的hash值
                        K pk = p.key;  //保存树的key值到pk
                        if ((ph = p.hash) > h)  //如果树的hash值大于链表节点
                            dir = -1;			//将链表节点插入树节点的左边
                        else if (ph < h)    //否则右边
                            dir = 1;
                      //如果两个节点hash值相等。就判断链表节点的key类型有没有实现comparable接口
                      //如果实现了，就继续判断能否通过comparable的方式比较两个key的大小。
                      //如果上面两条任意一条不满足，就通过tieBreakOrder返回dir				
                        else if ((kc == null &&  
                                  (kc = comparableClassFor(k)) == null) || 
                                 (dir = compareComparables(kc, k, pk)) == 0)
                            dir = tieBreakOrder(k, pk);
						//保存当前树节点p
                        TreeNode<K,V> xp = p;
                        //判断当前树节点的左或者右子树（取决于dir）是否为null
                        //如果为null，就直接挂载链表节点到树上面，
                        //然后调用balanceInsertion平衡一下红黑树
                        //如果不为null，就让p变为自己的右或者左子节点，
                        //重新进行一次寻找链表节点x位置的过程
                        if ((p = (dir <= 0) ? p.left : p.right) == null) {
                            x.parent = xp;
                            if (dir <= 0)
                                xp.left = x;
                            else
                                xp.right = x;
                            //树平衡操作
                            root = balanceInsertion(root, x);
                            break;
                        }
                    }
                }
            }
            //经过多次的树平衡操作树的根节点已经不是一开始的root
            //这时候需要确保树的root指向树的根节点。
            moveRootToFront(tab, root);
        }

/**
  * 用这个方法来比较两个对象，返回值要么大于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;
        }

八、remove(Object key)方法

public V remove(Object key) {
        Node<K,V> e;
        return (e = removeNode(hash(key), key, null, false, true)) == null ?
            null : e.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;
        //满足哈希表不为null，并且长度大于0，当前key哈希下标处元素不为null，才可以删除。
        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;
            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;
                //通过上面的遍历可以看出，p最终是node的前一个节点
                else
                    p.next = node.next;
                ++modCount;
                --size;
               	//为LinkedHashMap准备的方法
                afterNodeRemoval(node);
                return node;
            }
        }
        return null;
    }

如果理解上面的方法这个方法之后，下面这个方法就不难理解了，这个方法所要完成的就是，必须删除key和value匹配的节点。

@Override
    public boolean remove(Object key, Object value) {
        return removeNode(hash(key), key, value, true, true) != null;
    }

clear()方法就是遍历数组，将所有下标处的元素都指向null。
containsValue就是遍历数组+遍历链表，找到所要查找的value值。

九、keySet、values和entrySet

1.keySet方法

就是将map集合的key、value键值对，封装为只有key值的set集合（因为keySet是包访问权限所以不能实例化它，但是它继承了AbstractSet类。）

2.values方法

就是将所有的value都返回。组成一个Values的对象（这个类是包访问权限，所以我们不能实例化它），但是它继承了AbstractCollection类。所以可以使用Collection类来接收values方法的返回值。

3.EntrySet方法

就是将Map转变为Set集合，泛型是Map.Entry<K,V>。一般用来迭代输出Map中的元素。因为Entry是Map接口中的一个接口。所以可以直接在外部作为引用接收值。

以上方法中得到的对象，他们的clear和remove操作都会反映到原map上。

十、getOrDefault和putIfAbsent

前者是使用key返回相应的value值，如果没有这个key，就返回参数中所传入的value。
后者是向map中添加元素，和put的区别就是，当map中已经有相同的key值了，put方法会覆盖原来的value，而这个方法不会覆盖。

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

    @Override
    public V putIfAbsent(K key, V value) {
        return putVal(hash(key), key, value, true, true);
    }

十一、clone方法

hashMap的clone方法和ArrayList的一样，也是新创建一个数组，但是原数组中所存储的元素和新数组中所存储的元素指向同一块空间。修改旧元素会反应到两个Map上。但是想新Map中添加元素不会影响旧Map。