HashMap源码解析

太过爱你忘了你带给我的痛 2022-04-05 10:13 566阅读 0赞

以下针对JDK 1.8版本中的HashMap进行分析。

概述

哈希表基于Map接口的实现。此实现提供了所有可选的映射操作,并且允许键为null,值也为null。HashMap 除了不支持同步操作以及支持null的键值外,其功能大致等同于 Hashtable。这个类不保证元素的顺序,并且也不保证随着时间的推移,元素的顺序不会改变。

假设散列函数使得元素在哈希桶中分布均匀,那么这个实现对于 putget 等操作提供了常数时间的性能。

对于一个 HashMap 的实例,有两个因子影响着其性能:初始容量负载因子。容量就是哈希表中哈希桶的个数,初始容量就是哈希表被初次创建时的容量大小。负载因子是在进行自动扩容之前衡量哈希表存储键值对的一个指标。当哈希表中的键值对超过capacity * loadfactor时,就会进行 resize 的操作。

作为一般规则,默认负载因子(0.75)在时间和空间成本之间提供了良好的折衷。负载因子越大,空间开销越小,但是查找的开销变大了。

注意,迭代器的快速失败行为不能得到保证,一般来说,存在非同步的并发修改时,不可能作出任何坚决的保证。快速失败迭代器尽最大努力抛出ConcurrentModificationException异常。因此,编写依赖于此异常的程序的做法是错误的,正确做法是:迭代器的快速失败行为应该仅用于检测程序错误。

源码分析

主要字段

  1. /**
  2. * 初始容量大小 —— 必须是2的幂次方
  3. */
  4. static final int DEFAULT_INITIAL_CAPACITY = 1 << 4; // aka 16
  5. /**
  6. * 最大容量
  7. */
  8. static final int MAXIMUM_CAPACITY = 1 << 30;
  9. /**
  10. * 默认负载因子
  11. */
  12. static final float DEFAULT_LOAD_FACTOR = 0.75f;
  13. /**
  14. * 当链表长度超过这个值时转换为红黑树
  15. */
  16. static final int TREEIFY_THRESHOLD = 8;
  17. /**
  18. * 树形阈值,当小于这个值时,红黑树转换为链表
  19. */
  20. static final int UNTREEIFY_THRESHOLD = 6;
  21. /**
  22. * The smallest table capacity for which bins may be treeified.
  23. * (Otherwise the table is resized if too many nodes in a bin.)
  24. * Should be at least 4 * TREEIFY_THRESHOLD to avoid conflicts
  25. * between resizing and treeification thresholds.
  26. */
  27. static final int MIN_TREEIFY_CAPACITY = 64;
  28. /**
  29. * table 在第一次使用时进行初始化并在需要的时候重新调整自身大小。对于 table 的大小必须是2的幂次方。
  30. */
  31. transient Node<K,V>[] table;
  32. /**
  33. * Holds cached entrySet(). Note that AbstractMap fields are used
  34. * for keySet() and values().
  35. */
  36. transient Set<Map.Entry<K,V>> entrySet;
  37. /**
  38. * 键值对的个数
  39. */
  40. transient int size;
  41. /**
  42. * HashMap 进行结构性调整的次数。结构性调整指的是增加或者删除键值对等操作,注意对于更新某个键的值不是结构特性调整。
  43. */
  44. transient int modCount;
  45. /**
  46. * 所能容纳的 key-value 对的极限(表的大小 capacity * load factor),达到这个容量时进行扩容操作。
  47. */
  48. int threshold;
  49. /**
  50. * 负载因子,默认值为 0.75
  51. */
  52. final float loadFactor;
  53. 复制代码

从上面我们可以得知,HashMap中指定的哈希桶数组table.length必须是2的幂次方,这与常规性的把哈希桶数组设计为素数不一样。指定为2的幂次方主要是在两方面做优化:

  • 扩容:扩容的时候,哈希桶扩大为当前的两倍,因此只需要进行左移操作
  • 取模:由于哈希桶的个数为2的幂次,因此可以用**&**操作来替代耗时的模运算, n % table.length -> n & (table.length - 1)

