源码解析

什么是 HashMap(JDK 1.8)

2018-02-27  本文已影响65人  豆豆先生的小屋

本文基于 JDK 1.8。

HashMap 是用于存储键值对的数据结构,它根据键的 hashCode 值来存储数据。遍历顺序是不确定的。最多只允许一条记录的键为 null,允许多条记录的值为 null。非线程安全,即任一时刻多个线程同时写可能会导致数据的不一致。

本文主要结合源码,从存储结构、常用函数、扩容机制以及安全性等方面深入讲解 HashMap 的工作原理。

存储结构

我们先来看看 HashMap 的成员变量。

// 数组默认大小
static final int DEFAULT_INITIAL_CAPACITY = 1 << 4; 
// 数组最大长度
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;
// 哈希桶数组
transient Node<K,V>[] table;
// 实际存储的元素个数
transient int size;
//  HashMap 结构变化次数
transient int modCount;
// 阈值 = table.length * loadFactor,能容纳 node 的最大数量
int threshold;
// 负载因子
final float loadFactor;

由源码可知,HashMap 中的所有键值对都是以 Node 的形式存放在一个 Node 数组 table 中。来看看 Node 的结构。

static class Node<K,V> implements Map.Entry<K,V> {
    final int hash;
    final K key;
    V value;
    Node<K,V> 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() {...}
    public final V setValue(V newValue) {...}
    public final boolean equals(Object o) {...}
}

Node 是 HashMap 的一个 内部类,实现了 Map.Entry<K,V> 接口。就是一个键值对。

从存储结构来讲,HashMap 是基于数组+链表+红黑树来实现的。下图中的一个黑点就是一个 Node 对象。

hashMap内存结构图.png

大家都知道 HashMap 采用键的 hashCode 值作为 key 然后通过 hash 函数(下文有介绍)得到数组索引下标来确定对象的存储位置,那么问题来了,再好的 hashCode 算法都有可能产生 hash 冲突,那么如何解决冲突也是一大难题。HashMap 采用的是链地址法,就是当两个对象的 hashCode 一样时,就把该数组下标对应的对象变为链表。数组只存放链表的头结点。当链表长度过长时,会增加遍历的时间复杂度,JDK 1.8 对此做了优化,当链表长度大于 8 时,将链表转换为红黑树,利用红黑树快速增删改查的特点大大提高了遍历效率。

所以如何设计一个尽量散列均匀的 hash 函数是关键 ,如果哈希桶数组比较大,那么不是很好的 hash 函数也会比较分散,如果哈希桶数组很小 ,即使再好的 hash 函数也会产生较多 hash 冲突。说白了就是在时间和空间上做权衡。结合自己的业务场景来确定 hash 数组的大小,并设计一个好的 hash 算法。

常用函数

public HashMap() {
    this.loadFactor = DEFAULT_LOAD_FACTOR; 
}

public HashMap(int initialCapacity) {
    this(initialCapacity, DEFAULT_LOAD_FACTOR);
}

public HashMap(int initialCapacity, float loadFactor) {
    if (initialCapacity < 0)
        throw new IllegalArgumentException("Illegal initial capacity: " +
                                           initialCapacity);
    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);
}

其中用的最多的是第一个参数为空的构造方法。将 loadFactor 设置为默认值。这里说一下第三个构造方法,前几行都是检验参数的正确性的,不多说,最后一行,设置 HashMap 的阈值。我们来看看 tableSizeFor 方法。

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

函数不长,但是咋一看不知道用来干啥的。其实这个函数是用来找到大于等于 cap 的最小的 2 的幂。
我们来举例说明。
如果 n 为零,那么经过移位操作之后结果还是零,返回 n + 1 = 1 。
如果 n 为负数,那么无论如何移位操作最后结果肯定还是负数,所以返回 1。
如果 n 为正数,那么 n 的二进制位中肯定有一位为 1。我们暂且只考虑最高位的 1,因为其他位的 1 无影响。

