java集合系列之HashMap源码

java集合系列之HashMap源码

　　HashMap的源码可真不好消化！！！

　　首先简单介绍一下HashMap集合的特点。HashMap存放键值对，键值对封装在Node（代码如下，比较简单，不再介绍）节点中，Node节点实现了Map.Entry。存放的键值对的键不可重复。jdk1.8后，HashMap底层采用的是数组加链表、红黑树的数据结构，因此实现起来比之前复杂的多。

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源码的一点理解，除了与红黑树相关的操作不清楚之外，其余理解还算凑合，希望对各位有所帮助。

　　首先看一下它的静态常量和成员变量：

 /**
     *默认初始化容量16
     */
    static final int DEFAULT_INITIAL_CAPACITY = 1 << 4; //

    /**
     * 最大容量
     */
    static final int MAXIMUM_CAPACITY = 1 << 30;

    /**
     * 默认加载因子
     */
    static final float DEFAULT_LOAD_FACTOR = 0.75f;

    /**
     * 如果一个桶中的元素超过8，则使用红黑树替代链表
     */
    static final int TREEIFY_THRESHOLD = 8;

    /**
     * 数组扩容时，桶中的元素数量减少到6个时，树形结构化为链表
     */
    static final int UNTREEIFY_THRESHOLD = 6;

    /**
     * 在转变成树之前，还会有一次判断，只有键值对数量大于 64 才会发生转换。
     * 这是为了避免在哈希表建立初期，多个键值对恰好被放入了同一个链表中而导致不必要的转化。
     */
    static final int MIN_TREEIFY_CAPACITY = 64;

 /**
     * 存放数据的数组，数组中的元素类型为Node,Node实现了Map.Entry
     */
    transient Node<K,V>[] table;

    /**
     * 存放所有的键值对对象，也可以成为Node对象，还可成为Entry对象
     */
    transient Set<Map.Entry<K,V>> entrySet;

    /**
     * 键值对的数量
     */
    transient int size;

    /**
     * 集合被修改的次数
     */
    transient int modCount;

    /**
     *下次发生数组扩容的值（capacity * loadFactor）
     */

    int threshold;

    /**
     *加载因子
     */
    final float loadFactor;

　　HashMap的构造方法如下：

　　HashMap的构造方法并没有对其（数组）进行初始化，而是在集合第一次添加元素时，才进行初始化，构造方法只是对容量和加载因子进行设置。这是一种懒加载机制（lazy_load）。

public HashMap(int initialCapacity, float loadFactor) {
        if (initialCapacity < 0)//容量小于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;
      //用于找到大于等于initialCapacity最小的2的幂数，
      //奇怪的是却将这个值赋给了threshold，threashold应该赋值为tableSizeFor(initialCapacity)*loadFactor
      //原因是在resize方法对数组进行初始化时，重新赋值了
        this.threshold = tableSizeFor(initialCapacity);
    }

    /**
     * 传入初始化容量，默认加载
     */
    public HashMap(int initialCapacity) {
        this(initialCapacity, DEFAULT_LOAD_FACTOR);
    }

    /**
     * 空参构造
     */
    public HashMap() {
        this.loadFactor = DEFAULT_LOAD_FACTOR; // all other fields defaulted
    }

接下来是HashMap最终要的几个方法。

首先是resize()方法：