哈希函数

  1. /**
  2. * 哈希函数
  3. */
  4. static final int hash(Object key) {
  5. int h;
  6. return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
  7. }
  8. 复制代码

key 的哈希值通过它自身hashCode的高十六位与低十六位进行亦或得到。这么做得原因是因为,由于哈希表的大小固定为 2 的幂次方,那么某个 key 的 hashCode 值大于 table.length,其高位就不会参与到 hash 的计算(对于某个 key 其所在的桶的位置的计算为 hash & (table.length - 1))。因此通过hashCode()的高16位异或低16位实现的:(h = key.hashCode()) ^ (h >>> 16),主要是从速度、功效、质量来考虑的,保证了高位 Bits 也能参与到 Hash 的计算。

tableSizeFor函数

  1. /**
  2. * 返回大于等于capacity的最小2的整数次幂
  3. */
  4. static final int tableSizeFor(int cap) {
  5. int n = cap - 1;
  6. n |= n >>> 1;
  7. n |= n >>> 2;
  8. n |= n >>> 4;
  9. n |= n >>> 8;
  10. n |= n >>> 16;
  11. return (n < 0) ? 1 : (n >= MAXIMUM_CAPACITY) ? MAXIMUM_CAPACITY : n + 1;
  12. }
  13. 复制代码

根据注释可以知道,这个函数返回大于或等于cap的最小二的整数次幂的值。比如对于3,返回4;对于10,返回16。详解如下: 假设对于n(32位数)其二进制为 01xx…xx, n >>> 1,进行无符号右移一位, 001xx..xx,位或得 011xx..xx n >>> 2,进行无符号右移两位, 00011xx..xx,位或得 01111xx..xx 依此类推,无符号右移四位再进行位或将得到8个1,无符号右移八位再进行位或将得到16个1,无符号右移十六位再进行位或将得到32个1。根据这个我们可以知道进行这么多次无符号右移及位或操作,那么可让数n的二进制位最高位为1的后面的二进制位全部变成1。此时进行 +1 操作,即可得到最小二的整数次幂的值。(《高效程序的奥秘》第3章——2的幂界方 有对此进行进一步讨论,可自行查看) 回到上面的程序,之所以在开头先进行一次 -1 操作,是为了防止传入的cap本身就是二的幂次方,此时得到的就是下一个二的幂次方了,比如传入4,那么在不进行 -1 的情况下,将得到8。

构造函数

  1. /**
  2. * 传入指定的初始容量和负载因子
  3. */
  4. public HashMap(int initialCapacity, float loadFactor) {
  5. if (initialCapacity < 0)
  6. throw new IllegalArgumentException("Illegal initial capacity: " +
  7. initialCapacity);
  8. if (initialCapacity > MAXIMUM_CAPACITY)
  9. initialCapacity = MAXIMUM_CAPACITY;
  10. if (loadFactor <= 0 || Float.isNaN(loadFactor))
  11. throw new IllegalArgumentException("Illegal load factor: " +
  12. loadFactor);
  13. this.loadFactor = loadFactor;
  14. //返回2的幂次方
  15. this.threshold = tableSizeFor(initialCapacity);
  16. }
  17. 复制代码

