今天我們來談談 Java 中的 hashCode()
方法——通過原始碼的角度。眾所周知,Java 是一門物件導向的程式語言,所有的類都會預設繼承自 Object 類,而 Object 的中文意思就是“物件”。
Object 類中就包含了 hashCode()
方法:
@HotSpotIntrinsicCandidate
public native int hashCode();
意味著所有的類都會有一個 hashCode()
方法,該方法會返回一個 int 型別的值。由於 hashCode()
方法是一個本地方法(native
關鍵字修飾的方法,用 C/C++
語言實現,由 Java 呼叫),意味著 Object 類中並沒有給出具體的實現。
具體的實現可以參考 jdk/src/hotspot/share/runtime/synchronizer.cpp
(原始碼可以到 GitHub 上 OpenJDK 的倉庫中下載)。get_next_hash()
方法會根據 hashCode 的取值來決定採用哪一種雜湊值的生成策略。
並且 hashCode()
方法被 @HotSpotIntrinsicCandidate
註解修飾,說明它在 HotSpot 虛擬機器中有一套高效的實現,基於 CPU 指令。
我在 部落格園 共輸出了 100 多篇 Java 方面的文章,總字數超過 30 萬字, 內容風趣幽默、通俗易懂,收穫了很多初學者的認可和支援,內容包括 Java 語法、Java 集合框架、Java 併發程式設計、Java 虛擬機器等核心內容。
為了幫助更多的 Java 初學者,我“一怒之下”就把這些文章重新整理並開源到了 GitHub,起名《教妹學 Java》,聽起來是不是就很有趣?
GitHub 開源地址(歡迎 star):https://github.com/itwanger/jmx-java
大家有沒有想過這樣一個問題:為什麼 Object 類需要一個 hashCode()
方法呢?
在 Java 中,hashCode()
方法的主要作用就是為了配合雜湊表使用的。
雜湊表(Hash Table),也叫雜湊表,是一種可以通過關鍵碼值(key-value)直接訪問的資料結構,它最大的特點就是可以快速實現查詢、插入和刪除。其中用到的演算法叫做雜湊,就是把任意長度的輸入,變換成固定長度的輸出,該輸出就是雜湊值。像 MD5、SHA1 都用的是雜湊演算法。
像 Java 中的 HashSet、Hashtable(注意是小寫的 t)、HashMap 都是基於雜湊表的具體實現。其中的 HashMap 就是最典型的代表,不僅面試官經常問,工作中的使用頻率也非常的高。
大家想一下,如果沒有雜湊表,但又需要這樣一個資料結構,它裡面存放的資料是不允許重複的,該怎麼辦呢?
要不使用 equals()
方法進行逐個比較?這種方案當然是可行的。但如果資料量特別特別大,採用 equals()
方法進行逐個對比的效率肯定很低很低,最好的解決方案就是雜湊表。
拿 HashMap 來說吧。當我們要在它裡面新增物件時,先呼叫這個物件的 hashCode()
方法,得到對應的雜湊值,然後將雜湊值和物件一起放到 HashMap 中。當我們要再新增一個新的物件時:
- 獲取物件的雜湊值;
- 和之前已經存在的雜湊值進行比較,如果不相等,直接存進去;
- 如果有相等的,再呼叫
equals()
方法進行物件之間的比較,如果相等,不存了; - 如果不等,說明雜湊衝突了,增加一個連結串列,存放新的物件;
- 如果連結串列的長度大於 8,轉為紅黑樹來處理。
就這麼一套下來,呼叫 equals()
方法的頻率就大大降低了。也就是說,只要雜湊演算法足夠的高效,把發生雜湊衝突的頻率降到最低,雜湊表的效率就特別的高。
來看一下 HashMap 的雜湊演算法:
static final int hash(Object key) {
int h;
return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
}
先呼叫物件的 hashCode()
方法,然後對該值進行右移運算,然後再進行異或運算。
通常來說,String 會用來作為 HashMap 的鍵進行雜湊運算,因此我們再來看一下 String 的 hashCode()
方法:
public int hashCode() {
int h = hash;
if (h == 0 && value.length > 0) {
hash = h = isLatin1() ? StringLatin1.hashCode(value)
: StringUTF16.hashCode(value);
}
return h;
}
public static int hashCode(byte[] value) {
int h = 0;
int length = value.length >> 1;
for (int i = 0; i < length; i++) {
h = 31 * h + getChar(value, i);
}
return h;
}
可想而知,經過這麼一系列複雜的運算,再加上 JDK 作者這種大師級別的設計,雜湊衝突的概率我相信已經降到了最低。
當然了,從理論上來說,對於兩個不同物件,它們通過 hashCode()
方法計算後的值可能相同。因此,不能使用 hashCode()
方法來判斷兩個物件是否相等,必須得通過 equals()
方法。
也就是說:
- 如果兩個物件呼叫
equals()
方法得到的結果為 true,呼叫hashCode()
方法得到的結果必定相等; - 如果兩個物件呼叫
hashCode()
方法得到的結果不相等,呼叫equals()
方法得到的結果必定為 false;
反之:
- 如果兩個物件呼叫
equals()
方法得到的結果為 false,呼叫hashCode()
方法得到的結果不一定不相等; - 如果兩個物件呼叫
hashCode()
方法得到的結果相等,呼叫equals()
方法得到的結果不一定為 true;
來看下面這段程式碼。
public class Test {
public static void main(String[] args) {
Student s1 = new Student(18, "張三");
Map<Student, Integer> scores = new HashMap<>();
scores.put(s1, 98);
System.out.println(scores.get(new Student(18, "張三")));
}
}
class Student {
private int age;
private String name;
public Student(int age, String name) {
this.age = age;
this.name = name;
}
@Override
public boolean equals(Object o) {
Student student = (Student) o;
return age == student.age &&
Objects.equals(name, student.name);
}
}
我們重寫了 Student 類的 equals()
方法,如果兩個學生的年紀和姓名相同,我們就認為是同一個學生,雖然很離譜,但我們就是這麼草率。
在 main()
方法中,18 歲的張三考試得了 98 分,很不錯的成績,我們把張三和成績放到了 HashMap 中,然後準備輸出張三的成績:
null
很不巧,結果為 null,而不是預期當中的 98。這是為什麼呢?
原因就在於重寫 equals()
方法的時候沒有重寫 hashCode()
方法。預設情況下,hashCode()
方法是一個本地方法,會返回物件的儲存地址,顯然 put()
中的 s1 和 get()
中的 new Student(18, "張三")
是兩個物件,它們的儲存地址肯定是不同的。
HashMap 的 get()
方法會呼叫 hash(key.hashCode())
計算物件的雜湊值,雖然兩個不同的 hashCode()
結果經過 hash()
方法計算後有可能得到相同的結果,但這種概率微乎其微,所以就導致 scores.get(new Student(18, "張三"))
無法得到預期的值 18。
怎麼解決這個問題呢?很簡單,重寫 hashCode()
方法。
@Override
public int hashCode() {
return Objects.hash(age, name);
}
Objects 類的 hash()
方法可以針對不同數量的引數生成新的 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;
}
程式碼似乎很簡單,歸納出的數學公式如下所示(n 為字串長度)。
注意:31 是個奇質數,不大不小,一般質數都非常適合雜湊計算,偶數相當於移位運算,容易溢位,造成資料資訊丟失。
這就意味著年紀和姓名相同的情況下,會得到相同的雜湊值。scores.get(new Student(18, "張三"))
就會返回 98 的預期值了。
《Java 程式設計思想》這本聖經中有一段話,對 hashCode()
方法進行了一段描述。
設計
hashCode()
時最重要的因素就是:無論何時,對同一個物件呼叫hashCode()
都應該生成同樣的值。如果在將一個物件用put()
方法新增進 HashMap 時產生一個hashCode()
值,而用get()
方法取出時卻產生了另外一個hashCode()
值,那麼就無法重新取得該物件了。所以,如果你的hashCode()
方法依賴於物件中易變的資料,使用者就要當心了,因為此資料發生變化時,hashCode()
就會生成一個不同的雜湊值,相當於產生了一個不同的鍵。
也就是說,如果在重寫 hashCode()
和 equals()
方法時,物件中某個欄位容易發生改變,那麼最好捨棄這些欄位,以免產生不可預期的結果。
好。有了上面這些內容作為基礎後,我們回頭再來看看本地方法 hashCode()
的 C++ 原始碼。
static inline intptr_t get_next_hash(Thread* current, oop obj) {
intptr_t value = 0;
if (hashCode == 0) {
// This form uses global Park-Miller RNG.
// On MP system we'll have lots of RW access to a global, so the
// mechanism induces lots of coherency traffic.
value = os::random();
} else if (hashCode == 1) {
// This variation has the property of being stable (idempotent)
// between STW operations. This can be useful in some of the 1-0
// synchronization schemes.
intptr_t addr_bits = cast_from_oop<intptr_t>(obj) >> 3;
value = addr_bits ^ (addr_bits >> 5) ^ GVars.stw_random;
} else if (hashCode == 2) {
value = 1; // for sensitivity testing
} else if (hashCode == 3) {
value = ++GVars.hc_sequence;
} else if (hashCode == 4) {
value = cast_from_oop<intptr_t>(obj);
} else {
// Marsaglia's xor-shift scheme with thread-specific state
// This is probably the best overall implementation -- we'll
// likely make this the default in future releases.
unsigned t = current->_hashStateX;
t ^= (t << 11);
current->_hashStateX = current->_hashStateY;
current->_hashStateY = current->_hashStateZ;
current->_hashStateZ = current->_hashStateW;
unsigned v = current->_hashStateW;
v = (v ^ (v >> 19)) ^ (t ^ (t >> 8));
current->_hashStateW = v;
value = v;
}
value &= markWord::hash_mask;
if (value == 0) value = 0xBAD;
assert(value != markWord::no_hash, "invariant");
return value;
}
如果沒有 C++ 基礎的話,不用細緻去看每一行程式碼,我們只通過表面去了解一下 get_next_hash()
這個方法就行。其中的 hashCode
變數是 JVM 啟動時的一個全域性引數,可以通過它來切換雜湊值的生成策略。
hashCode==0
,呼叫作業系統 OS 的random()
方法返回隨機數。hashCode == 1
,在 STW(stop-the-world)操作中,這種策略通常用於同步方案中。利用物件地址進行計算,使用不經常更新的隨機數(GVars.stw_random
)參與其中。hashCode == 2
,使用返回 1,用於某些情況下的測試。hashCode == 3
,從 0 開始計算雜湊值,不是執行緒安全的,多個執行緒可能會得到相同的雜湊值。hashCode == 4
,與建立物件的記憶體位置有關,原樣輸出。hashCode == 5
,預設值,支援多執行緒,使用了 Marsaglia 的 xor-shift 演算法產生偽隨機數。所謂的 xor-shift 演算法,簡單來說,看起來就是一個移位暫存器,每次移入的位由暫存器中若干位取異或生成。所謂的偽隨機數,不是完全隨機的,但是真隨機生成比較困難,所以只要能通過一定的隨機數統計檢測,就可以當作真隨機數來使用。
至於更深層次的挖掘,涉及到數學知識和物理知識,就不展開了。畢竟菜是原罪。
叨逼叨
二哥在 部落格園 上寫了很多 Java 方面的系列文章,有 Java 核心語法、Java 集合框架、Java IO、Java 併發程式設計、Java 虛擬機器等,也算是體系完整了。
為了能幫助到更多的 Java 初學者,二哥把自己連載的《教妹學Java》開源到了 GitHub,儘管只整理了 50 篇,發現字數已經來到了 10 萬+,內容更是沒得說,通俗易懂、風趣幽默、圖文並茂。
GitHub 開源地址(歡迎 star):https://github.com/itwanger/jmx-java
如果有幫助的話,還請給二哥點個贊,這將是我繼續分享下去的最強動力!