JAVA HashMap源码阅读笔记

默认参数设置

//如果构造函数初始化没有传值。则使用默认的初始化哈希桶容量为16 ,
static final int DEFAULT_INITIAL_CAPACITY = 1 << 4; // aka 16

//最大hash桶容量
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属性

/* ---------------- Fields -------------- */

//hash桶又叫hashtable、hash表，所有的数据都存储在这个属性里面，体现出数组+链表/红黑树数据结构。
//链表数量超过8则转换为红黑树。
//其中数组的索引来源于key的hash值，如果出现hash冲突并且数量小于8则使用头插法将数据插入table[hash]所指向的node头节点。大于8则将链表转换为红黑树
transient Node<K,V>[] table;
//缓存了hashMap的key集合，使用了HashMap中EntrySet作为实现类。
transient Set<Map.Entry<K,V>> entrySet;

//记录hashmap所有键值对的数量
transient int size;

//记录hashmap数据结构被修改的次数，modifyCount
transient int modCount;

//要调整的下一个值的大小
//在put时候调用resize方法设置初始值=(int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY); 
//默认加载因子*默认容量=0.75*16 = 12，每put一次size++，当size的值达到threshold时候就会进行扩容，而不是达到16才扩容
int threshold;

//加载因子不指定默认是0.75
final float loadFactor;

TreeNode实现

通过idea我们可以看到TreeNode的类图：

并且这些类除了Entry类之外，都在HashMap里面实现，其中Entry实现类在LinkedHashMap中实现。

Node实现

    static class Node<K,V> implements Map.Entry<K,V> {
        final int hash;// hash值
        final K key; //key
        V value;//value
        Node<K,V> next; //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;
        }
    }

Entry实现类

static class Entry<K,V> extends HashMap.Node<K,V> { //继承了了hashmap的node类
    Entry<K,V> before, after;//双向链表？？
    Entry(int hash, K key, V value, Node<K,V> next) {
        super(hash, key, value, next);
    }
}

TreeNode实现

这里应该是封装了红黑树的增删查改功能。不做详细解析，一般面试也不会问那么细。

红黑树是从搜索二叉树演变过来的，为了防止搜索二叉树出现的极端情况，树变成链表形式。

如图：

而设计的一种数据结构，是一颗平衡二叉树，平衡二叉树的查找、删除、修改时间复杂度都是O(log^n)。

为什么AVL也是一颗平衡二叉树，java并没有使用AVL而选择使用红黑树？

网上是这么说的：

AVL树和红黑树有几点比较和区别：
（1）AVL树是更加严格的平衡，因此可以提供更快的查找速度，一般读取查找密集型任务，适用AVL树。
（2）红黑树更适合于插入修改密集型任务。
（3）通常，AVL树的旋转比红黑树的旋转更加难以平衡和调试。

总结：
（1）AVL以及红黑树是高度平衡的树数据结构。它们非常相似，真正的区别在于在任何添加/删除操作时完成的旋转操作次数。
（2）两种实现都缩放为a O(lg N)，其中N是叶子的数量，但实际上AVL树在查找密集型任务上更快：利用更好的平衡，树遍历平均更短。另一方面，插入和删除方面，AVL树速度较慢：需要更高的旋转次数才能在修改时正确地重新平衡数据结构。
（3）在AVL树中，从根到任何叶子的最短路径和最长路径之间的差异最多为1。在红黑树中，差异可以是2倍。
（4）两个都给O（log n）查找，但平衡AVL树可能需要O（log n）旋转，而红黑树将需要最多两次旋转使其达到平衡（尽管可能需要检查O（log n）节点以确定旋转的位置）。旋转本身是O（1）操作，因为你只是移动指针。

红黑树

1、介绍：红黑树是一种二叉查找树，但在每个节点上增加一个存储位表示节点的颜色，可以是red或black。通过对任何一条从根到叶子的路径上的各个节点着色方式的限制，红黑树确保没有一条路径会比其他路径长出两倍，因而是接近平衡的。
　　2、定义：它或者是一颗空树，或者是具有一下性质的二叉查找树
　　　　1）： 每个节点或是红的，或是黑的。
　　　　2）：根节点是黑的。
　　　　3）：每个叶节点（NIL）是黑的。(在实现过程中都是指向null的)（所有NULL结点称为叶子节点，且认为颜色为黑）
　　　　4）：如果一个节点是红的，则他的两个子节点是黑的。
　　　　5）：对每个节点，从该节点到其子孙节点的所有路径上包含相同数目的黑节点。

3、结构：树中的每个节点上包含五个域：color、key、left、right、p。如果其节点没有一个子节点或者父节点，则该节点相应的指针（p）域包含值NIL。我们把这些NIL视为指向二叉查找树的外节点，而把带关键字的节点是为树的内节点。

4、高度：一颗有n个内节点的红黑树的高至多为2lg(n+1)。