对于上面的构造器,我们需要注意的是this.threshold = tableSizeFor(initialCapacity);这边的 threshold 为 2的幂次方,而不是capacity * load factor,当然此处并非是错误,因为此时 table 并没有真正的被初始化,初始化动作被延迟到了putVal()当中,所以 threshold 会被重新计算。

  1. /**
  2. * 根据指定的容量以及默认负载因子(0.75)初始化一个空的 HashMap 实例
  3. *
  4. * 如果 initCapacity是负数,那么将抛出 IllegalArgumentException
  5. */
  6. public HashMap(int initialCapacity) {
  7. this(initialCapacity, DEFAULT_LOAD_FACTOR);
  8. }
  9. /**
  10. * 根据默认的容量和负载因子初始化一个空的 HashMap 实例
  11. */
  12. public HashMap() {
  13. this.loadFactor = DEFAULT_LOAD_FACTOR; // all other fields defaulted
  14. }
  15. /**
  16. * Constructs a new <tt>HashMap</tt> with the same mappings as the
  17. * specified <tt>Map</tt>. The <tt>HashMap</tt> is created with
  18. * default load factor (0.75) and an initial capacity sufficient to
  19. * hold the mappings in the specified <tt>Map</tt>.
  20. *
  21. * @param m the map whose mappings are to be placed in this map
  22. * @throws NullPointerException if the specified map is null
  23. */
  24. public HashMap(Map<? extends K, ? extends V> m) {
  25. this.loadFactor = DEFAULT_LOAD_FACTOR;
  26. putMapEntries(m, false);
  27. }
  28. 复制代码

查询

  1. /**
  2. * 返回指定 key 所对应的 value 值,当不存在指定的 key 时,返回 null。
  3. *
  4. * 当返回 null 的时候并不表明哈希表中不存在这种关系的映射,有可能对于指定的 key,其对应的值就是 null。
  5. * 因此可以通过 containsKey 来区分这两种情况。
  6. */
  7. public V get(Object key) {
  8. Node<K,V> e;
  9. return (e = getNode(hash(key), key)) == null ? null : e.value;
  10. }
  11. /**
  12. * 1.首先通过 key 的哈希值找到其所在的哈希桶
  13. * 2.对于 key 所在的哈希桶只有一个元素,此时就是 key 对应的节点,
  14. * 3.对于 key 所在的哈希桶超过一个节点,此时分两种情况:
  15. * 如果这是一个 TreeNode,表明通过红黑树存储,在红黑树中查找
  16. * 如果不是一个 TreeNode,表明通过链表存储(链地址法),在链表中查找
  17. * 4.查找不到相应的 key,返回 null
  18. */
  19. final Node<K,V> getNode(int hash, Object key) {
  20. Node<K,V>[] tab; Node<K,V> first, e; int n; K k;
  21. if ((tab = table) != null && (n = tab.length) > 0 &&
  22. (first = tab[(n - 1) & hash]) != null) {
  23. if (first.hash == hash && // always check first node
  24. ((k = first.key) == key || (key != null && key.equals(k))))
  25. return first;
  26. if ((e = first.next) != null) {
  27. if (first instanceof TreeNode)
  28. return ((TreeNode<K,V>)first).getTreeNode(hash, key);
  29. do {
  30. if (e.hash == hash &&
  31. ((k = e.key) == key || (key != null && key.equals(k))))
  32. return e;
  33. } while ((e = e.next) != null);
  34. }
  35. }
  36. return null;
  37. }
  38. 复制代码

