这里说的通用方法 , 可能更多指Object中的可被重写的方法
一. equals 方法
1. 重写equals时请准守通用约定
- 自反性 ( reflexive )
x.equals(x) == true
- 对称性 ( symmetric )
x.equals(y) == y.equals(x)
- 传递性 ( transitive )
if ( x.equals(y) && y.equals(z) ){
x.equals(z) == true;
}
- 一致性 ( consistent )
有对象 x , y . 如果 x.equals(y) == true 那么 , 只要 x , y 没有被修改就必须保证 x.equals(y) 永远都是 true . ( 若一开始是 false 则一直是 false ) - x.equals(null) == false
2. 实现 equals 方法的诀窍
- 使用 == 操作符检查 " 参数是否为正确的类型 "
- 使用 instanceof 操作符检查 " 参数是否为正确的类型 "
- 把参数转换成正确的类型
- 对于类中的每个关键域 , 检查参数中的域和该对象对应域是否匹配
public class User{//此处省略getter和setter
private String name;
private String age;
public boolean equals(Object o){
if ( o == this ){
return true;
}
if (!(o instanceof User)){
return false;
}
User user = (User)o;
return equalsStr(user.name,name)
&&equalsStr(user.age,age);
}
public boolean equalsStr(String str1,String str2){
if ( str1 == null ){
return str1 == str2;
}else {
return str1.equals(str2)
}
}
}
二. hashCode 方法 ( equals 方法被重写的时候 , 此方法也总是需要被重写 )
1. Object.hashCode通用约定
- 程序执行期间 , equals 中所用到的域值没有被修改 , 则hashCode方法的返回值不变 . (程序重启后可能可上一次程序运行时的值不一样)
- 若两对象 x.equals(y) == true 则 x.hashCode() == y.hashCode()
- 若两对象 x.equals(y) == false 则 x.hashCode() != y.hashCode()
2. 相对理想的hashCode实现方法
private boolean isRight;
private byte b;
private long l;
private float f;
private double d;
//假设在equals方法中用到了以上关键域
private volatile int hashCode;
public int hashCode(){
int result = hashCode;//可以是任意非0常量
if(result != 0){
return result;//当计算复杂的时候 , 缓存hashCode
}
int[] keys = new int[5];//上面有5个关键域
keys[0] = isRight ? 1:0;
keys[1] = (int)b;
keys[2] = (int)(l ^ ( l >>> 32 ));
keys[3] = Float.floatToIntBits(f);
long ld = Double.doubleToLongBits(d);
keys[4] = (int)(ld ^ (ld >>> 32 ));
for (int key : keys){
result = 31*result+key;
}
return result;
}
三. toString方法
Object类中toString方法的默认实现 :
public String toString() {
return getClass().getName() + "@" + Integer.toHexString(hashCode());
}
此方法返回的字符串足够简洁 , 但信息不够丰富 , 因此 " 建议所有的子类都重写这个方法 "
- 考虑指定toString方法返回数据的格式 ( 如 : json , xml 等)
指定返回格式后 , 可以提供一个静态工厂或者构造器允许传入符合格式的字符串作为参数来创建对象 . 这样 , 对象和字符串就可以相互转换
- 指定返回格式后 , 要始终保持一致 , 避免后续因为格式变动引发的错误
- 为返回字符串中包含对象的所有信息 ( 这些信息需要可被外部访问或者有可被外部访问的公有方法 )
四. clone方法
此章节主要介绍深克隆和浅克隆 . 一个较为合适的实现方法 , 应该是深克隆
1. 当类成员均引用的不可变对象
public final class PhoneNumber implements Cloneable{//省略getter和setter
private final short areaCode;
private final short prefix;
private final short lineNumber;
public PhoneNumber clone() throws CloneNotSupportedException{
return (PhoneNumber)super.clone();
}
}
因为PhoneNumber类中所有的成员变量引用的都是不可变对象 , 所以以上方法可以实现深克隆
2. 当类成员引用了"深层结构"的可变对象
当类成员中有可变对象时 , 若简单的使用 super.clone() 得到新的克隆实例 , 此时修改新实例中此可变成员的值 , 会导致原实例中此成员值一并修改 ( 新实例和原实例的成员变量指向同一个实例 )
此时应该先调用super.clone()的到一个新的实例 , 然后修正任何需要修正的成员变量值 ( final 修饰的成员变量无效 )
public final class PhoneNumber implements Cloneable{//省略getter和setter
private final short areaCode;
private final short prefix;
private final short lineNumber;
private Object[] elements;
public PhoneNumber clone() throws CloneNotSupportedException{
PhoneNumber phoneNumber = (PhoneNumber)super.clone();
phoneNumber.elements = elements.clone();//此类中仅有此域需要修正
return phoneNumber;
}
}
3. 更好的办法实现对象拷贝
使用上面的方法可能过于复杂 , 可以考虑提供拷贝构造器或者拷贝工厂
public final class PhoneNumber{//省略getter和setter
private final short areaCode;
private final short prefix;
private final short lineNumber;
private Object[] elements;
private String s;
public PhoneNumber(PhoneNumber phoneNumber){
this.areaCode = phoneNumber.areaCode;
this.prefix = phoneNumber.prefix;
this.lineNumber = phoneNumber.lineNumber;
this.elements = phoneNumber.elements.clone();
this.s = new String(phoneNumber.s);//保证新的实例中所有成员指向的实例都有原来的不一致
}
public static PhoneNumber(PhoneNumber phoneNumber){
return new PhoneNumber(phoneNumber);
}
}
五. 考虑实现Comparable接口
compareTo方法并没有在Object中声明 , 但是实现它可以获得强大的功能 .
符号sgn ( x ) 表示数学中的signum的函数 , 它根据 x 的值为负值 、零和正值分别返回 -1 , 0 , 1 .
接口实现约定
- sgn(x.compareTo(y)) == -sgn(y.compareTo(x))
- 比较关系传递 , 若 ( x.compareTo(y) > 0 && y.compareTo(c) ) 则 x.compareTo(z) > 0
- 强烈建议 (x.compareTo(y) == 0) == x.equals(y)