　　用于数组初始化或数组扩容（也就是rehash过程）

 /**
     * resize()方法兼顾两个职责：
     *     1. 创建初始存储表格（由于在HashMap的构造方法中仅仅对容量、门限值和加载因子进行了设置，并未对存储表格进行初始化，
     *         存储表格的初始化发生在put方法的初次调用，内部调用resize()，进行初始化表格）
     *     2. 当容量不满足需求时进行扩容
     */
    final Node<K,V>[] resize() {
        Node<K,V>[] oldTab = table;//oldTable保留扩充前的数组
        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;//仅仅将门限值设为Integer的最大值即可，它大约是MAXIMUM_CAPACITY的2倍
                return oldTab;
            }
            else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&//首先将newCap设为原来的两倍，如果扩充之前数组容量超过了最大初始化容量，并且它的2倍小于最大容量
                     oldCap >= DEFAULT_INITIAL_CAPACITY)
                newThr = oldThr << 1; // 将新的门限值设为原来的两倍，
        }
        else if (oldThr > 0) // 这个是存储表格初始化时执行的分支，集合创建时调用的是带参构造
            newCap = oldThr;
        else {               // 这个也是存储表格初始化时执行的分支，集合创建时调用的是无参构造
            newCap = DEFAULT_INITIAL_CAPACITY;
            newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
        }
        if (newThr == 0) {//使用带参构造初始化或者原容量处于默认初始化容量和二分之最大容量之外时，才成立
            float ft = (float)newCap * loadFactor;//相当于新的门限值的雏形
            //如果ft和新容量都没有超过最大容量，则将新的门限值设为该门限值，否则将设为最大整数值
            newThr = (newCap < MAXIMUM_CAPACITY && ft < (float)MAXIMUM_CAPACITY ?//
                      (int)ft : Integer.MAX_VALUE);
        }
        threshold = newThr;//对集合的门限值进行重新设定

        //下面是对新数组的创建和对集合中的数据添加到新数组。也就是俗称的rehash
        @SuppressWarnings({"rawtypes","unchecked"})
            Node<K,V>[] newTab = (Node<K,V>[])new Node[newCap];//创建新的数组（存储表格）
        table = newTab;//table指向新创建的数组
        if (oldTab != null) {//如果原来数组不为null,即不是第一次添加元素
            for (int j = 0; j < oldCap; ++j) {//遍历数组
                Node<K,V> e;
                if ((e = oldTab[j]) != null) {//e记录数组该索引处中的元素
                    oldTab[j] = null;//将该索引处的元素置为null
                    if (e.next == null)//如果该索引处有且仅有一个元素，即e.next == null
                        //由于newCap都是2的指幂指数，因此newCap-1的值的二进制形式为高位为0，低位全部为1，
                        //因此e的hash值&newCap-1的值的二进制形式为：保留了所有的低位，高位为0，因此这个值肯定小于newCap,也就是索引一定存在
                        newTab[e.hash & (newCap - 1)] = e;
                    else if (e instanceof TreeNode)//如果e为红黑树的根节点，调用split方法对红黑树进行拆分
                        ((TreeNode<K,V>)e).split(this, newTab, j, oldCap);
                    else { //如果e是链表的头结点
                        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) {//高位为0：oldCap为2的幂指数，&运算保留了他的高位
                                if (loTail == null)//链表为空时
                                    loHead = e;
                                else
                                    loTail.next = e;//尾节点右移
                                loTail = e;
                            }
                            else {//高位为1：oldCap为2的幂指数，&运算保留了他的高位
                                if (hiTail == null)//链表为空
                                    hiHead = e;
                                else
                                    hiTail.next = e;
                                hiTail = e;//尾节点右移
                            }
                        } while ((e = next) != null);
                        if (loTail != null) {
                            loTail.next = null;
                            newTab[j] = loHead;//将高位为0的节点组成链表的头结点放到该索引
                        }
                        if (hiTail != null) {
                            hiTail.next = null;
                            newTab[j + oldCap] = hiHead;//将高位为1的节点组成链表的头结点放到该索引平移oldCap处的索引处
                        }
                    }
                }
            }
        }
        return newTab;//返回新生成的数组
    }

然后是put方法，put方法内部调用putVal()

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;
        if ((tab = table) == null || (n = tab.length) == 0)//如果数组为null或者长度为0
            n = (tab = resize()).length;//初始化数组
      //计算桶的位置，由于n为2的幂指数，所以n-1的二进制位全1，所以(n - 1)&hash小于n
        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))))//如果头结点的hash值和equals都相同则将e指向p
                e = p;
            else if (p instanceof TreeNode)//如果p为红黑树，则向红黑树中添加元素
                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;
                    }
                    if (e.hash == hash &&
                        ((k = e.key) == key || (key != null && key.equals(k))))
                        break;//如果找到相同元素则退出循环
                    p = e;
                }
            }
            if (e != null) { // 找到相同元素，则覆盖旧值，并返回旧值
                V oldValue = e.value;
                if (!onlyIfAbsent || oldValue == null)
                    e.value = value;
                afterNodeAccess(e);
                return oldValue;
            }
        }
        ++modCount;//添加了新元素，所以modCount自增
        if (++size > threshold)//判断是否需要扩容
            resize();
        afterNodeInsertion(evict);
        return null;//如果找不到返回null
    }

不难看出，putVal方法传入的不是key本身的hashcode()的值，而是下面这个方法：

/**
     * 为什么要有HashMap的hash()方法，难道不能直接使用KV中K原有的hash值吗？在HashMap的put、get操作时为什么不能直接使用K中原有的hash值。
     * key的hash值高16位不变，低16位与高16位异或作为key的最终hash值。（h >>> 16，表示无符号右移16位，高位补0，任何数跟0异或都是其本身，因此key的hash值高16位不变。）
     * 为什么要这么干呢？ 这个与HashMap中table下标的计算有关。index = (n-1) & hash，n为2的幂数
     */
    static final int hash(Object key) {
        int h;
        return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
    }

才疏学浅，只能写到这了，该死的半天时间又过去了。源码中遨游，望能有所收获。