HashMap源码解析

适合阅读的人群

文笔不是很好,如果对于HashMap没有一个大致的了解,最好不要看

目录

  1. HashMap的几个基本概念

  2. HashMap的成员变量

  3. HashMap的构造方法

  4. HashMap的几个基础方法

  5. HashMap的get()方法

  6. HashMap的put()方法

  7. HashMap的resize()方法

  8. HashMap的remove()方法

HashMap的几个基本概念

HashMap源码解析_第1张图片

桶(bucked):存放同一个hash地址的
table[]:即存放桶的数组
容量(capacity):即table.length
loadfactor:负载因子,权衡hash冲突情况

HashMap的成员变量

首先看HashMap定义的几个常量

//默认容器大小
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;

//需要转换为红黑树的容器容量阈值
static final int MIN_TREEIFY_CAPACITY = 64;

这里需要注意到的几个细节:

  1. TREEIFY_THRESHOLD:jdk1.8以后,如果长度超过这个阈值,则一个桶内的node由链表转为红黑树
  2. UNTREEIFY_THRESHOLD:当红黑树长度小于这个阈值,就会再退化成链表
  3. 只有capacity>=MIN_TREEIFY_CAPACITY时,才需要将链表转换为红黑树,否则只需要resize()

这里第三点补充一下:现在HashMap源码解读,关于链表转换为红黑树这一块普遍都有误导性,大部分资料都是说当链表长度到达8时,桶结构从链表转换为红黑树,其实这是不严谨的,还需要当前容量capacity>=MIN_TREEIFY_CAPACITY(即桶数量>=64)这个条件,否则进行扩容而不是转换红黑树,关键源码在下面

        if (tab == null || (n = tab.length) < MIN_TREEIFY_CAPACITY)
            resize();

这是有道理的,读者也不妨思考一下,如果当capacity的容量只有16的时候,hash严重冲突链表长度到达8,除了hash不均匀之外,也有可能是容量太小,导致冲突严重,这时候对table进行扩容,再对元素均匀散列才是最有效的办法。
再提一点,链表转为红黑树这个事件发生的概率有多大呢,我们捋一下几个条件:

  1. capacity>=MIN_TREEIFY_CAPACITY
  2. 链表长度>=TREEIFY_THRESHOLD

但HashMap还有一个loadfactor参数,就拿默认值0.75举例,假设桶已经有64个了,那么当节点到达48个的时候就会扩容,平均分的话,一个桶还不够分一个节点,一旦扩容,又重新对半进行散列,因此需要满足全部以上条件的话,那是非常小的小概率事件。
那么这个算法还有意义吗?

有意义的,除了应对这个随机发生的小概率事件,还需要应对人为刻意的制造hash冲突,如果在服务器环境中,如果得到你的hash计算方法,那么有可能针对hash方法进行hashdos攻击,web服务器会有一个HashMap保存提交的参数,如果不对参数数量进行限制的话,那么一次性提交大量hash冲突的参数,那么光一次get()方法就能拖垮服务器的吞吐量,使用红黑树,至少能保证了get方法的效率,但是要解决hashdos还是要以预防为主。

继续看HashMap的实例变量

//hash表,每个Node就是一个桶的头节点
transient java.util.HashMap.Node[] table;

//用来返回迭代器
transient Set> entrySet;

//数量
transient int size;

//记录修改次数
transient int modCount;

//扩容的阈值,等于loadFactor*capacity
int threshold;

//负载因子
final float loadFactor;

这里需要注意到的细节:

  1. modCount有什么作用:是为了HashMap的迭代器能够记录map有没有被修改过,在多线程情况,如果迭代器迭代时发现modCount变化了,则说明当前这份数据已经无效了,就会抛出一个ConcurrentModificationException异常
  2. threshold就是size的一个阈值,当size到达threshold时,就需要扩容,threshold等于loadFactor*capacity
  3. 为什么table都要加上transient不允许序列化?是因为HashCode()的方法是基于平台的,不同平台的同一个对象可能会得到不同的HashCode,因此不允许table进行序列化
  4. 没有capacity变量,capacity=table.length

HashMap的构造方法

查看HashMap的源码,可以看到HashMap有四种构造器

//1.设定容器大小和负载因子
public HashMap(int initialCapacity, float loadFactor) {
    if (initialCapacity < 0)
        throw new IllegalArgumentException("Illegal initial capacity: " +
                initialCapacity);
    //最大不能超过MAXIMUM_CAPACITY
    if (initialCapacity > MAXIMUM_CAPACITY)
        initialCapacity = MAXIMUM_CAPACITY;
    if (loadFactor <= 0 || Float.isNaN(loadFactor))
        throw new IllegalArgumentException("Illegal load factor: " +
                loadFactor);
    this.loadFactor = loadFactor;
    this.threshold = tableSizeFor(initialCapacity);
}