存储

  1. /**
  2. * 在映射中,将指定的键与指定的值相关联。如果映射关系之前已经有指定的键,那么旧值就会被替换
  3. */
  4. public V put(K key, V value) {
  5. return putVal(hash(key), key, value, false, true);
  6. }
  7. /**
  8. * * @param onlyIfAbsent if true, don't change existing value
  9. *
  10. * 1.判断哈希表 table 是否为空,是的话进行扩容操作
  11. * 2.根据键 key 计算得到的 哈希桶数组索引,如果 table[i] 为空,那么直接新建节点
  12. * 3.判断 table[i] 的首个元素是否等于 key,如果是的话就更新旧的 value 值
  13. * 4.判断 table[i] 是否为 TreeNode,是的话即为红黑树,直接在树中进行插入
  14. * 5.遍历 table[i],遍历过程发现 key 已经存在,更新旧的 value 值,否则进行插入操作,插入后发现链表长度大于8,则将链表转换为红黑树
  15. */
  16. final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
  17. boolean evict) {
  18. Node<K,V>[] tab; Node<K,V> p; int n, i;
  19. //哈希表 table 为空,进行扩容操作
  20. if ((tab = table) == null || (n = tab.length) == 0)
  21. n = (tab = resize()).length;
  22. // tab[i] 为空,直接新建节点
  23. if ((p = tab[i = (n - 1) & hash]) == null)
  24. tab[i] = newNode(hash, key, value, null);
  25. else {
  26. Node<K,V> e; K k;
  27. //tab[i] 首个元素即为 key,更新旧值
  28. if (p.hash == hash &&
  29. ((k = p.key) == key || (key != null && key.equals(k))))
  30. e = p;
  31. //当前节点为 TreeNode,在红黑树中进行插入
  32. else if (p instanceof TreeNode)
  33. e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
  34. else {
  35. //遍历 tab[i],key 已经存在,更新旧的 value 值,否则进心插入操作,插入后链表长度大于8,将链表转换为红黑树
  36. for (int binCount = 0; ; ++binCount) {
  37. if ((e = p.next) == null) {
  38. p.next = newNode(hash, key, value, null);
  39. //链表长度大于8
  40. if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
  41. treeifyBin(tab, hash);
  42. break;
  43. }
  44. // key 已经存在
  45. if (e.hash == hash &&
  46. ((k = e.key) == key || (key != null && key.equals(k))))
  47. break;
  48. p = e;
  49. }
  50. }
  51. //key 已经存在,更新旧值
  52. if (e != null) { // existing mapping for key
  53. V oldValue = e.value;
  54. if (!onlyIfAbsent || oldValue == null)
  55. e.value = value;
  56. afterNodeAccess(e);
  57. return oldValue;
  58. }
  59. }
  60. //HashMap插入元素表明进行了结构性调整
  61. ++modCount;
  62. //实际键值对数量超过 threshold,进行扩容操作
  63. if (++size > threshold)
  64. resize();
  65. afterNodeInsertion(evict);
  66. return null;
  67. }
  68. 复制代码

扩容

  1. /**
  2. * 初始化或者对哈希表进行扩容操作。如果当前哈希表为空,则根据字段阈值中的初始容量进行分配。
  3. * 否则,因为我们扩容两倍,那么对于桶中的元素要么在原位置,要么在原位置再移动2次幂的位置。
  4. */
  5. final Node<K,V>[] resize() {
  6. Node<K,V>[] oldTab = table;
  7. int oldCap = (oldTab == null) ? 0 : oldTab.length;
  8. int oldThr = threshold;
  9. int newCap, newThr = 0;
  10. if (oldCap > 0) {
  11. //超过最大容量,不再进行扩容
  12. if (oldCap >= MAXIMUM_CAPACITY) {
  13. threshold = Integer.MAX_VALUE;
  14. return oldTab;
  15. }
  16. //容量没有超过最大值,容量变为原来两倍
  17. else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
  18. oldCap >= DEFAULT_INITIAL_CAPACITY)
  19. //阈值变为原来两倍
  20. newThr = oldThr << 1; // double threshold
  21. }
  22. else if (oldThr > 0) // initial capacity was placed in threshold
  23. //调用了HashMap的带参构造器,初始容量用threshold替换,
  24. //在带参构造器中,threshold的值为 tableSizeFor() 的返回值,也就是2的幂次方,而不是 capacity * load factor
  25. newCap = oldThr;
  26. else { // zero initial threshold signifies using defaults
  27. //初次初始化,容量和阈值使用默认值
  28. newCap = DEFAULT_INITIAL_CAPACITY;
  29. newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
  30. }
  31. if (newThr == 0) {
  32. //计算新的阈值
  33. float ft = (float)newCap * loadFactor;
  34. newThr = (newCap < MAXIMUM_CAPACITY && ft < (float)MAXIMUM_CAPACITY ?
  35. (int)ft : Integer.MAX_VALUE);
  36. }
  37. threshold = newThr;
  38. @SuppressWarnings({"rawtypes","unchecked"})
  39. //以下为扩容过程的重点
  40. Node<K,V>[] newTab = (Node<K,V>[])new Node[newCap];
  41. table = newTab;
  42. if (oldTab != null) {
  43. for (int j = 0; j < oldCap; ++j) {
  44. Node<K,V> e;
  45. if ((e = oldTab[j]) != null) {
  46. //将原哈希桶置空,以便GC
  47. oldTab[j] = null;
  48. //当前节点不是以链表形式存在,直接计算其应放置的新位置
  49. if (e.next == null)
  50. newTab[e.hash & (newCap - 1)] = e;
  51. //当前节点是TreeNode
  52. else if (e instanceof TreeNode)
  53. ((TreeNode<K,V>)e).split(this, newTab, j, oldCap);
  54. else { // preserve order
  55. //节点以链表形式存储
  56. Node<K,V> loHead = null, loTail = null;
  57. Node<K,V> hiHead = null, hiTail = null;
  58. Node<K,V> next;
  59. do {
  60. next = e.next;
  61. //原索引
  62. if ((e.hash & oldCap) == 0) {
  63. if (loTail == null)
  64. loHead = e;
  65. else
  66. loTail.next = e;
  67. loTail = e;
  68. }
  69. //原索引 + oldCap
  70. else {
  71. if (hiTail == null)
  72. hiHead = e;
  73. else
  74. hiTail.next = e;
  75. hiTail = e;
  76. }
  77. } while ((e = next) != null);
  78. if (loTail != null) {
  79. loTail.next = null;
  80. newTab[j] = loHead;
  81. }
  82. if (hiTail != null) {
  83. hiTail.next = null;
  84. newTab[j + oldCap] = hiHead;
  85. }
  86. }
  87. }
  88. }
  89. }
  90. return newTab;
  91. }
  92. 复制代码

