因为Java中所有类都继承自Object类,所以Java中的所有对象都有equals方法。
/**
* Object类默认的equals()方法
*/
public boolean equals(Object obj) {
return (this == obj);
}
重写equals方法
Object的equals方法默认比较的是引用(对象地址),有些时候不能满足我们的需求,比如我们定义一个不允许有重复值的对象数组,规定两个对象内成员变量的值相同,这两个对象就重复,当我们向对象内插入对象时,必然要先判断插入的对象是否在数组中存在,如果存在就替换,不存在就插入,但是用equals方法显然判断不出,因为new出来的对象的内存地址肯定不同,所以数组中的值难免会重复,这时候就要重写对象类的equals方法,在其中加入我们自己的逻辑。
未重写equals方法
public class EqualsTest {
public static void main(String[] args) {
// 定义students列表,不允许学生重名。
List<Student> students = new ArrayList<>();
Student student;
// 重复插入10次小明
for (int i = 0; i < 10; i++) {
student = new Student("小明");
if (!students.contains(student)) {
students.add(student);
}
}
System.out.println(students.size());
}
}
class Student {
private String name;
public Student(String name) {
this.name = name;
}
}
运行结果:
我们期望的输出结果是1,这里运行结果输出为10,插入了10个重名的同学,很明显不符合我们的需求
重写equals方法
public class EqualsTest {
public static void main(String[] args) {
// 定义students列表,不允许学生重名。
List<Student> students = new ArrayList<>();
Student student;
// 重复插入10次小明
for (int i = 0; i < 10; i++) {
student = new Student("小明");
if (!students.contains(student)) {
students.add(student);
}
}
System.out.println(students.size());
}
}
class Student {
private String name;
public Student(String name) {
this.name = name;
}
public String getName() {
return name;
}
/**
* 重写equals方法
*
* @param obj
* @return
*/
@Override
public boolean equals(Object obj) {
if (obj == this) {
return true;
}
if (obj instanceof Student) {
Student student = (Student) obj;
if (student.getName().equals(this.name)) {
return true;
}
}
return false;
}
}
运行结果:
重写equals方法后运行结果符合期望
重写hashCode方法
hashcode的作用
利用HashSet/HashMap/Hashtable类来存储数据时,为了提高程序的效率,先进行hashcode的比较,如果不同,那没就不必在进行equals的比较了,这样大大减少了equals比较的次数,从而大幅度提高了效率。
JDK的API建议:equals方法被重写时,通常有必要重写 hashCode 方法,以维护 hashCode 方法的常规协定,该协定声明相等对象必须具有相等的哈希码。常规协定如下
(1)当obj1.equals(obj2)为true时,obj1.hashCode() == obj2.hashCode()必须为true
(2)当obj1.hashCode() == obj2.hashCode()为false时,obj1.equals(obj2)必须为false
上面的例子中,我们重写了equals方法,并规定只要对象的name属性值相同,两个对象就相等,很显然我们的目的可以轻松达到。但是我们没有重写hashCode方法。hashCode方法仍然返回的对象的内存地址,所以两个对象的hashCode值还是不相等,这就违反了hashCode 方法的常规协定。后果是,在某些利用对象hashCode值做索引的情况下,这样会造成混乱,相当于没有重写equals方法。
/**
* 重写Student类的hashCode方法
*
* @return
*/
@Override
public int hashCode() {
return this.name.hashCode();
}
equals的其他规定
自反性:对于任何非空引用值 x,x.equals(x) 都应返回 true。
对称性:对于任何非空引用值 x 和 y,当且仅当 y.equals(x) 返回 true 时,x.equals(y) 才应返回 true。
传递性:对于任何非空引用值 x、y 和 z,如果 x.equals(y) 返回 true,并且 y.equals(z) 返回 true,那么 x.equals(z) 应返回 true。
一致性:对于任何非空引用值 x 和 y,多次调用 x.equals(y) 始终返回 true 或始终返回 false,前提是对象上 equals 比较中所用的信息没有被修改。
对于任何非空引用值 x,x.equals(null) 都应返回 false。