本篇介绍Object类中的equals()方法和hashCode()方法,以及关于它们的重写。
equals()方法
equals()方法在Object类中的实现即直接使用==比较两个对象的内存地址,但一般来说,重写equals()方法时比较的都是该类的的某个或某些值。例如Integer重写的equals()方法比较的是其value值,String重写的equals()方法比较的是其char[]数组的全部元素。
我们需要重写equals()方法时必须注意以下几点:
- 自反性:对于任何非空引用x,x.equals(x)应该返回true;
- 对称性:对任何引用值x和y,当x.equals(y)返回值为true时,那么y.equals(x)也应该返回true;
- 传递性:对于任何引用x、y和z,如果x.equals(y)返回true,y.equals(z)返回true,那么x.equals(z)也应该返回true;
- 一致性:如果x和y引用的对象没有发生变化,那么多次调用x.equals(y)应该返回相同的结果;
- 非空性:对于任意非空引用x,x.equals(null)应该返回false。
以上很好理解,不再一一解释。重写equals()方法一般按照以下格式即可:
public class O{
private String name;
private Integer age;
public boolean equals(Object object){
//如果两个对象地址相同,则实为一个对象,肯定返回true
if(this == object){
return true;
}
//如果传入参数为null,则直接返回false
if(object == null){
return false;
}
//如果两个对象的类信息不同,则直接返回false
if(getClass() != object.getClass()){
return false;
}
//上一步未返回则说明这两个对象是同一个类的对象,因此将入参类型强制转换
O other = (O)object;
//根据业务不同,此处可以自定义比较属性,此处定义为两个属性相同即返回true
return age.equals(other.getAge()) && name.equals(other.getName());
}
}
hashCode()方法
hashCode()方法是一个native方法,返回的是对象的内存地址。此方法只有在使用哈希表数据结构的时候才会用到,例如HashMap,HashSet等集合。
equals()和hashCode()方法的重写
现在有Person类如下:
class Person{
private String name;
private Integer age;
private Integer gender;
public Person(String name, Integer age, Integer gender) {
this.name = name;
this.age = age;
this.gender = gender;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public Integer getAge() {
return age;
}
public void setAge(Integer age) {
this.age = age;
}
public Integer getGender() {
return gender;
}
public void setGender(Integer gender) {
this.gender = gender;
}
@Override
public String toString() {
return "Person{" +
"name='" + name + '\'' +
", age=" + age +
", gender=" + gender +
'}';
}
}
在Person类中我们没有重写equals()方法,这时如果调用Person对象的equals()方法比较的便是两个对象的内存地址,例如下面的测试代码:
public static void main(String[] args) {
Person charles = new Person("Charles",12,0);
Person anoCharles = new Person("Charles",12,0);
System.out.println("equals:"+charles.equals(anoCharles));
HashMap<Person,Integer> scoreMap = new HashMap<>();
scoreMap.put(charles,12);
scoreMap.put(anoCharles,13);
System.out.println("charles的分数是:"+scoreMap.get(charles));
}
输出结果:
equals:false
charles的分数是:12
以上输出结果是意料之中的事情,因为这两个Person的内存地址必然不可能相同,所以equals()方法返回false。至于HashMap后面的代码我们暂且不管。
现在我们想要实现的是当Person类的三个属性name,age,gender相同时,equals()返回结果为true。在Person类中重写equals()方法如下:
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
Person person = (Person) o;
return name.equals(person.name) &&
age.equals(person.age) &&
gender.equals(person.gender);
}
再此运行测试代码,输出结果如下:
equals:true
charles的分数是:12
可以看到equals()方法返回结果为true,达到了我们的要求。这时再去看测试代码中HashMap定义后的代码就发现好像有点问题,既然我们认为这两个Person对象是相同的,并且HashMap的key是不能重复的,那在scoreMap将anoCharles对象放进去的时候就应该把charles对象替代了呀。在不使用散列表数据结构时是不会出现以上问题的,但散列表是我们常见的数据结构之一。
以上问题发生的原因是我们重写了equals()方法但没有重写hashCode()方法。HashMap将Person作为key存储键值对时,会先计算Person对象的hash值,然后根据hash值将对应的value存储到相应的位置。我们没重写hashCode()方法,这两个对象的hash值也就是它们的内存地址,因此肯定不可能相同。关于HashMap的相关原理可以看这篇文章,此处不再赘述。
我们在Person类中再把hashCode()方法重写了,这里就简单使用Person类的三个属性的hash值的和作为Person对象的hash值:
public int hashCode() {
return name.hashCode()+age.hashCode()+gender.hashCode();
}
这次在测试代码中加入两行输出两个Person对象的hash值的代码,再次运行,输出结果如下:
equals:true
charles的hash值:-1891246352
anoCharles的hash值:-1891246352
charles的分数是:13
可以看到两个Person对象的hash值相同并且HashMap认为charles和anoCharles是“同一个对象”,因此将anoCharles放入Map时直接将charles对象为key的键值对的value值12替换为了13。