HashMap源码解析

1.HashMap的父类与接口

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

2.HashMap的类属性

static final int DEFAULT_INITIAL_CAPACITY = 1 << 4; // aka 16

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;

static final int MIN_TREEIFY_CAPACITY = 64;

HashMap一共定义了六个final static类属性。

DEFAULT_INITIAL_CAPACITY ：默认初始化容量16

MAXIMUM_CAPACITY ：最大初始化容量2的30次方

DEFAULT_LOAD_FACTOR ：默认负载因子0.75F。默认能够存放的最大键值对数量=DEFAULT_INITIAL_CAPACITY*DEFAULT_LOAD_FACTOR=16*0.75F=12。

TREEIFY_THRESHOLD ：转为树结构的阈值。当数组中单个位置上的链表元素数量大于该值时，转为红黑树。

UNTREEIFY_THRESHOLD ：从红黑树转为链表。扩容后重新计算键值对的位置，此时链表中元素数量小于该值，则从红黑树转为链表。

MIN_TREEIFY_CAPACITY ：最小树结构容量。如果当前键值对数量小于该值，则无法转为红黑树，即使单个数组位置上的元素数量大于TREEIFY_THRESHOLD。

transient Node<K,V>[] table;

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

transient int size;

transient int modCount;

int threshold;

final float loadFactor;

以及六个对象属性。

Node<K, V>[] table：用来存储键值对的数组

Set<Map.Entry<K,V>> entrySet：Key集合

int size：元素数量

int modCount：快速失败机制判断条件

int threshold;初始化集合容量

float loadFactor：负载因子

3.HashMap的Node<K, V>

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

4.HashMap的构造函数

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

HashMap()：无参构造函数，负载因子为默认的0.75F。

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

HashMap(int, int)：指定初始化容量和负载因子。
要求初始容量不能小于0(可以等于0)，也不能大于默认最大容量。负载因子不能小于等于0(等于0会不停地扩容，导致内存溢出)，且必须为Float。

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

tableSizeFor(int)：求大于等于输入参数cap，且为2的幂次方中，最小的数。
假设n=000...01XX..X，其中X表示可以为0或1。
n |= n >>> 1，此时n=000...011XXXX...X
n |= n >>> 2，此时n=000...01111XX...X
以此类推，当执行完n |= n >>> 16时，此时n=000...0111...1，即从n等于1的最高位开始，后续所有位数均为1.(int类型长度为32位，因此当>>>16时，所有位数已经全部被执行一次)
此时再让n + 1，则n=000...1000.0，n已经成为2的幂次方。 
而第一步的int n = cap - 1。是为了应对当cap本身即为2的幂次方时，返回cap本身(由于这个算法永远会进一位，如果不减1，返回的值只会大于cap，而不会等于cap)。

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

HashMap(int)：指定初始容量，实际内存调用的仍是HashMap(int ,float)方法。

    public HashMap(Map<? extends K, ? extends V> m) {
        this.loadFactor = DEFAULT_LOAD_FACTOR;
        putMapEntries(m, false);
    }

HashMap(Map<? extends K, ? extends V>)：初始化时，将一个map集合放入该对象中。负载因子采用默认的0.75f。内部调用的是puMapEntries(map,boolean)方法。

    final void putMapEntries(Map<? extends K, ? extends V> m, boolean evict) {
        int s = m.size();
        if (s > 0) {  //m为空集合，不做任何操作。
            if (table == null) { // pre-size
                float ft = ((float)s / loadFactor) + 1.0F;  //计算需要的数组大小=键值对数量/负载因子+1
                int t = ((ft < (float)MAXIMUM_CAPACITY) ?
                         (int)ft : MAXIMUM_CAPACITY);
                if (t > threshold)  //计算目前需要的容量
                    threshold = tableSizeFor(t);
            }
            else if (s > threshold)
                resize();  //当参数m的size超出了当前对象的容量，进行扩容。
            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);  //插入一个Map，实际是当成了许多个Map.Entry来进行一一插入。
            }
        }
    }

putMapEntries(Map, boolean)继续调用了putVal(int, V, V, boolean, boolean)方法

    final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
                   boolean evict) {
        Node<K,V>[] tab; Node<K,V> p; int n, i;  //tab当前对象的容器，p=tab[i]单个entry，n容器的大小，i=(n-1)&hash待插数据在容器中的位置
        if ((tab = table) == null || (n = tab.length) == 0) //当前集合尚未初始化，调用resize()进行容器初始化
            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;
            if (p.hash == hash &&
                ((k = p.key) == key || (key != null && key.equals(k))))
                e = p;  //第一种情况，要插入的数据的key与p的key相等，数据已经存在，令e=p。
            else if (p instanceof TreeNode)
                e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);  //第二种情况
            else {
                for (int binCount = 0; ; ++binCount) {  //第三种情况，确认p是链表形式，从头遍历链表，寻找插入或修改的位置。
                    if ((e = p.next) == null) {  //赋值e=p.next
                        p.next = newNode(hash, key, value, null);  //遍历到链表末尾，确认没有相等的key，在末尾插入新节点。
                        if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
                            treeifyBin(tab, hash);  //链表到达满足红黑树条件，转为红黑树(当前容器大小也必须满足条件，否则只做扩容处理)
                        break;
                    }
                    if (e.hash == hash &&
                        ((k = e.key) == key || (key != null && key.equals(k))))  //在链表中找到key相同的元素，令该元素赋值给e
                        break;
                    p = e;  //获取下一个节点，循环
                }
            }
　　　　　　　　//e==null只有一种情况，即插入的是一个新节点，已经插入在链表的末尾。e!=null，说明插入的数据已经存在于链表中，做修改操作
            if (e != null) { // existing mapping for key
                V oldValue = e.value;
                if (!onlyIfAbsent || oldValue == null)
                    e.value = value;  //新值覆盖旧值
                afterNodeAccess(e);  //linkedHashMap对数据进行排序
                return oldValue;
            }
        }
        ++modCount;
        if (++size > threshold)  //执行到这里，确认是新增一个元素，因此++size，同时判断新增后的size是否大于当前容器大小，如果是，进行扩容
            resize();
        afterNodeInsertion(evict);  //linkedHashMap操作
        return null;
    }

5.HashMap常用方法

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

hash(Object)：常用来确认元素在数组中位置，由于传入的参数是key，因此元素在map中的位置，和value无关，只是key和容器大小有关。

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

get(Object)：查询元素值。内部调用的是getNode(int, Object)方法

    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) {  //元素要存在，需要容器不能为null，容器大小不能为0，且数组对应位置上的链表不能为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;
    }

    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) { //该对象已经被初始化过，并已添加数据
            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
        }
        else if (oldThr > 0) // initial capacity was placed in threshold
            newCap = oldThr;  //说明是通过new HashMap(100, 0.75f)方法创建的对象，此时将对象的容器初始化为配置的大小(2的幂次方)
        else {               // zero initial threshold signifies using defaults
            newCap = DEFAULT_INITIAL_CAPACITY;  //通过new HashMap()创建的对象，将其容器初始化大小，和阈值大小设定为默认值。
            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<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;  //当前是最后一个节点，重新计算寻找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()：容器扩容。