手撕源码之HashMap

来自B站小刘讲源码的网课收获
目前只看过HashMap，感觉还不错

一、原理分析

 static class Node<K,V> implements Map.Entry<K,V> {
        final int hash;
        final K key;
        V value;
        Node<K,V> next;

1、HashMap总体是一个Node数组，通过key的hashcode经过扰动函数得到hash值，hash通过路由算法定位存储在Node数组中
2、Node数组长度默认为16
3、hash冲突后，通过next构成链表，冲突后尾插（拉链法）
4、jdk8版本:

• 当链表长度超过8，而且Node数组中元素总数超过64，链表拓展为红黑树，因为hash结点的链表过长，效率就逐渐变成线性了，变成红黑树可以提高效率
• 链化：相同hash过多，链表逐渐增长，效率降低，逐渐线性，就是链化
• HashMap扩容原理：当结点过多，每个数组里都有着很长的链表或者红黑树，非常影响效率，就对HashMap数组进行扩容，减短链表和红黑树长度，空间换时间，效率提高。

二、分析源码

1、默认参数

/**
     * 默认数组长度16
     */
    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;

    /**
     * 树化阈值 链表长度超过8可能升级为红黑树
     */
    static final int TREEIFY_THRESHOLD = 8;

    /**
     * 降级阈值 当红黑树结点小于6，降级为链表
     */
    static final int UNTREEIFY_THRESHOLD = 6;

    /**
     * 树化阈值另一结点 数组内总元素超过64才可能树化
     */
    static final int MIN_TREEIFY_CAPACITY = 64;

2、领域参数

/**
     * 哈希表
     */
    transient Node<K,V>[] table;

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

    /**
     * 当前哈希表元素个数
     */
    transient int size;

    /**
     * 当前哈希表表结构修改次数
     */
    transient int modCount;

    /**
     * 扩容阈值 当表占用超过该值 就会扩容
     * @serial
     */

    int threshold;

    /**
     * 负载因子
     * 作用 threshold=容量*loadFactor
     * 如 12=16*0.75=16
     * 占用超过12就该扩容了
     * @serial
     */
    final float loadFactor;

3、构造函数

1、判断容量大小是否正常
2、判断负载因子是否正常
3、给负载因子和扩容阈值赋值
其中，扩容阈值赋值
因为扩容阈值必须是2次方（当length为2幂时 hash%length==hash&(length-1) 是为了减少碰撞）
所以通过tableSizeFor(initialCapacity)返回一个大于或等于initialCapacity的2次方数

//                    初始化容量        负载因子
    public HashMap(int initialCapacity, float loadFactor) {
//        容量小于0 抛出异常
        if (initialCapacity < 0)
            throw new IllegalArgumentException("Illegal initial capacity: " +
                    initialCapacity);
//        初始化容量>最大容量 设置为最大容量
        if (initialCapacity > MAXIMUM_CAPACITY)
            initialCapacity = MAXIMUM_CAPACITY;

//        负载因子异常  <=0||为非数
        if (loadFactor <= 0 || Float.isNaN(loadFactor))
            throw new IllegalArgumentException("Illegal load factor: " +
                    loadFactor);

        this.loadFactor = loadFactor;
//        因为初始化容量可能为任意数，但是扩容阈值只能为2的次方
//        所以返回一个大于initialCapacity得2次方数
        this.threshold = tableSizeFor(initialCapacity);
    }

HashMap有几个构造函数，但是都是基于该构造的

/**
     * 将最高位1 后的所有位置为1 然后+1就为2次方
     * 0010 1001 ->  0011 1111   +1 = 0100 0000
	 * cap-1是为了避免扩容两倍
     */
    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;
    }

4、put

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

将key的hash经过扰动函数

	/**
	 * 扰动函数
     * key=null 放入哈希表0位
     * 否则异或：异或 是为了让hash的高16位能够计算
     */
    static final int hash(Object key) {
        int h;
        return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
    }

