重寫了 equals ,還要重寫 hashCode ?這不僅僅是一道面試題,而且是關(guān)系到我們的代碼是否健壯和正確的問題。本篇文章,帶大家從底層來分析一下hashcode
方法重寫的意義以及如何實(shí)現(xiàn)。
回顧equals方法
我們先回顧一下 Object的equals方法 實(shí)現(xiàn),并簡單匯總一下使用equals
方法的規(guī)律。
public boolean equals(Object obj) {
return (this == obj);
}
通過上面Object
的源代碼,可以得出一個結(jié)論:如果一個類未重寫equals
方法,那么本質(zhì)上通過“==”和equals
方法比較的效果是一樣的,都是比較兩個對象的的內(nèi)存地址。
前面兩篇文章講到String
和Integer
在比較時的區(qū)別,關(guān)鍵點(diǎn)也是它們對equals
方法的實(shí)現(xiàn)。
面試時總結(jié)一下就是:默認(rèn)情況下,從Object
類繼承的equals
方法與“==”完全等價,比較的都是對象的內(nèi)存地址。但我們可以重寫equals
方法,使其按照需要進(jìn)行比較,如String
類重寫了equals
方法,比較的是字符的序列,而不再是內(nèi)存地址。
與hashCode方法的關(guān)系
那么equals
方法與hashCode
方法又有什么關(guān)系呢?我們來看Object上equals
方法的一段注釋。
Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.
大致意思是:當(dāng)重寫equals
方法后有必要將hashCode
方法也重寫,這樣做才能保證不違背hashCode
方法中“相同對象必須有相同哈希值”的約定。
此處只是提醒了我們重寫hashCode
方法的必要性,那其中提到的hashCode
方法設(shè)計(jì)約定又是什么呢?相關(guān)的內(nèi)容定義在hashCode
方法的注解部分。
hashCode方法約定
關(guān)于hashCode
方法的約定原文比較多,大家直接看源碼即可看到,這里匯總一下,共三條:
(1)如果對象在使用equals
方法中進(jìn)行比較的參數(shù)沒有修改,那么多次調(diào)用一個對象的hashCode()
方法返回的哈希值應(yīng)該是相同的。
(2)如果兩個對象通過equals
方法比較是相等的,那么要求這兩個對象的hashCode
方法返回的值也應(yīng)該是相等的。
(3)如果兩個對象通過equals
方法比較是不同的,那么也不要求這兩個對象的hashCode
方法返回的值是不相同的。但是我們應(yīng)該知道對于不同對象產(chǎn)生不同的哈希值對于哈希表(HashMap等)能夠提高性能。
其實(shí),看到這里我們了解了hashCode
的實(shí)現(xiàn)規(guī)約,但還是不清楚為什么實(shí)現(xiàn)equals
方法需要重寫hashCode
方法。但我們可以得出一條規(guī)律:hashCode
方法實(shí)際上必須要完成的一件事情就是,為equals
方法認(rèn)定為相同的對象返回相同的哈希值。
其實(shí)在上面規(guī)約中提到了哈希表,這也正是hashCode
方法運(yùn)用的場景之一,也是我們?yōu)槭裁匆貙懙暮诵摹?/p>
hashCode應(yīng)用場景
如果了解HashMap
的數(shù)據(jù)結(jié)構(gòu),就會知道它用到“鍵對象”的哈希碼,當(dāng)我們調(diào)用put
方法或者get
方法對Map
容器進(jìn)行操作時,都是根據(jù)鍵對象的哈希碼來計(jì)算存儲位置的。如果我們對哈希碼的獲取沒有相關(guān)保證,就可能會得不到預(yù)期的結(jié)果。
而對象的哈希碼的獲取正是通過hashCode
方法獲取的。如果自定義的類中沒有實(shí)現(xiàn)該方法,則會采用Object
中的hashCode()
方法。
在Object
中該方法是一個本地方法,會返回一個int
類型的哈希值??梢酝ㄟ^將對象的內(nèi)部地址轉(zhuǎn)換為整數(shù)來實(shí)現(xiàn)的,但是Java
中沒有強(qiáng)制要求通過該方式實(shí)現(xiàn)。
具體實(shí)現(xiàn)網(wǎng)絡(luò)上有不同的說法,有說通過內(nèi)置地址轉(zhuǎn)換得來,也有說“OpenJDK8默認(rèn)hashCode
的計(jì)算方法是通過和當(dāng)前線程有關(guān)的一個隨機(jī)數(shù)+三個確定值,運(yùn)用Marsaglia's xorshift scheme
隨機(jī)數(shù)算法得到的一個隨機(jī)數(shù)”獲得。
無論默認(rèn)實(shí)現(xiàn)是怎樣的,大多數(shù)情況下都無法滿足equals
方法相同,同時hashCode
結(jié)果也相同的條件。比如下面的示例重寫與否差距很大。
public void test1() {
String s = "ok";
StringBuilder sb = new StringBuilder(s);
System.out.println(s.hashCode() + " " + sb.hashCode());
String t = new String("ok");
StringBuilder tb = new StringBuilder(s);
System.out.println(t.hashCode() + " " + tb.hashCode());
}
上面這段代碼打印的結(jié)果為:
3548 1833638914
3548 1620303253
String
實(shí)現(xiàn)了hashCode
方法,而StringBuilder
并沒有實(shí)現(xiàn),這就導(dǎo)致即使值是一樣的,hashCode
也不同。
上個示例中問題還不太明顯,下面我們以HashMap
為例,看看如果沒有實(shí)現(xiàn)hashCode
方法會導(dǎo)致什么嚴(yán)重的后果。
@Test
public void test2() {
String hello = "hello";
Map<String, String> map1 = new HashMap<>();
String s1 = new String("key");
String s2 = new String("key");
map1.put(s1, hello);
System.out.println("s1.equals(s2):" + s1.equals(s2));
System.out.println("map1.get(s1):" + map1.get(s1));
System.out.println("map1.get(s2):" + map1.get(s2));
Map<Key, String> map2 = new HashMap<>();
Key k1 = new Key("A");
Key k2 = new Key("A");
map2.put(k1, hello);
System.out.println("k1.equals(k2):" + s1.equals(s2));
System.out.println("map2.get(k1):" + map2.get(k1));
System.out.println("map2.get(k2):" + map2.get(k2));
}
class Key {
private String k;
public Key(String key) {
this.k = key;
}
@Override
public boolean equals(Object obj) {
if (obj instanceof Key) {
Key key = (Key) obj;
return k.equals(key.k);
}
return false;
}
}
實(shí)例中定義了內(nèi)部類Key
,其中實(shí)現(xiàn)了equals
方法,但未實(shí)現(xiàn)hashCode
方法。存放于Map
中的value
值都是字符串“hello”。
代碼分兩段,第一段演示當(dāng)Map
的key
通過實(shí)現(xiàn)了hashCode
的String
時是什么效果;第二段演示了當(dāng)Map
的key
通過未實(shí)現(xiàn)hashCode
方法的Key
對象時是什么效果。
執(zhí)行上述代碼,打印結(jié)果如下:
s1.equals(s2):true
map1.get(s1):hello
map1.get(s2):hello
k1.equals(k2):true
map2.get(k1):hello
map2.get(k2):null
分析結(jié)果可以看出,對于String
作為key
的 s1 和 s2 來說,通過equals
比較相等是自然的,獲得的值也是相同的。但 k1 和 k2 通過equals
比較是相等,但為什么在Map
中獲得的結(jié)果卻不一樣?本質(zhì)上就是因?yàn)闆]有重寫hashCode
方法導(dǎo)致Map
在存儲和獲取過程中調(diào)用hashCode
方法獲得的值不一致。
此時在Key
類中添加hashCode
方法:
@Override
public int hashCode(){
return k.hashCode();
}
再次執(zhí)行,便可正常獲得對應(yīng)的值。
s1.equals(s2):true
map1.get(s1):hello
map1.get(s2):hello
k1.equals(k2):true
map2.get(k1):hello
map2.get(k2):hello
通過上面的典型實(shí)例演示了不重寫hashCode
方法的潛在后果。簡單看一下HashMap
中的put
方法。
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<K,V>[] tab; Node<K,V> p; int n, i;
if ((tab = table) == null || (n = tab.length) == 0)
n = (tab = resize()).length;
// 通過哈希值來查找底層數(shù)組位于該位置的元素p,如果p不為null,則使用新的鍵值對來覆蓋舊的鍵值對
if ((p = tab[i = (n - 1) & hash]) == null)
tab[i] = newNode(hash, key, value, null);
else {
Node<K,V> e; K k;
// (二者哈希值相等)且(二者地址值相等或調(diào)用equals認(rèn)定相等)。
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);
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;
}
}
// 如果底層數(shù)組中存在傳入的Key,那么使用新傳入的覆蓋掉查到的
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;
}
在上述方法中,put
方法在拿到key
的第一步就對key
對象調(diào)用了hashCode
方法。暫且不看后面的代碼,如果沒有重寫hashCode
方法,就無法確保key
的hash
值一致,后續(xù)操作就是兩個key
的操作了。
重寫hashCode方法
了解了重寫hashCode
方法的重要性,也了解了對應(yīng)的規(guī)約,那么下面我們就聊聊如何優(yōu)雅的重寫hashCode
方法。
首先,如果使用IDEA
的話,那么直接使用快捷鍵即可。
生成的效果如下:
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
Key key = (Key) o;
return Objects.equals(k, key.k);
}
@Override
public int hashCode() {
return Objects.hash(k);
}
根據(jù)需要可對生成的方法內(nèi)部實(shí)現(xiàn)進(jìn)行修改。在上面的實(shí)例中用到了java.util.Objects
類,它的hash
方法的優(yōu)點(diǎn)是如果參數(shù)為nul
l,就只返回 0 ,否則返回對象參數(shù)調(diào)用的hashCode
的結(jié)果。Objects.hash
方法源碼如下:
public static int hash(Object... values) {
return Arrays.hashCode(values);
}
其中Arrays.hashCode
方法源碼如下:
public static int hashCode(Object a[]) {
if (a == null)
return 0;
int result = 1;
for (Object element : a)
result = 31 * result + (element == null ? 0 : element.hashCode());
return result;
}
當(dāng)然此處只有一個參數(shù),也可以直接使用Objects
類hashCode
方法:
public static int hashCode(Object o) {
return o != null ? o.hashCode() : 0;
}
如果是多個屬性都參與hash
值的情況建議可使用第一個方法。只不過需要注意,在類結(jié)構(gòu)(成員變量)變動時,同步增減方法里面的參數(shù)值。
小結(jié)
當(dāng)我們準(zhǔn)備面試時,一直在背誦“實(shí)現(xiàn)equals
方法的同時也要實(shí)現(xiàn)hashCode
方法”,牢記這些結(jié)論并沒有錯。但我們也不能因?yàn)榇颐?zhǔn)備面試題,而忘記了這些面試題之所以頻繁出現(xiàn)的原因是什么。當(dāng)深入探索之后,會發(fā)現(xiàn)在那些枯燥的結(jié)論背后還有這么多不容忽視的知識點(diǎn),還有這么多有意思的設(shè)計(jì)與陷阱。
文章來源:www.toutiao.com/a6865829963505861132/
以上就是W3Cschool編程獅
關(guān)于Java面試題:重寫了equals,還要重寫hashCode?的相關(guān)介紹了,希望對大家有所幫助。