重寫(xiě) equals()方法 和 hashCode()方法

最近看了學(xué)習(xí)了集合的簡(jiǎn)單的知識(shí)，碰到了講解 Set 的部分，感覺(jué)很好奇，
這里對(duì)于 Set集合 的特點(diǎn)很感興趣，Set集合判斷兩個(gè)元素相等的標(biāo)準(zhǔn)是兩個(gè)對(duì)象通過(guò) equals() 方法比較相等，并且兩個(gè)對(duì)象的 hashCode() 方法返回值相等。
以后涉及到于 Set集合相關(guān)的應(yīng)用，這個(gè)應(yīng)該是必須掌握的基礎(chǔ)知識(shí)。所以這里先了解一波比較好。

重寫(xiě) equals() 方法

網(wǎng)上的知識(shí)有些可能是錯(cuò)誤的，關(guān)于 equals() 方法的理解，大家討論不一樣。
這里以 算法（第4版）為準(zhǔn)吧。
兩個(gè)對(duì)象相等意味著什么？如果我們用相同類(lèi)型的兩個(gè)引用變量a和b進(jìn)行等價(jià)性測(cè)試（a==b）,我們檢測(cè)的是它們的標(biāo)識(shí)是否相同，即引用是否相同。Java中有一些內(nèi)置的實(shí)現(xiàn)，它們都改寫(xiě)了 equals() 方法，但是當(dāng)我們自定義自己的數(shù)據(jù)類(lèi)型時(shí)，需要重載 equals() 方法。

Java 約定equals() 方法必須是一種等價(jià)性關(guān)系。它必須具有：

自反性，x.equals(x) 為 true；
對(duì)稱性，當(dāng)且僅當(dāng) y.equals(x) 為 true，x.equals(y) 為 true;
傳遞性，如果 x.equals(y) 和 y.equals(z) 均為 true， x.equals(z) 也將為 true。
并且，它必須接受一個(gè) Object 為參數(shù)并滿足以下性質(zhì)：
一致性，當(dāng)兩個(gè)對(duì)象均未被修改時(shí)，反復(fù)調(diào)用 x.equals(y)
總是會(huì)返回相同的值；
非空性，x.equals(null) 總是返回 false。

這里的自反性、對(duì)稱性和傳遞性在離散數(shù)學(xué)中有介紹，感興趣的可以去探究！

具體步驟為：

如果對(duì)象的引用和參數(shù)對(duì)象的引用相同，返回 true。這項(xiàng)測(cè)試在成立時(shí)能夠免去其他所有的測(cè)試工作。如果參數(shù)為空（null），根據(jù)約定返回 false （還可以避免在下面的代碼中使用空引用）。如果兩個(gè)對(duì)象的類(lèi)不同，返回false。要得到一個(gè)對(duì)象的類(lèi)，可以使用 getClass() 方法。請(qǐng)注意我們會(huì)使用 == 判斷 Class類(lèi)型的對(duì)象是否相等，因?yàn)橥环N類(lèi)型的所有對(duì)象的 getClass() 方法一定能夠返回相同的引用。 將參數(shù)對(duì)象的類(lèi)型從 Object 轉(zhuǎn)換到 當(dāng)前類(lèi)（因?yàn)榍耙豁?xiàng)測(cè)試已經(jīng)通過(guò)了，這種轉(zhuǎn)換必然成功）。如果任意實(shí)例變量的值不相同，返回 false。（這最后一步才是每個(gè)類(lèi)的不同的，前面的都是相同的步驟。）

代碼示例：
對(duì)于任意類(lèi)來(lái)說(shuō)，前面三個(gè)判斷是相同的，對(duì)于自己希望的實(shí)現(xiàn)，通過(guò)實(shí)例變量的值進(jìn)行比較。

	@Override
	public boolean equals(Object x) {
		if (this == x) return true;
		if (x == null) return false;
		if (this.getClass() != x.getClass()) return false;
		Cat cat  = (Cat)x;
		if (this.name != cat.getName()) return false;
		if (this.age != cat.getAge()) return false;
		return true;
	}

重寫(xiě) hashCode() 方法

Object 類(lèi)的hashCode() 會(huì)返回當(dāng)前對(duì)象的 hash 值，如果不重寫(xiě) hashCode() 默認(rèn)是使用 Object 類(lèi)的 hashCode() 方法，它本身是一個(gè) native 方法，即不是使用 Java 語(yǔ)言實(shí)現(xiàn)的。
補(bǔ)充一點(diǎn) hash 算法的知識(shí)：
hash 算法的功能是：保證快速查找被檢索的對(duì)象，它是非常快的，在不發(fā)生 hash 沖突的情況下，時(shí)間復(fù)雜度為 O(1)。

如果重寫(xiě)了 hashCode()，但是還想要知道對(duì)象的 hash 值，可以使用下面這個(gè)方法 System.identityHashCode(x)，如果是否重寫(xiě)對(duì)象的 hashCode() 方法，它都返回默認(rèn)的 hashCode，就是父類(lèi) Object 繼承的 hashCode() 方法返回值。

jdk 1.7 以后提供了一個(gè) Objects 工具類(lèi)，它提供了一個(gè)重寫(xiě) hashCode 的方法，它的參數(shù)是可變參數(shù)。

 public static int hash(Object... values) {
        return Arrays.hashCode(values);
    }

它本身還是借助于 Arrays 這個(gè)工具類(lèi)的方法：

  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;
    }