无符号右移 1 位之后做按位或操作,使得 n 最高位后面的一位也为变成了 1。注意这时候最高位有两个连续的 1;

无符号右移 2 位之后做按位或操作,n 最高位两个连续的 1 后面两位也都成了 1。注意这时候最高位有四个连续的 1;

无符号右移 4 位之后做按位或操作,n 最高位四个个连续的 1 后面四位也都成了 1。注意这时候最高位有八个连续的 1;

无符号右移 8 位之后做按位或操作,n 最高位八个连续的 1 后面八位也都成了 1。注意这时候最高位有十六个个连续的 1;

无符号右移 16 位之后做按位或操作,n 最高位十六个连续的 1 后面十六位也都成了 1。注意这时候最高位有三十二个连续的 1;

所以这个函数就是把 n 最高位的 1 的后面所有位都变成了 1。然后这个值如果 >= MAXIMUM_CAPACITY 的话就返回 MAXIMUM_CAPACITY;否则返回 n + 1。为什么是 n + 1 而不是 n 呢。你想想二进制中那么多个连续的 1 在增加 1 后是不是会进位得到一个 2 的幂的数。刚开始为什么要 cap - 1 呢。这是因为如果不 减去 1 的话,如果 cap 刚好是 2 的幂那么返回的结果就会变成 cap 的 2 倍。
这个函数写的真是大赞呐!
最后返回的这个值赋给了 threshold。按道理来讲应该这么写才对啊!

 this.threshold = tableSizeFor(initialCapacity) * loadFactor ;

这样子才符合 threshold 的意思呀。但是请注意,在构造函数中并没有对哈希桶 table 初始化,初始化的过程放到了 put 函数中,并且该函数会对 threshold 重新计算值!

HashMap put 过程可以用下图来表示。

hashMap put方法执行流程图.png
  1. 判断键值对数组 table 是否为 null,是则执行 resize() 进行扩容;
  2. 根据键值 key 计算 hash 值得到插入的数组索引 i,如果 table[i]== null,直接新建节点插入,转向 6,如果 table[i] 不为 null,转向下一步;
  3. 判断 table[i] 的首个元素的 key 是否和当前 key 相同,如果相同直接覆盖 value 并转向 6,否则转向下一步。
  4. 判断 table[i] 是否为 treeNode,如果是红黑树,则直接在树中插入键值对并转向 6,否则转向下一步。
  5. 遍历 table[i],判断链表长度是否大于 8,大于 8 的话把链表转换为红黑树,在红黑树中执行插入操作,否则进行链表的插入操作;遍历过程中若发现 key 已经存在直接覆盖 value 即可;
  6. 插入成功后,判断实际存在的键值对数量 size 是否超多了最大容量 threshold,如果超过,进行扩容。

注意:上面 3 说的 key 相同指的是 hashCode 和 equals 均相同

put 函数源码如下:

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;
    // tab 为空,则创建新的数组
    if ((tab = table) == null || (n = tab.length) == 0)
        n = (tab = resize()).length;
    // 该索引处没有 node,直接插入
    if ((p = tab[i = (n - 1) & hash]) == null)
        tab[i] = newNode(hash, key, value, null);
    else {
        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);
        else {
            // 遍历链表
            for (int binCount = 0; ; ++binCount) {
                // 到达链表末尾
                if ((e = p.next) == null) {
                    p.next = newNode(hash, key, value, null);
                    // 链表长度大于 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;
            }
        }
        // e 不为空说明在哈希桶中找到了对应的节点,返回节点 value 即可。
        if (e != null) { // existing mapping for key
            V oldValue = e.value;
            if (!onlyIfAbsent || oldValue == null)
                e.value = value;
            afterNodeAccess(e);
            return oldValue;
        }
    }
    // 操作次数 + 1
    ++modCount;
    // 容量 + 1,如果超过最大容量则扩容
    if (++size > threshold)
        resize();
    afterNodeInsertion(evict);
    return null;
}

