重寫equals同時(shí)為什么要重寫hashCode?

重寫equals不一定要重寫hashCode,得看情況。如果在沒使用容器時(shí)其實(shí)是沒必要的。
如果使用了HashMap等容器,并且使用了自定義對象作為Key是一定要重寫的。
重寫equals是為了在業(yè)務(wù)邏輯上判斷實(shí)例之間是否相等。重寫hascode是為了讓集合快速判重。
hashCode()與 equals() 的規(guī)定:
如果兩個(gè)對象相等,則 hashcode 一定也是相同的
兩個(gè)對象相等,對兩個(gè) equals() 方法返回 true
兩個(gè)對象有相同的 hashcode 值,它們也不一定是相等
綜上,equals() 方法被覆蓋過,則 hashCode() 方法也必須被覆蓋
hashCode() 的默認(rèn)行為是對堆上的對象產(chǎn)生獨(dú)特值。如果沒有重寫 hashCode(),則該 class 的兩個(gè)對象無論如何都不會(huì)相等(即使這兩個(gè)對象指向相同的數(shù)據(jù))
下面舉個(gè)例子說明一定要重寫。
當(dāng)使用自定義類作為HashMap的Key時(shí)put時(shí)
如果只重寫equals不重寫hashCode會(huì)出現(xiàn)邏輯錯(cuò)誤
先看下面的代碼:
public class Test {
static class Order {
private Long orderId;
public Order(Long orderId) {
this.orderId = orderId;
}
public Long getOrderId() {
return orderId;
}
public void setOrderId(Long orderId) {
this.orderId = orderId;
}
@Override
public boolean equals(Object obj) {
if (obj != null && !(obj instanceof Order)) {
return false;
}
return Objects.equals(this.orderId, ((Order) obj).orderId);
}
@Override
public String toString() {
return "Order{" +
"orderId=" + orderId +
'}';
}
}
public static void main(String[] args) {
Map map = new HashMap<>();
Order order1 = new Order(1000000001L);
Order order2 = new Order(1000000001L);
map.put(order1, "");
map.put(order2, "");
System.out.println(map);
}
} 運(yùn)行輸出:
{Order{orderId=1000000001}=, Order{orderId=1000000001}=}
在代碼中重寫了equals方法,沒重寫hashCode方法。
equals重寫的邏輯是:只要orderId相等那么這這兩個(gè)對象就相等。
而從運(yùn)行結(jié)果來看,兩個(gè)orderId一致的對象卻都成功put到了map中。這就是邏輯錯(cuò)誤了,因?yàn)榘凑者壿媮碚f期望的結(jié)果應(yīng)該只有一個(gè)Order在map中才對。
我們來看下HashMap的源碼,只需要看寫了注釋的那個(gè)判斷
public V put(K key, V value) {
return putVal(hash(key), key, value, false, true);
}
static final int hash(Object key) {
int h;
return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
}
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;
// 通過hash算出索引 通過索引取值==null的話 直接直接插入到索引位置。
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) // -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;
} 通過源碼我們知道,只要hash碼不一樣的話就可以直接插入到數(shù)組中。然而正因?yàn)槲覀儧]重寫hashCode方法,所以調(diào)用的是Object的hashCode方法。而Object的hashCode是使用對象在堆中的地址通過算法得出一個(gè)int類型的值,既然如此,那剛剛創(chuàng)建的兩個(gè)對象的int類型的值肯定是不同的,所以兩個(gè)Order都可以正常插入到數(shù)組中,從而出現(xiàn)了邏輯錯(cuò)誤。
重寫hashCode方法:
public class TestHash {
static class Order {
private Long orderId;
public Order(Long orderId) {
this.orderId = orderId;
}
public Long getOrderId() {
return orderId;
}
public void setOrderId(Long orderId) {
this.orderId = orderId;
}
@Override
public boolean equals(Object obj) {
if (obj != null && !(obj instanceof Order)) {
return false;
}
return Objects.equals(this.orderId, ((Order) obj).orderId);
}
@Override
public int hashCode() {
// 這里簡單重寫下 實(shí)際開發(fā)根據(jù)自己需求重寫即可。
return this.orderId.intValue() >> 2;
}
@Override
public String toString() {
return "Order{" +
"orderId=" + orderId +
'}';
}
}
public static void main(String[] args) {
Map map = new HashMap<>();
Order order1 = new Order(1000000001L);
Order order2 = new Order(1000000001L);
map.put(order1, "");
map.put(order2, "");
System.out.println(map);
}
} 再次運(yùn)行輸出:
{Order{orderId=1000000001}=}
我們簡單看下源碼(為了好理解,我只截取了重點(diǎn)代碼):以put order2作為注釋講解。
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;
// 重寫hashCode之后兩個(gè)對象的orderId相同,hashCode也肯定相同。
// 通過hash算出索引 通過索引取值 有值不進(jìn)入if。
if ((p = tab[i = (n - 1) & hash]) == null)
tab[i] = newNode(hash, key, value, null);
else {
Node e; K k;
// 由于重寫了hashCode 舊對象的hashCode和新的肯定相等
if (p.hash == hash &&
// (k = p.key) == key == false 因?yàn)楸容^的是對象地址
// (key != null && key.equals(k)) == true 因?yàn)橹貙懥薳quals orderId相等則相等
((k = p.key) == key || (key != null && key.equals(k))))
// 保存舊Node
e = p;
.......
if (e != null) { // existing mapping for key
V oldValue = e.value;
if (!onlyIfAbsent || oldValue == null)
// value覆蓋舊Node的值
e.value = value;
afterNodeAccess(e);
return oldValue;
}
}
........
} 所以order2覆蓋了order1。這就是為什么當(dāng)使用自定義對象作為HashMap的Key時(shí)如果重寫了equals要同時(shí)hashCode。
反過來說:重寫了hashCode,equals需要重寫嗎?
答案是要的,都要重寫!
還是以上面代碼重寫的邏輯為例,假設(shè)hashCode相同的兩個(gè)對象,且已經(jīng)put order1在put時(shí),hash相同,得出的索引也是相同,就可以取到order1,取到之后會(huì)繼續(xù)使用equals比較,假設(shè)沒有重寫的話,那么就是對象地址比較,結(jié)果肯定是false,那么這個(gè)時(shí)候就發(fā)生了hash碰撞,也就形成了鏈表。
還有在map.get(key)時(shí)也是一樣都會(huì)根據(jù)hashCode找,再判斷equals。
為什么要判斷equals呢?因?yàn)楦鶕?jù)hashCode找到的是一個(gè)鏈表,需要根據(jù)equals在鏈表中找到Key相等的那個(gè)值。
什么場景會(huì)用到自定義類做key?
最常見的key是一個(gè)坐標(biāo),比如說在地圖的某個(gè)坐標(biāo)放置一個(gè)物體之類的。
public class Test {
static class Coordinate {
public Coordinate(int x, int y) {
this.x = x;
this.y = y;
}
private int x;
private int y;
public int getX() {
return x;
}
public void setX(int x) {
this.x = x;
}
public int getY() {
return y;
}
public void setY(int y) {
this.y = y;
}
}
public static void main(String[] args) {
Map map = new HashMap<>();
map.put(new Coordinate(22, 99), "手機(jī)");
map.put(new Coordinate(44, 48), "電腦");
}
} - 完 -