因为经过少次扩容的哈希表长度很小
hashCode又很大，hashCode的高位基本不会参与运算
扰动函数就是为了让hashCode的高16位加入运算

 /**
     * Implements Map.put and related methods
     *
     * @param hash hash for key
     * @param key the key
     * @param value the value to put
     * @param onlyIfAbsent if true, don't change existing value
	 * 如果onlyIfAbsent 为true 不能改变值 就是如果key相同 不能替换
	 *
     * @param evict if false, the table is in creation mode.
     * @return previous value, or null if none
     */
    final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
                   boolean evict) {
        /**
         * tab:引用当前hashMap的哈希表
         * p:当前散列表的元素
         * n:哈希表长度
         * i:路由寻址
         */
        Node<K,V>[] tab; Node<K,V> p; int n, i;
        /**
         * 为了避免new HashMap实例后，放着不用 浪费内存
         * 第一次putVal的时候，才会初始化哈希表
        */
        if ((tab = table) == null || (n = tab.length) == 0)
            n = (tab = resize()).length;

//        通过路由得到桶位，发现桶位结点为空 直接k-v=>Node 放入该桶位
        if ((p = tab[i = (n - 1) & hash]) == null)
            tab[i] = newNode(hash, key, value, null);
        else {
            /**
             * e:临时结点
             * k:临时key
             */
            Node<K,V> e; K k;

//          插入元素与当前结点的key相同 结点替换
            if (p.hash == hash &&
                    ((k = p.key) == key || (key != null && key.equals(k))))
                e = p;

//            当前桶位已经树化 插入到树种
            else if (p instanceof TreeNode)
                e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);

//            当前桶位已经链化，且链表头元素与插入的key不相同
            else {

                for (int binCount = 0; ; ++binCount) {
//                  迭代到链表的尾结点，也没有发现key相同 直接尾插（拉链法）
                    if ((e = p.next) == null) {
                        p.next = newNode(hash, key, value, null);
//                      binCount从0遍历 >=TREEIFY_THRESHOLD - 1=7 说明当前链表元素已经8
//                      当前结点插入进来为9 超过8 尝试树化
                        if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
//                            树化
                            treeifyBin(tab, hash);
                        break;
                    }
//                    如果迭代发现 有key相同 跳出替换
                    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;

//        结点个数超过扩容阈值 进行扩容
        if (++size > threshold)
            resize();
        afterNodeInsertion(evict);
        return null;
    }

改变表结构：
1、当前桶位为空
2、插入树
3、迭代链表没有key相同，尾插
替换值，不改变结构：
1、当前桶位key相同
2、链表迭代有key相同

5、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) {
            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
        }

//      oldCap=0 初始化容量 当前哈希表为空
//      1、new HashMap(initCap , loadFactor)
//      2、new HashMap(initCap)
//      3、new HashMap(map)
        else if (oldThr > 0) // initial capacity was placed in threshold
            newCap = oldThr;

//      oldCap=0 oldThr=0 直接通过公式算默认
//        new HashMap()
        else {               // zero initial threshold signifies using defaults
            newCap = DEFAULT_INITIAL_CAPACITY;
            newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
        }

//
        if (newThr == 0) {
//            计算新扩容阈值
            float ft = (float)newCap * loadFactor;
//            容量没有超过最大 且 扩容阈值没有超过最大  就 赋值给新扩容阈值  否则就赋予 int 最大值
            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;
//              获得j桶位的元素 不为空
//              1、单个元素
//              2、链表
//              3、红黑树
                if ((e = oldTab[j]) != null) {
//                  已经获得 null值 方便jvm GC
                    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
//                      如： 原数组 oldCap=16  扩容数组 newCap=32
//                      路由寻址 (cap-1)&hash
//                      15(1111)位置 01111&1111=1111  11111&1111=1111
//                      扩容为32  cap-1=31(11111)
//                      01111&11111=01111(15 放在低位)  11111&11111=11111(31 放在高位)
//                      所以扩容后 链表会根据不同hash值 存放在 当前位置j(低位) 和 j+oldCap位置(高位)
//                      loHead: 低位链表 放原位置的部分结点
//                      hiHead: 高位链表 放在j+oldCap位置的部分结点
                        Node<K,V> loHead = null, loTail = null;
                        Node<K,V> hiHead = null, hiTail = null;
                        Node<K,V> next;

//                      迭代当前桶位链表 根据hash和newCap路由寻址到低位和高位链表中
                        do {
                            next = e.next;
//                          01111&10000=0
                            if ((e.hash & oldCap) == 0) {
                                if (loTail == null)
                                    loHead = e;
                                else
                                    loTail.next = e;
                                loTail = e;
                            }
//                          11111&10000=10000
                            else {
                                if (hiTail == null)
                                    hiHead = e;
                                else
                                    hiTail.next = e;
                                hiTail = e;
                            }
                        } while ((e = next) != null);

//                      链表存入结点 结点.next指向原链表的元素 置空
                        if (loTail != null) {
                            loTail.next = null;
                            newTab[j] = loHead;
                        }
                        if (hiTail != null) {
                            hiTail.next = null;
                            newTab[j + oldCap] = hiHead;
                        }
                    }
                }
            }
        }
        return newTab;
    }