//2.设定容器大小
public HashMap(int initialCapacity) {
    this(initialCapacity, DEFAULT_LOAD_FACTOR);
}

//3.默认方法,使用默认参数
public HashMap() {
    this.loadFactor = DEFAULT_LOAD_FACTOR; 
}

//4.使用默认构造器,同时将m填充到这个hashMap
public HashMap(Map m) {
    this.loadFactor = DEFAULT_LOAD_FACTOR;
    putMapEntries(m, false);
}

这里关注一下第一个构造方法的细节:

this.threshold = tableSizeFor(initialCapacity);

当给定了初始容量参数之后,就会调用tableSizeFor()方法,返回一个大于initialCapacity的最小2的幂次方,以符合HashMap的Capacity必须为2的幂次方的要求(为什么这么要求,后面会提到),这里tableSizeFor()的返回值,即表示最后容器的初始化值,而这里的threshold就不等于负载因子*容器,而表示的是初始容量

    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;
    }

这个是tableSizeFor()方法,用了一次很巧妙的方法得到cap最小2的幂次方,有兴趣的可以看一下这个博客

同时threshold在初始化时等于0或者等于初始化的容量,在第一次resize()的时候才会变成负载因子*容器

HashMap的几个基础方法

hash()方法

是==HashMap==中用来计算Key的hash值的唯一方法

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

这里为什么不直接用对象的hashCode,而需要右移十六位进行异或,简单来说,是让hashCode高16位和第16位进行异或,增加hashCode的随机性,这里具体不提了,有兴趣的可以看HashMap 的 hash 方法原理是什么

同时我们需要注意到,这里的key是允许为null,当key为null时,默认hash值为0,后面可以看到,即key为null的对象,都保存到table[0]桶下面

treeifyBin()方法

当一个桶中的链表长度>TREEIFY_THRESHOLD时要执行的方法,执行结果有两种

  1. 将链表转换为红黑树
  2. 执行一次rezise()
    取决于capacity是否>=MIN_TREEIFY_CAPACITY
    final void treeifyBin(Node[] tab, int hash) {
        int n, index; Node e;
        if (tab == null || (n = tab.length) < MIN_TREEIFY_CAPACITY)
            resize();
        else if ((e = tab[index = (n - 1) & hash]) != null) {
            TreeNode hd = null, tl = null;
            do {
                TreeNode 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);
        }
    }

HashMap的get()方法

接下来是HashMap的第一个重点方法,get()方法

在看源码之前,我们可以先设想,如果我们是编写代码的人,我们会怎么写get()方法:

  1. 首先获取到Key的Hash值
  2. 根据Hash定位到table的桶位置
  3. 对桶内元素进行遍历,比较对象是否存在
  4. 如果存在则返回对象

之后我来看get()方法的源码,可以看到可以访问的公有的方法.是先对key进行hash之后调用一个getNode()方法,这个方法是包访问权限

public V get(Object key) {
    java.util.HashMap.Node e;
    return (e = getNode(hash(key), key)) == null ? null : e.value;
}

继续看getNode()方法

final java.util.HashMap.Node getNode(int hash, Object key) {
    //tab为hash表,first为hash桶的头指针,n为表的长度,k为用来遍历链表的指针
    java.util.HashMap.Node[] tab; java.util.HashMap.Node first, e; int n; K k;
    // 第一步:获取表的长度n,获取到hash桶的头指针first
    if ((tab = table) != null && (n = tab.length) > 0 &&
            //这里用n-1和hash值进行hash,之后讲解为什么要这样
            (first = tab[(n - 1) & hash]) != null) {
        // 第二步:检查hash桶的头指针是否和要找的对象key相等
        if (first.hash == hash && 
                ((k = first.key) == key || (key != null && key.equals(k))))
            return first;
        // 第三步:遍历桶进行查找
        if ((e = first.next) != null) {
            // 判断如果是红黑树的结构,则用TreeNode的静态方法递归查找
            if (first instanceof java.util.HashMap.TreeNode)
                return ((java.util.HashMap.TreeNode)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);
        }
    }
    // 如果都没有找到,则返回null
    return null;
}

这里已经把各个步骤都详细的写了注释,这里有一个细节就是桶的下标tab[(n - 1) & hash]为什么是通过(n - 1) & hash进行定位?

hashmap要求容量是2的幂次方

/**
 * The default initial capacity - MUST be a power of two.
 */

而n是hashmap的容量

假设这里有一个key:使用hash()方法得到的hash值为16位:
1111111111110101
换为十进制就是65535

hashmap的n为:
2<<4
换为十进制就是16

