从put方法看HashMap的存储结构

HashMap结构

先说结论,HashMap在存储元素时会采用数组+链表的结构,在达到一定条件后,链表会被转换为红黑树(为了在大量冲突下加快检索速度)。


大概就是这样

散列表

在看HashMap的代码之前,首先要了解一下散列表的概念,已经了解的同学可以直接跳过。
散列表(hash table)是一种数据结构,它以(key, value)的形式来存储数据,key直接映射到表中的某一个位置,可以加快查找的速度。

举个栗子来说明下普通数组和散列表查找的区别:

现在我需要到一个教室里去找一个叫做张三的人,但是我不能直接大喊一声张三你给我出来。

  • 数组不知道张三在哪,从第一个座位开始问:“请问你是张三吗?”,“对不起,我是李四。”,接着继续问第二个座位的人:“请问你是张三吗?”,“我叫王五”,然后数组需要不停的询问,直到问到某个座位上的人,他的名字叫做张三。
  • 散列表的做法是,我在他们排座位的时候就事先记录下了所有同学(key)所在的座位号(value),当我需要找张三的时候,看一下手里的座位表,嗯,他在10号座位,直接走过去就找到了他。

散列表需要解决一个问题:冲突,因为可能会存在两个不同的key映射到了表中的相同位置。
解决冲突常用的方法有链接法开放寻址法,具体可以自己去研究一下,HashMap用的是链接法。

源码

直接看put方法

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

可以看到put方法其实是调用了putVal方法,看一下putVal的方法定义

     * @param hash hash for key
     * @param key the key
     * @param value the value to put
     * @param onlyIfAbsent if true, don't change existing value
     * @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)

需要传入五个参数,第一个为key的hash值(这个是HashMap内部定义的算法处理得到的,不是HashCode),第二个为需要存储的value,第三个参数表示是否改变已经存在的值,最后一个暂时先不管。然后它还有个返回值,是之前的value。这边不理解没关系,看完下面的代码后就懂了。

在看putVal方法内部实现之前,先看一下hash方法,putVal的第一个参数是在put中将key经过hash方法处理后得到的。

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

当key为null的时候返回0(这里注意一下,HashMap的key和value都是可以为null的),不为null则返回将key的hashCode和hashCode无符号右移16后得到的数做异或得到的值(比较绕口...还是看代码比较好理解),这样实际上是将低16位与高16位做异或(无符号右移,高位置0,与0异或为其本身),注释中有提到这样做的原因,是为了减少冲突。

回头再看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;
        if ((tab = table) == null || (n = tab.length) == 0)
            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;
            else if (p instanceof TreeNode)
                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) { // existing mapping for key
                V oldValue = e.value;
                if (!onlyIfAbsent || oldValue == null)
                    e.value = value;
                afterNodeAccess(e);
                return oldValue;
            }
        }
        ++modCount;
        if (++size > threshold)
            resize();
        afterNodeInsertion(evict);
        return null;
    }

这个方法内容也不多,可以一行一行慢慢看。
首先定义了一个Node类型的数组和一个Node类型的变量,Node为HashMap中的一个内部类,其中有以下四个成员变量

        final int hash;
        final K key;
        V value;
        Node<K,V> next;

前三个不用解释,最后一个学过链表肯定知道是什么意思,是用于指向下一个结点的。如果没学过链表建议先去看一看。
接着往下看

        if ((tab = table) == null || (n = tab.length) == 0)
            n = (tab = resize()).length;

这里的table是HashMap的一个成员变量,就是开头说的那个数组,当table为null或者table的长度为0时,会调用resize()方法,看下resize()方法。

    /**
     * Initializes or doubles table size.  If null, allocates in
     * accord with initial capacity target held in field threshold.
     * Otherwise, because we are using power-of-two expansion, the
     * elements from each bin must either stay at same index, or move
     * with a power of two offset in the new table.
     *
     * @return the table
     */
    final Node<K,V>[] resize()

从resize()方法的注释中可以知道这是个用来初始化或是扩容的方法,说到扩容就要先看一下HashMap中定义个几个静态常量:

    /**
     * 默认的数组长度,必须是2的次方(原因后面再讲)
     */
    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;

    /**
     * 当HashMap的数组长度到达这个值时,链表才可能会被转换为树。
     * 否则,如果链表中有太多的结点,HashMap就会进行扩容。
     * 为了避免扩容和树化的冲突,至少应该是TREEIFY_THRESHOLD的4倍。
     * (比如在刚开构建HashMap的时候,很多结点都被存在了同一个链表里,那么会选择扩容,而不是树化)
     */
    static final int MIN_TREEIFY_CAPACITY = 64;

随便翻译了下官方的注释,可能会有点错误,大概意思应该不会错。

