HashCode 和 Equals 的使用 - 使用自定義物件作為HashMap的Key例子

首先，

通過分析 Java.lang.Object 中的原始碼 

public boolean equals(Object obj){
        return (this == obj);
}

發現，其實equals 比較的也是 兩個 物件是否為同一物件，也就是比較的reference,

比如

Person p1 = new Person();
Person p2 = p1;
Person p3 = new Person();
p1.equals(p2); //True
p1.equals(p3); //False

但是為什麼對於其他的比如 Integer, Double, String 等在比較的時候是比較他們中的內容是否一致呢？

比如

Integer i1 = new Integer(1);
Integer i2 = new Integer(2);
Integer i3 = new Integer(1);
i1.equals(i2); //False
i1.equals(i3); //True

分析它們的原始碼 equals可以看出Integer等類重寫(Override)了equals方法, 是equals方法比較兩個物件中儲存的值。

public boolean equals(Object obj) {
  if (obj instanceof Integer) {
   return value == ((Integer) obj).intValue();
 }
 return false;
}

現在來看一下我們們的需求, 我們現在有一個Person 類

public class Person {
	private int id;
	Person (int id) {
		this.id = id;
	}

 }

我們現在想要通過new 一個新的Person物件，但是這個Person物件含有的id是已經存在我們的map中的，

很明顯，如果我們現在執行以下的程式碼，將會輸出 null，為什麼這樣呢？

public class TestPerson {
	public static void main (String[] args) {
		HashMap<Person, String> map = new HashMap<Person, String>();
		Person p1 = new Person(101);
		Person p2 = new Person(102);
		Person p3 = new Person(103);
		map.put(p1, "tim");
		map.put(p2, "tony");
		map.put(p3, "Bi");
		System.out.println(map.get(new Person(101)));
	}
}

我們現在來分析下HashMap的原始碼，

HashMap.get 方法

public V get(Object key) {
315         if (key == null)
316             return getForNullKey();
317         int hash = hash(key.hashCode());
318         for (Entry<K,V> e = table[indexFor(hash, table.length)];
319              e != null;
320              e = e.next) {
321             Object k;
322             if (e.hash == hash && ((k = e.key) == key || key.equals(k)))
323                 return e.value;
324         }
325         return null;
326     }

這個方法做了以下幾件事情：

1. 將輸入的物件的hashcode拿出來

2. 將輸入物件的hashcode和所有的KeySet中的物件hashcode進行比較

3. 將輸入物件和所有的KeySet中的物件使用equals方法進行比較

那麼我們現在要關心幾件事情：

1. 什麼是物件的hashcode，對於我們的Person 物件來說，因為它是繼承來自Java.lang.Object 的，所以我們通過分析Java.lang.Object 的hashcode方法得知， 我們的Person物件的hashcode是一個和它記憶體相關的整形數。

2. hashmap 中 equals 方法中比較的是什麼？ 通過分析原始碼，我們得知在 hashmap 的 equals 中比較了reference 和 它們的hashcode的值。

為了實現我們的目標，我們該做什麼呢？

1. 重寫 Person 的 hashCode() 方法

2. 重寫 Person 的equals(Obejct obj) 方法

public class Person {
	private int id;
	Person (int id) {
		this.id = id;
	}
	
	public int hashCode () {
		return this.id;
	}
	
	public boolean equals (Object obj) {
		return obj instanceof Person &&
				this.id == ((Person) obj).id;
	}
}

這樣的修改後，就能滿足我們的需求！

有問題歡迎指出！