意味着最大的能定位到的下标也只是16-1=15
如果直接用hash值就数组越界了
因此我们需要对hash对n进行取余

n-1 = 15
换位二进制就是1111
hash & (n - 1)即:
  1111111111110101
& 0000000000001111
= 0000000000000101
最后取到(n-1)位0101

用hash & (n - 1)进行取余效率更快,同时也解释了为什么hashmap要求容量是2的幂次方

HashMap的put()方法

在HashMap的put()方法之前,我们也可以先思考put需要考虑什么问题

我们直到hashMap是基于数组实现

  1. 如果hash到同一个位置,hash冲突了怎么办
  2. 如果hash冲突严重,在一个桶内有上万个节点怎么办

接下来看put方法的源码

    //onlyIfAbsent代表key相同时,是否要替换值
    public V put(K key, V value) {
        return putVal(hash(key), key, value, false, true);
    }

这里同样调用到一个包访问方法puVal()

    //onlyIfAbsent表示当key重复需不需要用新值替换旧值
    final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
                   boolean evict) {
        //tab为table,p为临时指针,n为table的长度,i为hash到的桶
        java.util.HashMap.Node[] tab; java.util.HashMap.Node p; int n, i;
        // 如果table没有初始化,则用resize()方法初始化,resize()在后面提到
        if ((tab = table) == null || (n = tab.length) == 0)
            n = (tab = resize()).length;
        //如果hash到的桶不存在,则作为头指针插入
        if ((p = tab[i = (n - 1) & hash]) == null)
            tab[i] = newNode(hash, key, value, null);
        else {
            java.util.HashMap.Node e; K k;
            //hash到的值相等
            if (p.hash == hash &&
                    //判断是否是同一个对象,或者相等(例如String)
                    ((k = p.key) == key || (key != null && key.equals(k))))
                e = p;
            //如果是树节点
            else if (p instanceof java.util.HashMap.TreeNode)
                //则用树节点的putTreeVal方法
                e = ((java.util.HashMap.TreeNode)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
                            //则转换为红黑树或进行一次resize();
                            treeifyBin(tab, hash);
                        break;
                    }
                    //如果查找到相同的值则返回
                    if (e.hash == hash &&
                            ((k = e.key) == key || (key != null && key.equals(k))))
                        break;
                    p = e;
                }
            }
            //如果key已经存在,则直接返回
            if (e != null) { // existing mapping for key
                V oldValue = e.value;
                //根据onlyIfAbsent决定是否要替换
                if (!onlyIfAbsent || oldValue == null)
                    e.value = value;
                afterNodeAccess(e);
                //返回旧值
                return oldValue;
            }
        }
        //如果新插入的Node,就会执行一下方法
        //更新操作数
        ++modCount;
        //如果大于阙值threshold,则需要resize
        if (++size > threshold)
            resize();
        //这时一个回调方法,当插入节点的时候执行这个方法,但是在HashMap里方法是空的,留给子类覆写
        afterNodeInsertion(evict);
        return null;
    }

关于put()方法,上面也已经说的足够详细了,设计到一个比较重要的方法resize(),这个在下一节会继续讲到

总结

  1. 在jdk1.7以前,链表的插入是使用头插法,jdk1.8之后是使用的尾插法,这一点不要混淆了
  2. 允许插入的Key为null,hash的桶下标为0
  3. 允许插入的Value为null
  4. onlyIfAbsent参数默认为false,因此当key重复时,新value会替换掉旧的value
  5. 当一个桶内的元素数量超过TREEIFY_THRESHOLD,则会将当前桶由链表转换为红黑树
  6. 当当前容器中的节点数量size到达threashold(即负载因子*容量)时,就会进行扩容
  7. 每次插入节点都会更新modCount

HashMap的resize()方法