6、get

    public V get(Object key) {
        Node<K,V> e;
//       通过key获取Node元素，为空返回空，否则返回Node元素的值
        return (e = getNode(hash(key), key)) == null ? null : e.value;
    }

    /**
     * Implements Map.get and related methods
     *
     * @param hash hash for key
     * @param key the key
     * @return the node, or null if none
     */
    final Node<K,V> getNode(int hash, Object key) {
        /**
         * tab:引用HashMap的哈希表
         * first:当前桶位的头元素
         * e:临时结点
         * n:表长度
         */
        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) {
            
//          头元素就是需要get的元素 直接返回  
            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;
    }

7、remove

1、首先判断寻址桶位是否有元素（前提是表不为空）
2、没有元素直接返回null
3、有元素进行匹配

• 桶位头元素就是需要删除的结点
• 不是的话判断是够为链表和红黑树
• 为链表和红黑树就迭代查询 存在就删除返回，不存在就返回null

    public V remove(Object key) {
        Node<K,V> e;
//        根据key删除结点，如果没有匹配则返回空 有匹配删除后返回对应值
        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) {
        /**
         * tab:引用HashMap的哈希表
         * p:当前结点
         * n:表长度
         * index:路由寻址结果
         */
        Node<K,V>[] tab; Node<K,V> p; int n, index;

//        表不为空 且根据hash路由寻址的头元素不为空 说明可以查找
        if ((tab = table) != null && (n = tab.length) > 0 &&
                (p = tab[index = (n - 1) & hash]) != null) {
            /**
             * node:结果结点
             * e:当前node的下一个元素
             */
            Node<K,V> node = null, e; K k; V v;

//          1、头元素就是需要的结果 直接赋给node
            if (p.hash == hash &&
                    ((k = p.key) == key || (key != null && key.equals(k))))
                node = p;

//           头元素不是需要的结果 ，且元素不止一个
            else if ((e = p.next) != null) {
//              2、红黑树
                if (p instanceof TreeNode)
                    node = ((TreeNode<K,V>)p).getTreeNode(hash, key);
//              3、链表 迭代查找
                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);
                }
            }

//          如果查询到需要删除的结点   matchValue=false 直接跳过 否则就需要key和value都匹配
            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);

//              头元素就是要删除的结点 直接头结点删除 head.next=node.next;
                else if (node == p)
                    tab[index] = node.next;

//              迭代的结点删除 pre.next=node.next
                else
                    p.next = node.next;

                ++modCount;
                --size;
                afterNodeRemoval(node);
                return node;
            }
        }
//      没有找到就返回空
        return null;
    }

8、replace

    @Override
    public boolean replace(K key, V oldValue, V newValue) {
        Node<K,V> e; V v;
//        通过getNode匹配结点 如果值与oldValue相同 就替换 不相同就不能替换
        if ((e = getNode(hash(key), key)) != null &&
                ((v = e.value) == oldValue || (v != null && v.equals(oldValue)))) {
            e.value = newValue;
            afterNodeAccess(e);
            return true;
        }
        return false;
    }

    @Override
    public V replace(K key, V value) {
        Node<K,V> e;
//        通过getNode匹配结点 然后进行替换
        if ((e = getNode(hash(key), key)) != null) {
            V oldValue = e.value;
            e.value = value;
            afterNodeAccess(e);
            return oldValue;
        }
        return null;
    }

第一个需要与旧值比较
第二个只需要比较key