本來(lái)重寫(xiě) hashCode() 需要使用上面這個(gè) Arrays 工具類(lèi)里面的方法，但是我們有了這個(gè)工具類(lèi)，就 可以很方便了，這里重寫(xiě) hashCode() 的方法很簡(jiǎn)單了（復(fù)雜的部分，已經(jīng)被封裝了，哈哈！）:

@Override
	public int hashCode() {
		return Objects.hash(name,age);
	}

那我們來(lái)測(cè)試一下吧

測(cè)試實(shí)體類(lèi) Cat

package com;
import java.util.Objects;

public class Cat implements Comparable<Cat>{
	private String name;
	private int age;
	
	public Cat() {}
	
	public Cat(String name, int age) {
		this.name = name;
		this.age = age;
	}

	public String getName() {
		return name;
	}

	public void setName(String name) {
		this.name = name;
	}

	public int getAge() {
		return age;
	}

	public void setAge(int age) {
		this.age = age;
	}

	@Override
	public String toString() {
		return "Cat [name=" + name + ", age=" + age + "]";
	}
	
	@Override
	public boolean equals(Object x) {
		if (this == x) return true;
		if (x == null) return false;
		if (this.getClass() != x.getClass()) return false;
		Cat cat  = (Cat)x;
		if (this.name != cat.getName()) return false;
		if (this.age != cat.getAge()) return false;
		return true;
	}
	
	@Override
	public int hashCode() {
		return Objects.hash(name,age);
	}

	@Override
	public int compareTo(Cat o) {
		return o.name.compareTo(name);
	}
}

測(cè)試類(lèi)

package com;

import java.util.HashSet;
import java.util.Set;

public class Test {
	public static void main(String[] args) throws Exception {
		Set<Cat> cats = new HashSet<>();
		Cat cat1 = new Cat("小貓",3);
		Cat cat2 = new Cat("小貓",3);
		System.out.println("cat1 == cat2: "+(cat1 == cat2));
		cats.add(cat1);
		cats.add(cat2);
		System.out.println("cats.size()："+cats.size());
		cats.forEach(System.out::println);
	}
}

測(cè)試結(jié)果

說(shuō)明：可以看出來(lái) cat1 和 cat2 不是一個(gè)對(duì)象，因?yàn)閮煞N的引用不一樣，但是對(duì)于這種屬性完全一樣的對(duì)象，在集合中我們希望它是被認(rèn)為是相同的，所以就必須 重寫(xiě) equals()方法 和 hashCode() 方法。從結(jié)果可以看出來(lái)，將cat1 和 cat2 加入集合后，集合的 size方法返回值為 1，并且遍歷集合也只有一個(gè)元素，說(shuō)明了 重寫(xiě)的方法起作用了。

擴(kuò)展部分 TreeSet 的簡(jiǎn)單應(yīng)用

Comparable 和 Comparator 相關(guān)知識(shí)

TreeSet 會(huì)自動(dòng)對(duì)存入的元素進(jìn)行排序，是一種很有用的集合。它本身是 SortedSet 接口的實(shí)現(xiàn)類(lèi)，TreeSet 可以確保集合元素處于排序狀態(tài)。關(guān)于TreeSet 本身這里不做過(guò)多介紹，我也只是在學(xué)習(xí)中。

測(cè)試類(lèi)

package com;

import java.util.Set;
import java.util.TreeSet;

public class Client {

	public static void main(String[] args) {
		Cat cat = null;
		Set<Cat> cats = null;
		//使用 Comparable 接口進(jìn)行排序
		cats = new TreeSet<>();
		for (int i = 0; i < 10; i++) {
			cat = new Cat("小貓"+i, i);
			cats.add(cat);
		}
		System.out.println("-------------Comparable---------------");
		cats.forEach(System.out::println);
		cats.clear();   //注意清空集合。
		
		//使用 Comparator 接口進(jìn)行排序
		//Comparator<Cat> c = (e1,e2)->e1.getAge()-e2.getAge();
		cats = new TreeSet<>((e1,e2)->e1.getAge()-e2.getAge());
		for (int i = 0; i < 10; i++) {
			cat = new Cat("小貓"+i, i);
			cats.add(cat);
		}
		System.out.println("-------------Comparator---------------");
		cats.forEach(System.out::println);
		//故意將方法執(zhí)行兩遍，這樣是為了檢驗(yàn)  equals()方法和 hsahCode()方法。
		for (int i = 0; i < 10; i++) {
			cat = new Cat("小貓"+i, i);
			cats.add(cat);
		}
		System.out.println("-------------equals() 和 hashCode() ---------------");
		cats.forEach(System.out::println);
	}
}

運(yùn)行結(jié)果

說(shuō)明
這里注意最下面，我進(jìn)行了 equals() 和 hashCode() 方法的測(cè)試，重復(fù)加入集合的元素，會(huì)被認(rèn)為是相同的元素，所以遍歷元素之后還是原來(lái)的元素。前面的內(nèi)容就是對(duì)于 Comparable 和 Comparator 的簡(jiǎn)單應(yīng)用，感興趣的可以點(diǎn)擊上面的鏈接了解一下。

到此這篇關(guān)于關(guān)于重寫(xiě)equals()方法和hashCode()方法及其簡(jiǎn)單的應(yīng)用的文章就介紹到這了,更多相關(guān)重寫(xiě)equals()和hashCode()及應(yīng)用內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論