因为哈希表使用2次幂的拓展(指长度拓展为原来的2倍),所以在扩容的时候,元素的位置要么在原位置,要么在原位置再移动2次幂的位置。为什么是这么一个规律呢?我们假设 n 为 table 的长度,图(a)表示扩容前的key1和key2两种key确定索引位置的示例,图(b)表示扩容后key1和key2两种key确定索引位置的示例,其中hash1是key1对应的哈希与高位运算结果。

1

元素在重新计算hash之后,因为n变为2倍,那么n-1的mask范围在高位多1bit(红色),因此新的index就会发生这样的变化:

1 1

因此,我们在扩容的时候,只需要看看原来的hash值新增的那个 bit 是1还是0就好了,是0的话索引没变,是1的话索引变成“原索引+oldCap”,可以看看下图为16扩充为32的resize示意图:

1 2

删除

  1. /**
  2. * 删除指定的 key 的映射关系
  3. */
  4. public V remove(Object key) {
  5. Node<K,V> e;
  6. return (e = removeNode(hash(key), key, null, false, true)) == null ?
  7. null : e.value;
  8. }
  9. /**Java
  10. *
  11. * 1.根据 key 的哈希值在哈希桶中查找是否存在这个包含有这个 key 的节点
  12. * 链表头节点是要查找的节点
  13. * 节点是TreeNode,在红黑树中查找
  14. * 在链表中进行查找
  15. * 2.如果查找到对应的节点,进行删除操作
  16. * 从红黑树中删除
  17. * 将链表头节点删除
  18. * 在链表中删除
  19. *
  20. * @param hash key 的 hash 值
  21. * @param key 指定的 key
  22. * @param value 当 matchhValue 为真时,则要匹配这个 value
  23. * @param matchValue 为真并且与 value 相等时进行删除
  24. * @param movable if false do not move other nodes while removing
  25. * @return the node, or null if none
  26. */
  27. final Node<K,V> removeNode(int hash, Object key, Object value,
  28. boolean matchValue, boolean movable) {
  29. Node<K,V>[] tab; Node<K,V> p; int n, index;
  30. if ((tab = table) != null && (n = tab.length) > 0 &&
  31. (p = tab[index = (n - 1) & hash]) != null) {
  32. Node<K,V> node = null, e; K k; V v;
  33. //链表头即为要删除的节点
  34. if (p.hash == hash &&
  35. ((k = p.key) == key || (key != null && key.equals(k))))
  36. node = p;
  37. else if ((e = p.next) != null) {
  38. //节点为TreeNode,在红黑树中查找是否存在指定的key
  39. if (p instanceof TreeNode)
  40. node = ((TreeNode<K,V>)p).getTreeNode(hash, key);
  41. else {
  42. //在链表中查找是否存在指定的key
  43. do {
  44. if (e.hash == hash &&
  45. ((k = e.key) == key ||
  46. (key != null && key.equals(k)))) {
  47. node = e;
  48. break;
  49. }
  50. p = e;
  51. } while ((e = e.next) != null);
  52. }
  53. }
  54. if (node != null && (!matchValue || (v = node.value) == value ||
  55. (value != null && value.equals(v)))) {
  56. //从红黑树中删除
  57. if (node instanceof TreeNode)
  58. ((TreeNode<K,V>)node).removeTreeNode(this, tab, movable);
  59. //链表头删除
  60. else if (node == p)
  61. tab[index] = node.next;
  62. //链表中的元素删除
  63. else
  64. p.next = node.next;
  65. //进行结构特性调整
  66. ++modCount;
  67. --size;
  68. afterNodeRemoval(node);
  69. return node;
  70. }
  71. }
  72. return null;
  73. }
  74. /**
  75. * 删除所有的映射关系
  76. */
  77. public void clear() {
  78. Node<K,V>[] tab;
  79. modCount++;
  80. if ((tab = table) != null && size > 0) {
  81. size = 0;
  82. for (int i = 0; i < tab.length; ++i)
  83. //置 null 以便 GC
  84. tab[i] = null;
  85. }
  86. }
  87. 复制代码