HashMap的resize()方法主要有两个作用:

  1. 初始化容器时,为容器创建一个默认的map
  2. 当插入的数据到达阈值时,进行扩容
    final java.util.HashMap.Node[] resize() {
        java.util.HashMap.Node[] oldTab = table;
        int oldCap = (oldTab == null) ? 0 : oldTab.length;
        //旧的阈值,如果size到达threshold,则需要扩容
        int oldThr = threshold;
        int newCap, newThr = 0;
        //如果oldCap>0,则意味着table已经初始化过了
        if (oldCap > 0) {
            //最大不能超过MAXIMUM_CAPACITY,如果到达MAXIMUM_CAPACITY,threshold不作限制
            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,oldThr>0意味着table还未初始化,同时是调用的有初始化容量的构造器,有给定的初始容量
        else if (oldThr > 0) 
            //则新容量=oldThr
            newCap = oldThr;
        //如果oldCap==0,oldThr==0意味着table还未初始化,同时调用的是默认的构造器
        else {
            //则新容量为默认值
            newCap = DEFAULT_INITIAL_CAPACITY;
            //newThr等于负载因子*容量大小
            newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
        }
        //对threshold赋值
        if (newThr == 0) {
            //等于负载因子*容量大小
            float ft = (float)newCap * loadFactor;
            newThr = (newCap < MAXIMUM_CAPACITY && ft < (float)MAXIMUM_CAPACITY ?
                    (int)ft : Integer.MAX_VALUE);
        }
        threshold = newThr;
        //下面是需要把旧的table的数据全部再hash到新的table
        @SuppressWarnings({"rawtypes","unchecked"})
        java.util.HashMap.Node[] newTab = (java.util.HashMap.Node[])new java.util.HashMap.Node[newCap];
        table = newTab;
        if (oldTab != null) {
            //对table每个桶进行遍历
            for (int j = 0; j < oldCap; ++j) {
                java.util.HashMap.Node e;
                if ((e = oldTab[j]) != null) {
                    oldTab[j] = null;
                    //如果是桶的头指针,则直接再hash到新的桶
                    if (e.next == null)
                        newTab[e.hash & (newCap - 1)] = e;
                    //如果是树节点,则进行切分,切分成两棵子树,或者退化成两个链表
                    else if (e instanceof java.util.HashMap.TreeNode)
                        ((java.util.HashMap.TreeNode)e).split(this, newTab, j, oldCap);
                    //如果是链表,则拆分成两个新链表
                    else {
                        //分为高位链表和低位链表
                        java.util.HashMap.Node loHead = null, loTail = null;
                        java.util.HashMap.Node hiHead = null, hiTail = null;
                        java.util.HashMap.Node next;
                        do {
                            next = e.next;
                            //和旧容器长度进行hash如果等于0则说明 hash0则说明 hash>oldCap,链接到高位链表
                            else {
                                if (hiTail == null)
                                    hiHead = e;
                                else
                                    hiTail.next = e;
                                hiTail = e;
                            }
                        } while ((e = next) != null);
                        //最后将高位低位链表放回到新的table
                        if (loTail != null) {
                            loTail.next = null;
                            newTab[j] = loHead;
                        }
                        if (hiTail != null) {
                            hiTail.next = null;
                            newTab[j + oldCap] = hiHead;
                        }
                    }
                }
            }
        }
        return newTab;
    }

扩容总结为三步骤

  1. 获得新容量newCap,更新域里面的threshold
  2. 创建一个新table,长度为newCap
  3. 将旧的table里面的Node,拷贝到新容器(桶的Key的hash值不需要重新计算,只需要计算hash在新table的高位还是低位)

HashMap的remove()方法

remove()方法比较简单

    public V remove(Object key) {
        java.util.HashMap.Node e;
        return (e = removeNode(hash(key), key, null, false, true)) == null ?
                null : e.value;
    }
    //matchValue表示只有value相等的时候删除
    final java.util.HashMap.Node removeNode(int hash, Object key, Object value,
                                                 boolean matchValue, boolean movable) {
        java.util.HashMap.Node[] tab; java.util.HashMap.Node p; int n, index;
        if ((tab = table) != null && (n = tab.length) > 0 &&
                (p = tab[index = (n - 1) & hash]) != null) {
            java.util.HashMap.Node node = null, e; K k; V v;
            //如果是桶的头指针
            if (p.hash == hash &&
                    ((k = p.key) == key || (key != null && key.equals(k))))
                node = p;
            else if ((e = p.next) != null) {
                //判断是否是红黑树
                if (p instanceof java.util.HashMap.TreeNode)
                    //获得红黑树的节点
                    node = ((java.util.HashMap.TreeNode)p).getTreeNode(hash, key);
                //否则递归获得链表节点
                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为true就需要判断,两个对象时候相等,或者是否equals
            if (node != null && (!matchValue || (v = node.value) == value ||
                    (value != null && value.equals(v)))) {
                //如果是红黑树节点
                if (node instanceof java.util.HashMap.TreeNode)
                    ((java.util.HashMap.TreeNode)node).removeTreeNode(this, tab, movable);
                //如果是链表且是链表的头节点
                else if (node == p)
                    tab[index] = node.next;
                //如果是链表的中间节点
                else
                    p.next = node.next;
                //操作数+1
                ++modCount;
                //size-1
                --size;
                //回调函数,目前实现为空
                afterNodeRemoval(node);
                return node;
            }
        }
        return null;
    }

最后

这里没有涉及红黑树的算法部分
如果有写的不正确的地方,欢迎提出来,如果有不理解的地方,也可以提出来

你可能感兴趣的:(HashMap源码解析)