美文网首页
HashMap源码分析

HashMap源码分析

作者: 从心_出发 | 来源:发表于2018-10-03 16:45 被阅读0次

    HashMap是我们开发过程中经常使用到的一个类,那么它的实现原理是怎样的呢?在java1.8之前它的底层数据结构是一个链表的数组,如图所示:


    屏幕快照 2018-10-02 上午10.44.21.png

    官方对HashMap作了如下说明

    <p>This implementation provides constant-time performance for the basic
     * operations (<tt>get</tt> and <tt>put</tt>)
    

    以链表的数组作为HashMap的数据结构通常来说是可以满足这个定义的,不过如果HashMap因为Key的hashCode定义不好或是装载因子过大而产生大量冲突的话,那么这个数据结构就可能会退化为几个很长很长的链表,在这种情况下HashMap的效率就会大大降低,显然这种情况下是不能做到在常量时间内完成get和put操作的。因此java1.8在此基础上做了一些修改,当HashMap中的某个链表过长时,这个链表就会进化为一棵红黑树,红黑树的查找和插入操作比起长链表的效率会高出很多,其数据结构如下所示:


    屏幕快照 2018-10-02 上午10.58.45.png

    源码分析

    属性

        //默认的容量大小16,容量大小必须是2的指数
        static final int DEFAULT_INITIAL_CAPACITY = 1 << 4; // aka 16
    
        //最大的容量大小1<<30
        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;
    
       //桶中数据结构转化为红黑树,Hash表中数组大小的阀值,如果数组的长度小鱼这个值Hash表只会执行resize操作
        static final int MIN_TREEIFY_CAPACITY = 64;
    
      //存储元素的数组,其中的元素可能是单个节点、链表或是一个树
        transient Node<K,V>[] table;
    
        //存放元素的集,主要用于遍历Hashmap
        transient Set<Map.Entry<K,V>> entrySet;
    
        //元素个数
        transient int size;
    
       //Hashmap被修改的次数,
        transient int modCount;
    
        //扩容临界值,当节点个数超过capacity * load factor时就会进行扩容
        int threshold;
    
        //装载因子
        final float loadFactor;
    

    构造函数

    /**
         //初始化容量和装载因子
        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;
            this.threshold = tableSizeFor(initialCapacity);
        }
    
        //初始化容量,装载因子用默认值0.75
        public HashMap(int initialCapacity) {
            this(initialCapacity, DEFAULT_LOAD_FACTOR);
        }
    
        //容量为默认值16,装载因子为默认值0.75
        public HashMap() {
            this.loadFactor = DEFAULT_LOAD_FACTOR; // all other fields defaulted
        }
    
        //用其他Map初始化,装载因子为默认值0.75
        public HashMap(Map<? extends K, ? extends V> m) {
            this.loadFactor = DEFAULT_LOAD_FACTOR;
      //把传入的Map中的元素存入到HashMap中,实际调用的是putVal方法
            putMapEntries(m, false);
        }
    
      final void putMapEntries(Map<? extends K, ? extends V> m, boolean evict) {
            int s = m.size();
            //传入的Map不为空才做后面的操作
            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();
              //把Map里的元素存入HashMap中
                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);
                }
            }
        }
    

    tableSizeFor()就是根据传入的参数返回一个不小于它的最小2的整次幂,举个例子如果传入10,那么方法就会返回16
    原理就是5个移位操作将cap的二进制位从最高位的1到末尾全部置为1,比如01xx...xx,经过移位操作后就变为了0111...11,再在这个数的基础上加1,就变成了
    1000...00,这个数就是比cap大且离它最近的2的整次幂,而第一句将cap-1,是为了排除cap本省就是2的整次幂这种情况,比如cap为8,如果不减1,那么最终得到的结果就会是16
    resize()就是对HashMap进行扩容

    final Node<K,V>[] resize() {
            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;
                }
              //新表容量为旧表容量的2倍
                else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
                         oldCap >= DEFAULT_INITIAL_CAPACITY)
                    newThr = oldThr << 1; // double threshold
            }
          //旧表容量不大于0,旧表阀值大于0
            else if (oldThr > 0) // initial capacity was placed in threshold
                newCap = oldThr;
          //旧表容量、阀值都不大于0,用默认值初始化新表容量、阀值
            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;
                newThr = (newCap < MAXIMUM_CAPACITY && ft < (float)MAXIMUM_CAPACITY ?
                          (int)ft : Integer.MAX_VALUE);
            }
            threshold = newThr;
            @SuppressWarnings({"rawtypes","unchecked"})
          //new一个数组存放旧表数据
                Node<K,V>[] newTab = (Node<K,V>[])new Node[newCap];
            table = newTab;
            if (oldTab != null) {
                //oldCap为旧表数组的长度
                for (int j = 0; j < oldCap; ++j) {
                    Node<K,V> e;
                    //数组j位置上不为空
                    if ((e = oldTab[j]) != null) {
                        //将旧表对该位置上对象持有的引用释放掉,避免内存泄漏
                        oldTab[j] = null;
                      //该位置上只有一个节点,直接在该位置上存放这个元素
                        if (e.next == null)
                            newTab[e.hash & (newCap - 1)] = e;
                      //如果该位置上的节点是TreeNode类型的,说明该位置上的节点已经进化为一棵树
                        else if (e instanceof TreeNode)
                            ((TreeNode<K,V>)e).split(this, newTab, j, oldCap);
                      //该位置上的节点是个链表,以(e.hash & oldCap) == 0为判断条件,将原来的链表拆分为两个链表
                        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) {//低部分保留在原数组中的索引j
                                    if (loTail == null)
                                        loHead = e;
                                    else
                                        loTail.next = e;
                                    loTail = e;
                                }
                                else {//高部分在新数组中的索引为j+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;
                            }
                            if (hiTail != null) {
                                hiTail.next = null;
                                newTab[j + oldCap] = hiHead;
                            }
                        }
                    }
                }
            }
            return newTab;
        }
    

    对于putMapEntries这个方法还有一点疑问,进入这个方法后先是判断table是否为null,如果为null就计算HashMap的容量和阀值,到后面就直接将Map中的元素put进去了,可是没有看到table的初始化呀?其实在putVal方法中会调用到resize方法,而resize方法里又会new一个table

    put

    //在Map中将key和value联系在一起,如果Map中已经包含有传入的key,那么旧的value值就会被替换掉,如果有旧的value被替换掉,那么就返回这个旧的value,否则就返回null
        public V put(K key, V value) {
            return putVal(hash(key), key, value, false, true);
        }
    

    这里提到了null,其实在官方对HashMap的解释中就提到过,HashMap的实现方式和HashTable几乎是一样的,除了它的方法都是不同步的和允许null值以外。所以说HashMap既允许key为null,也允许value为null
    在之前分析putMapEntries这个方法的时候我们就看到了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;
    
              //table为空,初始化
            if ((tab = table) == null || (n = tab.length) == 0)
                n = (tab = resize()).length;
            //位置 (n - 1) & hash上还没有节点,直接存放到这个位置上就行了
            if ((p = tab[i = (n - 1) & hash]) == null)
                tab[i] = newNode(hash, key, value, null);
            else {//位置 (n - 1) & hash上已经有节点了
                Node<K,V> e; K k;
            //判断这个位置上节点的key值是否和传入的key相同,如果相同记录下这个节点,后面将其value值替换为新值
                if (p.hash == hash &&
                    ((k = p.key) == key || (key != null && key.equals(k))))
                    e = p;
            //如果这个位置上节点的key值和传入的key不相同
            //如果这个节点的类型为TreeNode的话
                else if (p instanceof TreeNode)
                    e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
                else {
            //这个节点是一个双向链表,在链表中查找是否又节点和传入的key值相同,如果有就记录下这个节点,后面对其value值进行替换,否则就在链表的尾部插入新节点
                    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;
                        }
                        //在链表中找到了和传入key值相同的节点
                        if (e.hash == hash &&
                            ((k = e.key) == key || (key != null && key.equals(k))))
                            break;
                        p = e;
                    }
                }
              //在这个位置上找到了一个节点和传入的key值相同,替换这个节点value值,并返回旧的value
                if (e != null) { // existing mapping for key
                    V oldValue = e.value;
                    if (!onlyIfAbsent || oldValue == null)
                        e.value = value;
                    afterNodeAccess(e);
                    return oldValue;
                }
            }
            //HashMap修改次数
            ++modCount;
            //节点数超过阀值
            if (++size > threshold)
                resize();
            afterNodeInsertion(evict);
            return null;
        }
    
    final TreeNode<K,V> putTreeVal(HashMap<K,V> map, Node<K,V>[] tab,
                                           int h, K k, V v) {
                Class<?> kc = null;
                boolean searched = false;
                TreeNode<K,V> root = (parent != null) ? root() : this;
                for (TreeNode<K,V> p = root;;) {
                    int dir, ph; K pk;
                    //根据hash值决定在左子树还是在右子树中插入
                    //在左子树中插入
                    if ((ph = p.hash) > h)
                        dir = -1;
                    //在右子树中插入
                    else if (ph < h)
                        dir = 1;
                    //hash值相等
                    //节点的key值和传入的key值相同,返回这个节点,在putVal方法中会将这个节点的value值修改为新值
                    else if ((pk = p.key) == k || (k != null && k.equals(pk)))
                        return p;
                    //hash值相等,但是节点的key值和传入的key值不同,就通过comparable比较节点的key值和传入的key值,如果comparable比较的结果等于0
                    else if ((kc == null &&
                              (kc = comparableClassFor(k)) == null) ||
                             (dir = compareComparables(kc, k, pk)) == 0) {
                        if (!searched) {
                            TreeNode<K,V> q, ch;
                            searched = true;
                            //在左右子树中查找节点
                            if (((ch = p.left) != null &&
                                 (q = ch.find(h, k, kc)) != null) ||
                                ((ch = p.right) != null &&
                                 (q = ch.find(h, k, kc)) != null))
                                return q;
                        }
                        dir = tieBreakOrder(k, pk);
                    }
    
                    TreeNode<K,V> xp = p;
                    //到了叶子节点
                    if ((p = (dir <= 0) ? p.left : p.right) == null) {
                        Node<K,V> xpn = xp.next;
                        TreeNode<K,V> x = map.newTreeNode(h, k, v, xpn);
                        if (dir <= 0)
                            xp.left = x;
                        else
                            xp.right = x;
                      //这是一个线索化的红黑树,即是说每一个节点都有一个前节点和后节点,这个在后面会有用到
                        xp.next = x;
                        x.parent = x.prev = xp;
                        if (xpn != null)
                            ((TreeNode<K,V>)xpn).prev = x;
                      //插入节点后做平衡化操作
                        moveRootToFront(tab, balanceInsertion(root, x));
                        return null;
                    }
                }
            }
    

    上面反复提到一个概念就是key值相等,这里相等的含义表示这两个引用指向同一个对象或是它们的equals方法返回true,所以我们可以看到在HashMap中的Key的类型的hashCode方法和equals方法对HashMap的执行都是有影响的。
    首先定位在数组中的索引值就是通过hashCode进行计算的

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

    而equals方法对判定HashMap中是否已经存在相同的key产生影响

    还有一个treeifyBin方法

    final void treeifyBin(Node<K,V>[] tab, int hash) {
            int n, index; Node<K,V> e;
          //如果table数组的长度小于阀值MIN_TREEIFY_CAPACITY,就不转化为红黑树了,进行扩容操作(resize)
            if (tab == null || (n = tab.length) < MIN_TREEIFY_CAPACITY)
                resize();
        //数组长度超过阀值,且索引(n - 1) & hash位置不为空
            else if ((e = tab[index = (n - 1) & hash]) != null) {
                TreeNode<K,V> hd = null, tl = null;
                //while循环将链表中的节点都替换为TreeNode,注意新的链表和原有链表的结构是一样的,也就是即使转换为了一棵红黑树,那这棵树也是线索化的,可以按链表的方式访问,后面遍历时会用到
                do {
                    TreeNode<K,V> p = replacementTreeNode(e, null);
                    if (tl == null)
                        hd = p;
                    else {
                        p.prev = tl;
                        tl.next = p;
                    }
                    tl = p;
                } while ((e = e.next) != null);
                //这里才是真正将链表转换为红黑树
                if ((tab[index] = hd) != null)
                    hd.treeify(tab);
            }
        }
    

    get

    //返回和传入key值关联的value,如果没有就返回null
    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;
            //如果table不为空且索引(n - 1) & hash上存放有对象
            if ((tab = table) != null && (n = tab.length) > 0 &&
                (first = tab[(n - 1) & hash]) != null) {
                //检查索引上的第一个节点,如果hash值和key值都相等就返回这个节点
                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);
                   //如果是一个链表,就遍历链表查找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 TreeNode<K,V> getTreeNode(int h, Object k) {
                return ((parent != null) ? root() : this).find(h, k, null);
            }
    final TreeNode<K,V> find(int h, Object k, Class<?> kc) {
                TreeNode<K,V> p = this;
                do {
                    int ph, dir; K pk;
                    TreeNode<K,V> pl = p.left, pr = p.right, q;
                    //根据hash值决定在左子树还是右子树中查找,这是典型的二分查找
                    //在左子树中查找
                    if ((ph = p.hash) > h)
                        p = pl;
                    //在右子树查找
                    else if (ph < h)
                        p = pr;
                    //下面的分支都是hash值相等
                  //找到了返回节点
                    else if ((pk = p.key) == k || (k != null && k.equals(pk)))
                        return p;
                    //左子树为空就在右子树找
                    else if (pl == null)
                        p = pr;
                    //右子树为空就在左子树找
                    else if (pr == null)
                        p = pl;
                    //通过comparable比较决定是在左子树还是右子树中查找
                    else if ((kc != null ||
                              (kc = comparableClassFor(k)) != null) &&
                             (dir = compareComparables(kc, k, pk)) != 0)
                        p = (dir < 0) ? pl : pr;
                    else if ((q = pr.find(h, k, kc)) != null)
                        return q;
                    else
                        p = pl;
                } while (p != null);
                return null;
            }
    

    containsKey

    //调用的方法和get调用的方法是一样的
    public boolean containsKey(Object key) {
            return getNode(hash(key), key) != null;
        }
    

    containsValue

    public boolean containsValue(Object value) {
            Node<K,V>[] tab; V v;
            if ((tab = table) != null && size > 0) {
                //两从循环遍历HashMap,先遍历数组
                for (int i = 0; i < tab.length; ++i) {
                    //遍历索引位置i上的节点
                    for (Node<K,V> e = tab[i]; e != null; e = e.next) {
                        //比较value值,相等就返回
                        if ((v = e.value) == value ||
                            (value != null && value.equals(v)))
                            return true;
                    }
                }
            }
            return false;
        }
    

    这里有个奇怪的地方,按之前所说的,索引位置i可能是一个节点,也可能是一个链表还有可能是一棵树,怎么这里都按链表的方式来遍历呢,如果是一棵红黑树也能这么遍历吗?其实是可以的,前面在put方法中也有说过,索引位置i即使是一棵红黑树,那它也是一棵线索化的红黑树,它的每一个节点都有前节点和后节点,所以是可以按照链表的方式来访问的。

    entrySet

    public Set<Map.Entry<K,V>> entrySet() {
            Set<Map.Entry<K,V>> es;
            return (es = entrySet) == null ? (entrySet = new EntrySet()) : es;
        }
    

    开始看到这个方法的时候觉得有点奇怪,只是new了一个EntrySet,其他什么都没做,怎么就得到了所有节点的集合。还是先看看EntrySet是什么吧

    final class EntrySet extends AbstractSet<Map.Entry<K,V>> {
            public final int size()                 { return size; }//返回HashMap的size
            public final void clear()               { HashMap.this.clear(); }//执行HashMap的clear方法
            public final Iterator<Map.Entry<K,V>> iterator() {
                return new EntryIterator();
            }
            public final boolean contains(Object o) {
                if (!(o instanceof Map.Entry))
                    return false;
                Map.Entry<?,?> e = (Map.Entry<?,?>) o;
                Object key = e.getKey();
                Node<K,V> candidate = getNode(hash(key), key);
                return candidate != null && candidate.equals(e);
            }
            public final boolean remove(Object o) {
                if (o instanceof Map.Entry) {
                    Map.Entry<?,?> e = (Map.Entry<?,?>) o;
                    Object key = e.getKey();
                    Object value = e.getValue();
                    return removeNode(hash(key), key, value, true, true) != null;
                }
                return false;
            }
            public final Spliterator<Map.Entry<K,V>> spliterator() {
                return new EntrySpliterator<>(HashMap.this, 0, -1, 0, 0);
            }
            public final void forEach(Consumer<? super Map.Entry<K,V>> action) {
                Node<K,V>[] tab;
                if (action == null)
                    throw new NullPointerException();
                if (size > 0 && (tab = table) != null) {
                    int mc = modCount;
                    // Android-changed: Detect changes to modCount early.
                    for (int i = 0; (i < tab.length && modCount == mc); ++i) {
                        for (Node<K,V> e = tab[i]; e != null; e = e.next)
                            action.accept(e);
                    }
                    if (modCount != mc)
                        throw new ConcurrentModificationException();
                }
            }
        }
    

    我们可以看到它里面的所有方法都是调用外部类HashMap的方法,forEach也是通过两从遍历table来遍历HashMap中的所有节点的,所以它并没有自己的存储结构,它只是提供了Set的接口来访问HashMap里的元素节点

    相关文章

      网友评论

          本文标题:HashMap源码分析

          本文链接:https://www.haomeiwen.com/subject/rdzcoftx.html