问题

  • 对于new HashMap(18),那么哈希桶数组的大小是多少
  • HashMap 要求哈希桶数组的长度是2的幂次方,这么设计的目的是为什么
  • HashMap 何时对哈希桶数组开辟内存
  • 哈希函数是如何设计的,这么设计的意图是什么
  • HashMap 扩容的过程,扩容时候对 rehash 进行了什么优化

我有一个微信公众号,经常会分享一些Java技术相关的干货;如果你喜欢我的分享,可以用微信搜索“Java团长”或者“javatuanzhang”关注。

发表评论

表情:
评论列表 (有 0 条评论,566人围观)

还没有评论,来说两句吧...

相关阅读

    相关 HashMap

    一.HashMap概述 基于哈希表的 Map 接口的实现。此实现提供所有可选的映射操作, 并允许使用 null 值和 null 键。此类不保证映射的顺序,特别是它

    相关 HashMap

    来不及整理电子版,先献丑把笔记本拍几张,随后整理。 有人问,什么年代了,还手写笔记,哈哈,如果不亲自手写一遍,我是真心记不住。很多API不用知道工作原理 一样可以使用,所以

    相关 HashMap

    埋坑 这个必须写 1,hash方法 问:为何扩容是翻倍(乘以2) 2,get方法 3,put方法 问:为什么hash值冲突后,list变为红黑树的节点是8

    相关 HashMap

    源码博客相关博客写了那么多,突然想起来都没有写一篇我们日常开发中最常见的HashMap,今天简单补一下! HashMap简介: `HashMap` 是应用更加广泛的哈希

    相关 hashMap

    源码来自jdk:1.8,和其他jdk版本可能有少许差异。 一.hashMap的实现原理     hashMap底层是一个有Node组成的数组,每个Node都有一个key

    相关 HashMap

    本文的所有图片以及源码解析内容都来自于微信公众号<java知音>,原文作者:阿进的写字台。此处仅是对该公众号分享的内容进行一下消化吸收,不作传播。想要阅读原文,可以关注这个公众