注意 put 函数拿到 key 的 hash 值之后时通过 (n - 1) & hash来确定索引位置的,因为 HashMap 的数组大小总为 2 的幂,所以 (n - 1) & hash 相当于 n % hash。因为位运算效率比较高,这里是 HashMap 做的优化,所以 HashMap 限制哈希桶数组的大小为 2 的幂。另外 put 函数中还有一个 hash 函数,用以计算 key 的 hash 值。源码如下。

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

大家想想为啥不直接用 hashCode 作为值呢。主要有两方面的考虑,其一一是防止开发人员重写 hashCoder 函数时性能不是很好,散列不够均匀;其二是预防数组比较小时,散列比较均匀。
例如:HashMap 初始化时默认数组大小为 16。两个不同的 key 的 hashCode 即使相差很大,但如果最后四位二进制相同的话得出的数组下标也是相同的,这很明显不是我们想要的结果。

直接获取hashCode.png

但是如 JDK 1.8 所写,加入了高位运算结果就迥然不同了。

高位参与运算.png

HashMap 的查找操作比较简单,过程可以用下图来表示。

hashMap get 方法执行流程图.png
  1. 定位到键所在的数组的下标,并获取对应节点 n。
  2. n 是否为 null,如果是则返回 null 并结束。否则转至下一步。
  3. 判断 n 的 key 和要查找的 key 的是否相同,如果相同则返回 n 并结束。否则转至下一步。
  4. 判断是否有后续节点 m,如果没有则结束。否则转至下一步。
  5. m 是否为红黑树,是则遍历红黑树,如果存在某一个节点的 key 与要找的 key 相同则返回该节点,否则返回 null。如果不是红黑树转至下一步。
  6. 遍历链表,如果存在某一个节点的 key 与要找的 key 相同则返回该节点,否则返回 null。

注意:上面说的 key 相同指的是 hashCode 和 equals 均相同

get 函数源码如下:

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) {
        // 如果 key 和哈希桶中的 key 相同(hashCode 和 equals)直接返回
        if (first.hash == hash && 
            ((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;
}

扩容机制

当 HashMap 里面的元素个数超过阈值时就要扩容了,不然容易影响性能。但是数组是无法自动扩容的,像 ArrayList 一样,需要申请一个新的数组,HashMap 是申请了一个原来容量大小 2 倍的数组。然后遍历旧数组,重新计算每一个元素的索引位置,复制到新数组中去。这里也算是一个优化,因为 HashMap 的哈希桶数组大小总是为 2 的幂。所以重新计算的索引位置要么还是在原来的位置不变,要么是原来的位置 + 旧数组长度。

看下面的例子就明白了。其中 n 为 table 的默认长度 16,图(a)表示扩容前的 key1 和 key2 两个 key 确定索引位置的示例;图(b)表示扩容后 key1 和 key2 两种 key 确定索引位置的示例,其中 hash1 和 hash2 分是 key1 与 key2 对应的哈希与高位运算结果。

hashMap 1.8 哈希算法例图1.png

因为 n 变为了原来的 2 倍,所以 n - 1 会比原来多一个最高位的 1.所以 index 才会发生这样的变化。

hash 原数组大小 原下标 新数组大小 新下标
0 0101 1111 0 0101 1 1111 0 0101 = 5
1 0101 1111 0 0101 1 1111 1 0101 = 21 = 16 + 5

所以,我们在复制数组元素确定索引位置时不需要重新计算 hash 值。只需要看元素 e.hash & oldCap 的值是 0 还是 1 即可。如果是 0 则原位置不动,如果是 1 则新位置 = 原位置 + oldCap。这个设计真的很赞,因为e.hash & oldCap的值为 0 或 1可以认为是随机的,因此在扩容过程中,均匀的把之前有冲突的节点分散到新的位置。并且顺序不会颠倒。也就是说扩容前如果元素 A 和元素 B 均在下标为 10 的位置,A 比 B 靠前。扩容后如果两元素的下标没有变化,那么 A 还是会比 B 靠前。 「据说 JDK1.7 会颠倒原来的顺序,我没有验证」

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) { // 哈希桶不为空,扩容时走这个分支。分支 A
        if (oldCap >= MAXIMUM_CAPACITY) { // 容量超过最大值,无法扩容,扩大阈值
            threshold = Integer.MAX_VALUE;
            return oldTab;
        }
        // 新的哈希桶扩容至原来的 2 倍,阈值也扩容至原来的 2 倍
        else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
                 oldCap >= DEFAULT_INITIAL_CAPACITY) 
            newThr = oldThr << 1; // double threshold
    }
    else if (oldThr > 0) // 调用非空构造函数时走这个分支。分支 B
        newCap = oldThr;
    else { // oldCap == oldThr == 0
           // 调用空的构造函数时走这个分支,使用默认大小和阈值初始化哈希桶。分支 C
        newCap = DEFAULT_INITIAL_CAPACITY;
        newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
    }
    // 只有走分支 B 的时候 newThr 才为零。
    // 因为调用非空构造函数时直接把容量大小赋值给了阈值,所以这里要计算新的阈值。
    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) {
        // 把每个 node 移动到新的数组中去
        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 {
                    /**
                    * loHead 指向新的 hash 在原位置的头节点
                    * loTail 指向新的 hash 在原位置的尾节点
                    * hiHead 指向新的 hash 在原位置 + oldCap 位置的头节点
                    * hiTail 指向新的 hash 在原位置 + oldCap 位置的尾节点
                    */
                    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;
                        }
                        // 原位置 + oldCap
                        else {
                            if (hiTail == null)
                                hiHead = e;
                            else
                                hiTail.next = e;
                            hiTail = e;
                        }
                    } while ((e = next) != null);
                    // 新的 hash 在原位置的头节点放入哈希桶
                    if (loTail != null) {
                        loTail.next = null;
                        newTab[j] = loHead;
                    }
                    // 新的 hash 在原位置 + oldCap 位置的头节点放入哈希桶
                    if (hiTail != null) {
                        hiTail.next = null;
                        newTab[j + oldCap] = hiHead;
                    }
                }
            }
        }
    }
    return newTab;
}

