重写 equals()方法和 hashCode()方法

最近看了学习了集合的简单的知识，碰到了讲解 Set 的部分，感觉很好奇，
这里对于 Set集合的特点很感兴趣，Set集合判断两个元素相等的标准是两个对象通过 equals() 方法比较相等，并且两个对象的 hashCode() 方法返回值相等。
以后涉及到于 Set集合相关的应用，这个应该是必须掌握的基础知识。所以这里先了解一波比较好。

重写 equals() 方法

网上的知识有些可能是错误的，关于 equals() 方法的理解，大家讨论不一样。
这里以算法（第4版）为准吧。
两个对象相等意味着什么？如果我们用相同类型的两个引用变量a和b进行等价性测试（a==b）,我们检测的是它们的标识是否相同，即引用是否相同。Java中有一些内置的实现，它们都改写了 equals() 方法，但是当我们自定义自己的数据类型时，需要重载 equals() 方法。

Java 约定equals() 方法必须是一种等价性关系。它必须具有：

自反性，x.equals(x) 为 true；
对称性，当且仅当 y.equals(x) 为 true，x.equals(y) 为 true;
传递性，如果 x.equals(y) 和 y.equals(z) 均为 true， x.equals(z) 也将为 true。
并且，它必须接受一个 Object 为参数并满足以下性质：
一致性，当两个对象均未被修改时，反复调用 x.equals(y)
总是会返回相同的值；
非空性，x.equals(null) 总是返回 false。

这里的自反性、对称性和传递性在离散数学中有介绍，感兴趣的可以去探究！

具体步骤为：

如果对象的引用和参数对象的引用相同，返回 true。这项测试在成立时能够免去其他所有的测试工作。

如果参数为空（null），根据约定返回 false （还可以避免在下面的代码中使用空引用）。

如果两个对象的类不同，返回false。要得到一个对象的类，可以使用 getClass() 方法。请注意我们会使用 == 判断 Class

类型的对象是否相等，因为同一种类型的所有对象的 getClass() 方法一定能够返回相同的引用。将参数对象的类型从 Object 转换到当前类（因为前一项测试已经通过了，这种转换必然成功）。

如果任意实例变量的值不相同，返回 false。（这最后一步才是每个类的不同的，前面的都是相同的步骤。）

代码示例：
对于任意类来说，前面三个判断是相同的，对于自己希望的实现，通过实例变量的值进行比较。

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

重写 hashCode() 方法

Object 类的hashCode() 会返回当前对象的 hash 值，如果不重写 hashCode() 默认是使用 Object 类的 hashCode() 方法，它本身是一个 native 方法，即不是使用 Java 语言实现的。
补充一点 hash 算法的知识：
hash 算法的功能是：保证快速查找被检索的对象，它是非常快的，在不发生 hash 冲突的情况下，时间复杂度为 O(1)。

如果重写了 hashCode()，但是还想要知道对象的 hash 值，可以使用下面这个方法 System.identityHashCode(x)，如果是否重写对象的 hashCode() 方法，它都返回默认的 hashCode，就是父类 Object 继承的 hashCode() 方法返回值。

jdk 1.7 以后提供了一个 Objects 工具类，它提供了一个重写 hashCode 的方法，它的参数是可变参数。

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

它本身还是借助于 Arrays 这个工具类的方法：

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

本来重写 hashCode() 需要使用上面这个 Arrays 工具类里面的方法，但是我们有了这个工具类，就可以很方便了，这里重写 hashCode() 的方法很简单了（复杂的部分，已经被封装了，哈哈！）:

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

那我们来测试一下吧

测试实体类 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);
	}
}

测试类

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

测试结果
在这里插入图片描述
说明：可以看出来 cat1 和 cat2 不是一个对象，因为两种的引用不一样，但是对于这种属性完全一样的对象，在集合中我们希望它是被认为是相同的，所以就必须重写 equals()方法和 hashCode() 方法。从结果可以看出来，将cat1 和 cat2 加入集合后，集合的 size方法返回值为 1，并且遍历集合也只有一个元素，说明了重写的方法起作用了。

扩展部分 TreeSet 的简单应用

Comparable 和 Comparator 相关知识

TreeSet 会自动对存入的元素进行排序，是一种很有用的集合。它本身是 SortedSet 接口的实现类，TreeSet 可以确保集合元素处于排序状态。关于TreeSet 本身这里不做过多介绍，我也只是在学习中。

测试类

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 接口进行排序
		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 接口进行排序
		//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);
		//故意将方法执行两遍，这样是为了检验  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);
	}
}

运行结果
在这里插入图片描述
说明
这里注意最下面，我进行了 equals() 和 hashCode() 方法的测试，重复加入集合的元素，会被认为是相同的元素，所以遍历元素之后还是原来的元素。前面的内容就是对于 Comparable 和 Comparator 的简单应用，感兴趣的可以点击上面的链接了解一下。