了解这些常量之后,再来看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
        }
        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);
        }
        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;
                    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()方法中最后面的那个if(oldTab != null)的分支是用来将旧表中的元素填充到新表中去的,就不做说明了,有兴趣可以自己去看看。
首先,这个方法记录了原table的一些信息,oldCap为原来长度,oldThr = threshold为原来的扩容点(长度到达这个值就会触发扩容)。接下来走了一个if-else分支

  • oldCap > 0
    其中又有两个分支:
    如果原来的长度已经大于等于MAXIMUM_CAPACITY那么将threshold设置为最大的int值,也就是说不会再触发扩容,并返回原来的table;
    如果原长度并没有超过最大长度,同时将原长度扩大两倍后也没超过最大长度(左移1位等于乘以2),且原长度大于等于默认的长度,那么将newThr设置为oldThr的两倍,前面在判断中已经将newCap设置为oldCap的两倍了。这里可以看出HashMap扩容时,会将数组扩大为原来的两倍。
  • oldCap <= 0 && oldThr > 0
    将newThr设置为oldThr来初始化table
  • oldCap <= 0 && oldThr <= 0
    以DEFAULT_INITIAL_CAPACITY和DEFAULT_LOAD_FACTOR来初始化table

后面还有一个newThr == 0的判断,做了一定的处理,防止后面出错。
resize()方法大概是这样,跟注释中写的一样,是用来扩容和初始化table的,现在回头再看putVal方法。

        if ((tab = table) == null || (n = tab.length) == 0)
            n = (tab = resize()).length;

这样就很明白了,第一次put的时候,table没有初始化,或者Map中没有元素时,就会通过resize()方法来初始化table,并记录长度。

        if ((p = tab[i = (n - 1) & hash]) == null)
            tab[i] = newNode(hash, key, value, null);

接下来是这一步,p为一开始定义的Node类型的参数,n是table的length。若计算得到的索引的位置上没有Node,就将新增的元素插入进去。
上面说过table的length必须为2的次方,这里就是为何这样规定的原因,当n为2的次方时(n - 1) & hash计算得到的结果等于n%hash(以余数作为索引是散列表中的一种设置索引的方法),而前者计算所需的时间要比后者少的多。前面提到了内部的hash算法是为了减少冲突与n为2的次方也有关系,因为n - 1高位全为0低位全为1所以这个&操作只会与hash的低位有关。

            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) { // existing mapping for key
                V oldValue = e.value;
                if (!onlyIfAbsent || oldValue == null)
                    e.value = value;
                afterNodeAccess(e);
                return oldValue;
            }
        }

当目标索引不为空时会进入上面的分支,里面又有if-else,先跳过,看一下最后面的if(e != null),e可以理解为目标索引上已有Node,这里面用到了onlyIfAbsent参数用来判断是否覆盖原value,afterNodeAccess(e)这个方法不用管,是交给HashMap的子类去实现的(如LinkedHashMap),在HashMap中没有做具体实现,包括后面的afterNodeInsertion(evict)也是这样,所以传入的evict参数也不需要管。
再来看上面的if-else,第一个没什么好说的,第二个是如果当前目标索引位置的链表已经转换为树了,那么调用往树中插入结点的方法,这边也不深入去探究了。最后一个else则是当目标索引已经有值时,从已有Node拉出链表的操作,其中有判断时候需要转换为树结构。

        ++modCount;
        if (++size > threshold)
            resize();
        afterNodeInsertion(evict);
        return null;

这里是目标索引为空时会走到的地方,在table插入元素后会判断是否需要扩容,modCount注释中描述的是记录结构性的修改次数,我大概看了一下,应该是针对table被修改的次数,链表和树的修改不会被记录。

总结

源码还是很友好的,很容易看出是顺序表+链表或树的结构。比较有意思的是里面的一些算法,比如hash方法,索引的计算,还有个tableSizeFor方法没有提到。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,923评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,154评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,775评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,960评论 1 290
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,976评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,972评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,893评论 3 416
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,709评论 0 271
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,159评论 1 308
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,400评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,552评论 1 346
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,265评论 5 341
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,876评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,528评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,701评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,552评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,451评论 2 352

推荐阅读更多精彩内容

  • 今天下午妈妈带我去万达广场玩。 我本来想去一楼玩滑梯的,结果走到一楼一看滑梯没有了。啊,今天怎么没有呢...
    郝一鼎阅读 1,274评论 0 1
  • 身体抱恙的时候,晒着太阳闭目养神的时候,有点心慌,有点烦躁,有点太安静,又有点太喧闹。来来往往的人,世间形形色色的...
    柳暮阅读 221评论 0 1
  • ️识字文章,我简单的讲解一下,我对于这种中国古文化的文章其实一向是不感冒的,今天讲了仁,仁上有千,下方有心。类比了...
    设计师阿瑞阅读 357评论 0 1