本文通过一个程序员小明遇到的实际问题,深入探讨了在使用 HashMap 时由于键对象的可变性导致的数据访问异常。
如果你只想看结论,给你上个一句话省流版:
一天程序员小明跑到师兄面前说 :“师兄,我看到一个很诡异的现象,百思不得其解”。
师兄说:“莫慌,你且慢慢说来”
程序员小明说道:“我放到 Map 中的数据还在,但是怎么也取不出来了...”
师兄,于是帮小明看了他的代码,发现了很多不为人知的秘密....
小明 定义了一个 Player 作为 Map 的 key :
public class Player {
private String name;
public Player(String name) {
this.name = name;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (!(o instanceof Player)) {
return false;
}
Player player = (Player) o;
return name.equals(player.name);
}
@Override
public int hashCode() {
return name.hashCode();
}
}
Player 类在 name 属性上有一个 setter ,所以它是可变的。此外,hashCode() 方法使用 name 属性来计算哈希码。这意味着更改 Player 对象的名字可以使它具有不同的哈希码。
Map myMap = new HashMap<>();
Player kai = new Player("Kai");
Player tom = new Player("Tom");
Player amanda = new Player("Amanda");
myMap.put(kai, 42);
myMap.put(amanda, 88);
myMap.put(tom, 200);
assertTrue(myMap.containsKey(kai));
接下来,让小明将玩家 kai 的名字从 “Kai” 更改为 “Eric”,然后懵逼了....
kai.setName("Eric");
assertEquals("Eric", kai.getName());
Player eric = new Player("Eric");
assertEquals(eric, kai);
assertFalse(myMap.containsKey(kai));
assertFalse(myMap.containsKey(eric));
assertNull(myMap.get(kai));
assertNull(myMap.get(eric));
如上面的测试所示,更改 kai 的名字为 “Eric” 后,无法再使用 kai 或 eric 来检索 “Eric” -> 42 的 Entry。
但,对象 Player(“Eric”) 还存在于 map 中作为一个键:
long ericCount = myMap.keySet()
.stream()
.filter(player -> player.getName()
.equals("Eric"))
.count();
assertEquals(1, ericCount);
给你 2 分钟的时间,是否可以清楚地解释其中的缘由?如果不能,说明你对 HashMap 的了解还不够。
这部分内容可能略显枯燥,如果不喜欢可以跳过,看第四部分。
3.1.1 put 方法概述
public V put(K key, V value) {
return putVal(hash(key), key, value, false, true);
}
3.1.2 hash 方法
static final int hash(Object key) {
int h;
return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
}
该方法的主要目的是减少哈希碰撞和更好地分配哈希桶。高 16 位和低 16 位进行 XOR 操作,可以使得原本高 16位产生的影响,也能够反映到低 16 位中来。这是一种简单、快速但效果显著的方法来减少哈希碰撞。
该方法配合哈希表的“幂次掩码”(power-of-two masking)能够更好的分散哈希值,避免大量的哈希值冲突在一起,从而提高哈希表的性能。
3.1.3 putVal 方法
final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
boolean evict) {
Node[] tab; Node 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 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)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)
treeifyBin(tab, hash);
break;
}
if (e.hash == hash &&
((k = e.key) == key || (key != null && key.equals(k))))
break;
p = e;
}
}
if (e != null) {
V oldValue = e.value;
if (!onlyIfAbsent || oldValue == null)
e.value = value;
afterNodeAccess(e);
return oldValue;
}
}
++modCount;
if (++size > threshold)
resize();
afterNodeInsertion(evict);
return null;
}
putVal
方法是一个非常核心和复杂的方法,它处理了很多细节,包括初始化哈希表,确定正确的桶,处理链表和红黑树结构,以及正确的插入或更新节点的值。
3.2.1 containsKey 概览
既然是 containsKey 不符合预期,我们就看下它的逻辑:
java.util.HashMap#containsKey
public
boolean containsKey(Object key) {
return getNode(hash(key), key) != null;
}
3.2.2 hash 方法
3.2.3 getNode 方法
java.util.HashMap#getNode
final Node getNode(int hash, Object key) {
Node[] tab; Node first, e; int n; K k;
if ((tab = table) != null && (n = tab.length) > 0 &&(first = tab[(n - 1) & hash]) != null) {
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)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;
}
getNode
方法是
HashMap
中用于获取指定键对应的节点的核心方法。它首先使用哈希值来定位到正确的桶,然后在桶内使用链表或红黑树(如果桶中的元素过多时会转换为红黑树来提高性能)来查找正确的节点。
它充分利用了 Java 的多态特性和简洁的循环结构来保证代码的简洁和性能。
public V get(Object key) {
Node e;
return (e = getNode(hash(key), key)) == null ? null : e.value;
}
逻辑和
containsKey
一致,只是
getNode
之后,如果为
null
返回
null
, 否则返回
e.value
。
注:下面的作图可能并不严谨,只是帮助理解,如有偏差请勿较真。
Map myMap = new HashMap<>();
Player kai = new Player("Kai");
Player tom = new Player("Tom");
Player amanda = new Player("Amanda");
myMap.put(kai, 42);
myMap.put(tom, 200);
myMap.put(amanda, 88);
assertTrue(myMap.containsKey(kai));
其中绿色部分是键对象(注意是对象),红色部分是值。
有同学可能说,这里为为啥有个 Eric ? 这里是假设在 map 中放入一个 eric ,它的目标位置。
敲黑板:位置和 Key 对象的 hashCode 有关系和 Value 无关。
kai.setName("Eric");
assertEquals("Eric", kai.getName());
敲黑板:Map 并没有执行任何的写操作,因此虽然 kai 的 name 被修改为了 Eric ,但是 kai 的位置并没有发生变化。
Player eric = new Player("Eric");
assertEquals(eric, kai);
assertFalse(myMap.containsKey(kai));
assertFalse(myMap.containsKey(eric));
当执行
myMap.containsKey(kai)
时,会根据其 name 即 Eric 去判断是否有该 key 是否存在。
正如第一张图所示,此时真正的 Eric 的位置并没有元素,因此返回 false。
当执行
assertEquals(eric, kai);
时,由于重写了 equals 方法,name 相等即为相等,所以两者相等。
当执行
myMap.containsKey(eric)
时,和
myMap.containsKey(kai)
效果等价。
因此,永远不要修改 HashMap 中的键,避免出现一些奇奇怪怪的现象,奇怪的现象远不止前文所示。
-
哈希码更改
当你修改一个 HashMap 中的键时,该键的哈希码可能会更改,导致该键的哈希值不再与它当前所在的桶匹配。这将导致在使用该键进行查找时找不到相关的条目。