安全性

HashMap 的设计是简洁高效,但没有任何措施保证在 put 和 remove 过程中的线程安全。
先来看看 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 {
        ......

假设现在哈希桶数组为空。

  1. 线程 A 开始执行 put 操作。这时候 table == null 为真,执行扩容操作。之后挂起了。
  2. 线程 B 开始执行,发现不需要扩容,跳过。计算索引值,假如得到的索引为 6,之后挂起了。
  3. 线程 A 开始执行,计算 hash 对应的索引,刚好也为 6。此时因为线程 B 还没有执行赋值操作,所以该位置还是为空的,于是线程 A 把 "a" 放在了下标为 6 的位置。之后刮起了。
  4. 线程 B 开始执行,把 "b" 也放在了下标为 6 的位置。

所以线程 B 的写入操作覆盖了线程 A 的写入操作,导致线程 A 的写入操作数据丢失。

另外,在 JDK1.7 的版本中,在多线程下使用 HashMap 有可能造成环形链表。具体请参考美团点评技术团队的博客:Java 8系列之重新认识 HashMap。但这个 bug 在 JDK 1.8 的版本中改进了。因为在 JDK1.7 中采取的是头插法,遍历一个节点就插入一个节点到新的哈希桶数组,所以才会导致出现循环链表。但 JDK1.8 中是采用两个头结点来保持旧链表的引用,直到该索引处对应的链表全部遍历完之后再分别把头结点放在新的哈希桶数组对应的位置。而不是遍历一个节点就插入一个节点到新的哈希桶数组。所以不会出现死链。

总结:

写的很赞的地方

参考链接:Java 8系列之重新认识 HashMap

之前对 HashMap 的理解仅限于知道怎么用,大概知道里面的实现原理,但源码读起来才知道这个写的太赞了。从读源码,到理解,然后写出来,前前后后大概花了四个晚上的时间,如有不对之处还请大家指教。

上一篇下一篇

猜你喜欢

热点阅读