实现高质量的equals方法的诀窍包括
- 使用==操作符检查“参数是否为这个对象的引用”;
- 使用instanceof操作符检查“参数是否为正确的类型”;
- 对于类中的关键属性,检查参数传入对象的属性是否与之相匹配;
- 编写完equals方法后,问自己它是否满足对称性、传递性、一致性;
- 重写equals时总是要重写hashCode;
- 不要将equals方法参数中的Object对象替换为其他的类型,在重写时不要忘掉@Override注解。
public boolean equals(Object otherObject){ //测试两个对象是否是同一个对象,是的话返回true
if(this == otherObject) { //测试检测的对象是否为空,是就返回false
return true;
}
if(otherObject == null) { //测试两个对象所属的类是否相同,否则返回false
return false;
}
if(getClass() != otherObject.getClass()) { //对otherObject进行类型转换以便和类A的对象进行比较
return false;
}
A other=(A)otherObject;
return Object.equals(类A对象的属性A,other的属性A)&&类A对象的属性B==other的属性B……;
}
例子:
public class TestEquals {
public static void main(String[] args) {
Person2 p1 = new Person2("aa", 13);
Person2 p2 = new Person2("aa", 13);
Person2 p3 = new Person2("bb", 13);
System.out.println(p1.equals(p2)); // true
System.out.println(p1.equals(p3)); // false
}
}
class Person2 {
private String name;
private int age;
public Person2(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;
}
public boolean equals(Object another) {
//先判断是不是自己,提高运行效率
if (this == another)
return true;
//再判断是不是Person类,提高代码的健壮性
if (another instanceof Person2) {
//向下转型,父类无法调用子类的成员和方法
Person2 anotherPerson = (Person2) another;
//最后判断类的所有属性是否相等,其中String类型和Object类型可以用相应的equals()来判断
if ((this.getName().equals(anotherPerson.getName())) && (this.getAge() == anotherPerson.getAge()))
return true;
} else {
return false;
}
return false;
}
}
实现hashCode
方法的通用约定
- 在应用程序的执行期间,只要对象的
equals
方法的比较操作所用到的信息没有被修改,那么对这个同一对象调用多次,hashCode
方法必须始终如一地返回同一个整数。在同一个应用程序的多次执行过程中,每次执行所返回的整数可以不一致。 - 如果两个对象根据
equals(Object)
方法比较是相等的,那么调用这两个对象中任意一个对象的hashCode
方法都必须产生同样的整数结果。反之,如果两个对象hashCode
方法返回整数结果一样,则不代表两个对象相等,因为equals
方法可以被重载。 - 如果两个对象根据
equals(Object)
方法比较是不相等的,那么调用这两个对象中任意一个对象的hashCode
方法,则不一定要产生不同的整数结果。但,如果能让不同的对象产生不同的整数结果,则有可能提高散列表的性能。
hashCode
散列码计算(来自:Effective Java)
- 把某个非零的常数值,比如
17
,保存在一个名为result
的int
类型的变量中。 - 对于对象中每个关键域
f
(指equals
方法中涉及的每个域),完成以下步骤:
- 为该域计算
int
类型的散列码c:
- 如果该域是
boolean
类型,则计算(f?1:0
)。 - 如果该域是
byte
,char
,short
或者int类型,则计算(int)f
。 - 如果该域是
long
类型,则计算(int)(f^(f>>>32))
。 - 如果该域是
float
类型,则计算Float.floatToIntBits(f)
。 - 如果该域是
double
类型,则计算Double.doubleToLongBits(f)
,然后按照步骤2.1.3,为得到的long
类型值计算散列值。 - 如果该域是一个对象引用,并且该类的
equals
方法通过递归地调用equals
的方式来比较这个域,则同样为这个域递归地调用hashCode
。如果需要更复杂的比较,则为这个域计算一个范式(canonical representation)
,然后针对这个范式调用hashCode
。如果这个域的值为null
,则返回0
(其他常数也行)。 - 如果该域是一个数组,则要把每一个元素当做单独的域来处理。也就是说,递归地应用上述规则,对每个重要的元素计算一个散列码,然后根据步骤2.2中的做法把这些散列值组合起来。如果数组域中的每个元素都很重要,可以利用发行版本1.5中增加的其中一个
Arrays.hashCode
方法。
- 按照下面的公式,把步骤2.1中计算得到的散列码
c
合并到result
中:result = 31 * result + c
; //此处31
是个奇素数,并且有个很好的特性,即用移位和减法来代替乘法,可以得到更好的性能:`31*i == (i<<5) - i, 现代JVM能自动完成此优化。
- 返回
result
- 检验并测试该
hashCode
实现是否符合通用约定。
@Override
public int hashCode() {
int result = 17;
result = 31 * result + mInt;
result = 31 * result + (mBoolean ? 1 : 0);
result = 31 * result + Float.floatToIntBits(mFloat);
result = 31 * result + (int)(mLong ^ (mLong >>> 32));
long mDoubleTemp = Double.doubleToLongBits(mDouble);
result =31 * result + (int)(mDoubleTemp ^ (mDoubleTemp >>> 32));
result = 31 * result + (mString == null ? 0 : mMsgContain.hashCode());
result = 31 * result + (mObj == null ? 0 : mObj.hashCode());
return result;
}