//红黑树的实现。
TreeNode<K,V> extends LinkedHashMap.Entry<K,V>
   static final class TreeNode<K,V> extends LinkedHashMap.Entry<K,V> {
        TreeNode<K,V> parent;  // 父亲节点
        TreeNode<K,V> left;//左节点
        TreeNode<K,V> right;//右节点
        TreeNode<K,V> prev;    //删除后需要取消下一步的链接
        boolean red;
        TreeNode(int hash, K key, V val, Node<K,V> next) {
            super(hash, key, val, next);
        }

        /**
         * Returns root of tree containing this node.
         */
        final TreeNode<K,V> root() {
            for (TreeNode<K,V> r = this, p;;) {
                if ((p = r.parent) == null)
                    return r;
                r = p;
            }
        }
   }

重要方法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;
    //首先判断哈希表是否为空，如果为空则调用resize（）方法进行初始化
    if ((tab = table) == null || (n = tab.length) == 0)
        n = (tab = resize()).length;
    //根据hash值计算出hash表的索引，这里的hash值并不是真正的hash下标索引，
    //默认n=16,这里有个技巧，如果n是2的y次幂，x%n = x&(n-1)，所以这里实际就是对hash值取模。
    //之后再判断是否hash冲突，如果没有hash冲突则new一个Node对象，存储key、value、hash。
    if ((p = tab[i = (n - 1) & hash]) == null)
        tab[i] = newNode(hash, key, value, null);
    //这里是出现了hash冲突
    else {
        Node<K,V> e; K k;
        //这里是判断是否是修改原始key的值，如果是则进行修改
        if (p.hash == hash &&
            ((k = p.key) == key || (key != null && key.equals(k))))
            e = p;
        //这里是判断是否为红黑树，如果是则调用红黑树的putTreeVal方法增加节点。
        else if (p instanceof TreeNode)
            e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
        else {
            //遍历链表节点，这里使用的是尾插法。
            for (int binCount = 0; ; ++binCount) {
                //判断节点的next元素是否为空，如果不为空则将next指向new的节点（即新建的元素）
                if ((e = p.next) == null) {
                    p.next = newNode(hash, key, value, null);
                    //判断是否超过红黑树的阈值，超过则转换为红黑树。
                    if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
                        treeifyBin(tab, hash);
                    break;
                }
                //如果在链表中找到的相同的key，说明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
            V oldValue = e.value;
            if (!onlyIfAbsent || oldValue == null)
                e.value = value;
            afterNodeAccess(e);
            return oldValue;
        }
    }
    //修改数据次数+1
    ++modCount;
    //如果大于要调整的下一个值的大小则进行扩容，默认是12
    if (++size > threshold)
        resize();
    //该方法由linkHashMap实现
    afterNodeInsertion(evict);
    return null;
}

/**
* 扩容方案
 */
final Node<K,V>[] resize() {
    //记录旧的hash表
    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;
        }
        //判断容量是否大于等于初始值，小于最大值，满足条件则进行扩容
        else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
                 oldCap >= DEFAULT_INITIAL_CAPACITY)
            //进行两倍扩容如果是初始值，这里是12*2=24
            newThr = oldThr << 1; // double threshold
    }
    //如果节点没有旧数据，并且oldThr大于0，则扩容数量为oldThr
    else if (oldThr > 0) // initial capacity was placed in threshold
        newCap = oldThr;
    else {               // zero initial threshold signifies using defaults
        //初始化时候进行扩容
        newCap = DEFAULT_INITIAL_CAPACITY;
        newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
    }
    //如果进行扩容了，阈值还为0，则根据容量得到阈值，衔接  else if (oldThr > 0)   newCap = oldThr; 的逻辑
        newCap = oldThr;
    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;
    //如果存在旧值，这里需要将旧值复制到新的hash表中。
    if (oldTab != null) {
         //遍历获取链表数据
        for (int j = 0; j < oldCap; ++j) {
            Node<K,V> e;
            //如果node不为空
            if ((e = oldTab[j]) != null) {
                oldTab[j] = null;
                //如果只有一个节点
                if (e.next == null)
                    //进行rehash，重新计算数组下表，hash值和新的容量进行求模，并将节点数据存储到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;
                        /**
                        * System.out.println(17&16); 16
        System.out.println(18&16); 16
        System.out.println(31&16); 16
        System.out.println(32&16); 0
                        **/
                       //从以上结果集可以看出：0说明hash值已经超过旧容量的2倍
                        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);
                    //loTail表示？
                    if (loTail != null) {
                        loTail.next = null;
                        //这里为什么不进行rehash，直接取j的值作为hash表的下标？
                        newTab[j] = loHead;
                    }
                    //hiTail表示？
                    if (hiTail != null) {
                        hiTail.next = null;
                        //进行rehash？
                        newTab[j + oldCap] = hiHead;
                    }
                }
            }
        }
    }
    return newTab;
}

重要方法get

//可以看到这里根据计算的hash值获取node再获取value
public V get(Object key) {
    Node<K,V> e;
    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;
    //判断hash表是否存在，存在则获取
    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;
}