对于所有对象都通用方法的解读(Effective Java 第三章)
这篇博文主要介绍覆盖Object中的方法要注意的事项以及Comparable.compareTo()方法。
一、谨慎覆盖equals()方法
其实平时很少要用到覆盖equals方法的情况,没有什么特殊情况最好是使用原有提供的equlas方法。因为覆盖equals()方法时要遵循一些通用的约定之外,在与hash相关的集合类使用时,就必须要覆盖hashCode()方法了(第二点会强调)。
我们先说说覆盖equlas()方法要遵循哪些通用约定:
1、自反性:对于任何非null的引用值x, x.equals(x)必须返回true;
2、对称性:对于任何非null的引用值x和y,当且仅当y.equals(x)返回true时,x.equals(y)必须返回true;
3、传递性:对于任何非null的引用值x、y和z,当且仅当x.equals(y)返回true,并且y.equals(z)也返回true,那么x.equals(z)也必须返回true;
4、一致性:对于任何一个非null的引用值x和y,只要equals的比较操作在对象中所用的信息没有被修改,多次调用x.equals(y)的结果依然一致。;
5、非空性:对于任何非null的引用值,x.equals(null)必须返回false。 且x必须不能为空,否则会抛出空指针异常。
其实上面这些约定看起来都看简单但也不能大意,很有可能你只满足了其中一点或者几点没有满足全部。如果没有满足全部的话,那么你覆盖equals()方法是不合理的,总会有那么中情况会超乎你的意料之外。
下面我们举例说明,其中自反性是很难违反的(我也想象不出怎么举反例测试,如有高手明白,请举例评论下),下面我举例验证对称性:
package test.effective;
/**
* @Description: 普通坐标类
* @author yuanfy
* @date 2017年7月13日 上午10:30:06
*/
class Point {
private int x;
private int y; public Point(int x, int y) {
this.x = x;
this.y = y;
} @Override
public boolean equals(Object obj) {
if (!(obj instanceof Point)) {
return false;
}
Point p = (Point) obj;
return this.x == p.x && this.y == p.y;
}
}
/**
* @Description: 带有颜色的坐标
* @author yuanfy
* @date 2017年7月13日 上午10:35:19
*/
class ColorPoint extends Point { private String color; public ColorPoint(int x, int y, String color) {
super(x, y);
this.color = color;
}
/**
* 与point不满足对称性示范案例
*/
@Override
public boolean equals(Object obj) {
if (!(obj instanceof ColorPoint)) {
return false;//与point实例比较直接返回false
}
ColorPoint p = (ColorPoint) obj;
return super.equals(p) && this.color.equals(p.color);
}
} public class EqualsTest {
public static void main(String[] args) {
Point p = new Point(1,2);
ColorPoint cp = new ColorPoint(1, 2, "red"); System.out.println(p.equals(cp));//输出结果:true
System.out.println(cp.equals(p));//输出结果:false
}
}
从上面的例子可以看出是违反了对称性规定的。问题原因在于:在比较普通点和有色点时,忽略了颜色的比较,而有色点跟普通点比较时,普通点不属于ColorPoint的实例,就直接返回了false。所以ColorPoint类中覆盖equlas()方法是有问题的,修改equals()方法后的代码如下:
@Override
public boolean equals(Object obj) {
//不属于Point实例对象
if (!(obj instanceof Point)) {
return false;
}
//不是ColorPoint实例对象,可能是Point实例对象或者其他类型对象
if (!(obj instanceof ColorPoint)) {
return super.equals(obj);
}
//ColorPoint实例对象
ColorPoint p = (ColorPoint) obj;
return super.equals(p) && this.color.equals(p.color);
}
测试代码如下:
ColorPoint cp1 = new ColorPoint(1, 2, "red");
Point p = new Point(1,2);
ColorPoint cp2 = new ColorPoint(1, 2, "blue"); System.out.println(cp1.equals(p));//输出结果:true
System.out.println(p.equals(cp1));//输出结果:true System.out.println(p.equals(cp2));//输出结果:true
System.out.println(cp2.equals(p));//输出结果:true System.out.println(cp1.equals(p));//输出结果:true
System.out.println(p.equals(cp2));//输出结果:true
System.out.println(cp1.equals(cp2));//输出结果:false
从修改后的例子中可以看出,这种方法确实满足了对称性,但是却不满足传递性。其实我们无法在扩展可实例化的类的同时,既增加新的值组件,同时又保留equals约定,除非愿意放弃面向对象的抽象带来的优势。当然我们可以不扩展Point的,所谓“复合优先于继承”。在ColorPoint假如一个私有的Point域,代码如下:
class ColorPoint{ private String color; private Point point; public ColorPoint(int x, int y, String color) {
point = new Point(x, y);
this.color = color;
} public Point asPoint(){
return point;
} @Override
public boolean equals(Object obj) {
if (!(obj instanceof ColorPoint)) {//满足非空性验证
return false;
}
//ColorPoint实例对象
ColorPoint p = (ColorPoint) obj;
return this.point.equals(p.point) && this.color.equals(p.color);
}
} public class EqualsTest1 {
public static void main(String[] args) {
ColorPoint cp1 = new ColorPoint(1, 2, "red");
Point p = new Point(1,2);
ColorPoint cp2 = new ColorPoint(1, 2, "red");
ColorPoint cp3 = new ColorPoint(1, 2, "red"); System.out.println(cp1.equals(p));//输出结果:false
System.out.println(p.equals(cp1));//输出结果:false System.out.println(cp1.equals(cp2));//输出结果:true
System.out.println(cp2.equals(cp1));//输出结果:true System.out.println(cp1.equals(cp2));//输出结果:true
System.out.println(cp2.equals(cp3));//输出结果:true
System.out.println(cp1.equals(cp3));//输出结果:true
}
}
上面的例子就满足对称性、传递性同时满足非空性。
接下来验证一致性:如果两个对象相等,它们就必须始终保持相等,除非他们中有一个对象或者两个都被修改了。换句话说,可变的对象在不同的时候可以与不同的对象相等, 而不可变对象则不会这样。比如说时间对象一个指定了时间,另外一个对象没有指定时间。当在某一个刻时候,他们既满足对称性和传递性,但是它不满足一致性。因为没有指定时间的对象的时间是一直在改变的。
所以当你编写完成了equlas之后,应该测试验证是否满足这个几个特性。
二、覆盖equals时总要覆盖hashCode
书中提出:在每个覆盖了equlas方法的类,也必须覆盖hashCode方法。如果不这样做的话, 就会违反Object.hashCode()的通用约定,从而导致该类无法结合所有基于散列的集合一起正常运作,这样的集合包括HashMap、HashSet和HashTable。
其中约定简洁如下(详细请参考书中):
1、相等的对象必须具有相等的散列码(hash code)
2、不相等的对象未必是不一样的散列码。也就是说相同散列码的两个对象,两个对象未必相等。但是相等的两个对象,一定就有相等的散列码。
下面根据例子来说明:
package test.effective; import java.util.HashMap;
import java.util.Map; public class PhoneNumber {
private int areaCode; private int prefix; private int lineNumer; public PhoneNumber(int areaCode, int prefix, int lineNumer) {
this.areaCode = areaCode;
this.prefix = prefix;
this.lineNumer = lineNumer;
} @Override
public boolean equals(Object obj) {
if (obj == this) {
return true;
}
if (!(obj instanceof PhoneNumber)) {
return false;
}
PhoneNumber pn = (PhoneNumber) obj;
return this.areaCode == pn.areaCode
&& this.prefix == pn.prefix
&& this.lineNumer == this.lineNumer;
} public static void main(String[] args) { Map<PhoneNumber, String> map = new HashMap<PhoneNumber, String>();
PhoneNumber pn1 = new PhoneNumber(408, 867, 5309);
PhoneNumber pn2 = new PhoneNumber(408, 867, 5309); System.out.println(pn1.equals(pn2));//输出结果:true map.put(pn1, "Jany"); System.out.println(map.get(pn1));
System.out.println(map.get(pn2));
}
}
我们将覆盖了equals方法的类结合基于散列码的集合使用。从上面例子39行知道pn1实例和pn2实例是相等,行43代码输出的结果可想而知是Jany,但是行44输出什么呢,估计没有仔细考虑的话,可能第一感觉也会输出null。我们看下HashMap中get方法源码就知道了。
public V get(Object key) {
if (key == null)
return getForNullKey();
Entry<K,V> entry = getEntry(key); return null == entry ? null : entry.getValue();
}
final Entry<K,V> getEntry(Object key) {
if (size == 0) {
return null;
} int hash = (key == null) ? 0 : hash(key);//获取对象的hash值
for (Entry<K,V> e = table[indexFor(hash, table.length)];
e != null;
e = e.next) {
Object k;
//hash必须相等才有可能进行返回
if (e.hash == hash &&
((k = e.key) == key || (key != null && key.equals(k))))
return e;
}
return null;
}
从源码中得知get()方法是要根据hash值获取的。然后我们在看看pn1和pn2对象的hash码。
System.out.println(pn1.hashCode());//
System.out.println(pn2.hashCode());//2031122075
所以显而易见见,上述map.get(pn2) 的返回值是为null的。
修正这个问题很简单,在PhoneNumber类中覆盖hashCode()方法即可,先提供简单的案例:
@Override
public int hashCode() {
return 1;
}
这样的能满足上面那个例子map.get(pn2) 返回“Jany”,但是这样 所有实例都是返回一样的hashCode是不可取的。参考书中最正确的方式:
@Override
public int hashCode() {
int result = 17;
result = 31 * result + areaCode;
result = 31 * result + prefix;
result = 31 * result + lineNumer;
return 1;
}
对于所有对象都通用方法的解读(Effective Java 第三章)的更多相关文章
- 对于所有对象都通用方法的解读(Effective Java 第二章)
这篇博文主要介绍覆盖Object中的方法要注意的事项以及Comparable.compareTo()方法. 一.谨慎覆盖equals()方法 其实平时很少要用到覆盖equals方法的情况,没有什么特殊 ...
- [Effective Java]第三章 对所有对象都通用的方法
声明:原创作品,转载时请注明文章来自SAP师太技术博客( 博/客/园www.cnblogs.com):www.cnblogs.com/jiangzhengjun,并以超链接形式标明文章原始出处,否则将 ...
- Java高效编程之二【对所有对象都通用的方法】
对于所有对象都通用的方法,即Object类的所有非final方法(equals.hashCode.toString.clone和finalize)都有明确的通用约定,都是为了要被改写(override ...
- Effective Java:对于全部对象都通用的方法
前言: 读这本书第1条规则的时候就感觉到这是一本非常好的书.可以把我们的Java功底提升一个档次,我还是比較推荐的.这里我主要就关于覆盖equals.hashCode和toString方法来做一个笔记 ...
- [Effective Java 读书笔记] 第三章 对所有对象都通用的方法 第八 ---- 九条
这一章主要讲解Object类中的方法, Object类是所有类的父类,所以它的方法也称得上是所有对象都通用的方法 第八条 覆盖equals时需要遵守的约定 Object中的equals实现,就是直接对 ...
- Effective java -- 2 对于所有对象都通用到方法
第八条:覆盖equals时请遵守通用约定 什么时候需要覆盖equals方法?类具有自己的逻辑相等概念,并且父类的equals方法不能满足需要.重写equals时需要遵循一下约定: 自反性:非null ...
- 《Effective Java》第3章 对于所有对象都通用的方法
第8条:覆盖equals时请遵守通用约定 覆盖equals方法看起来似乎很简单,但是有许多覆盖方式会导致错误,并且后果非常严重.最容易避免这类问题的办法就是不覆盖equals方法,在这种情况下,类的每 ...
- Effective Java读书笔记——第三章 对于全部对象都通用的方法
第8条:覆盖equals时请遵守通用的约定 设计Object类的目的就是用来覆盖的,它全部的非final方法都是用来被覆盖的(equals.hashcode.clone.finalize)都有通用约定 ...
- 《Effective Java》第2章 对所有对象都通用的方法
第10条:覆盖equals时,请遵守通用约定 1.使用==来比较两个对象的时候,比较的是两个对象在内存中的地址是否相同(两个引用指向的是否为同一个对象):Object中定义的equals方法也是这样比 ...
随机推荐
- 【alpha】Scrum站立会议第4次....10.19
小组名称:nice! 小组成员:李权 于淼 杨柳 刘芳芳 项目内容:约跑app(约吧--暂定) 1.任务进度 2.燃尽图 功能列表 1.登录注册 2.创建跑步计划 3.筛选跑友 4.加一起跑步的人为好 ...
- 【Linux】- rm命令
Linux rm命令用于删除一个文件或者目录. 语法 rm [options] name... 参数: -i 删除前逐一询问确认. -f 即使原档案属性设为唯读,亦直接删除,无需逐一确认. -r 将目 ...
- CentOS基础命令
为网卡配置静态IP地址建议通过交互式界面nmtui进行配置 firewalld和iptablesCentOS7使用firewald取代原来的iptables,但实际上底层还是iptables,在上层加 ...
- InstallShield Limited Edition for Visual Studio 国内注册时国家无下拉框解决方法
注册地址:http://learn.flexerasoftware.com/content/IS-EVAL-InstallShield-Limited-Edition-Visual-Studio 火狐 ...
- WPF对某控件添加右键属性
代码创建右键属性 ContextMenu cm = new ContextMenu(); MenuItem mi = new MenuItem(); mi.Header = "打开此文件所有 ...
- 【bzoj2763】[JLOI2011]飞行路线 分层图最短路
题目描述 Alice和Bob现在要乘飞机旅行,他们选择了一家相对便宜的航空公司.该航空公司一共在n个城市设有业务,设这些城市分别标记为0到n-1,一共有m种航线,每种航线连接两个城市,并且航线有一定的 ...
- queue队列
1.作用:解耦,提高效率.队列就是一个容器,一个有顺序的容器. q.queue.Queue(maxsize=3): 生成一个队列的实例,并且最多存储3个元素 q.get(item,block=Ture ...
- CentOS 不间断会话(ssh关闭后如何保证程序继续运行)(nohup和screen)
当使用ssh与远程主机的会话被关闭时,在远程主机上运行的命令也随之被中断. 就是ssh 打开以后,bash等都是他的子程序,一旦ssh关闭,系统将所有相关进程杀掉!! 导致一旦ssh关闭,执行中的任务 ...
- [USACO06NOV]玉米田Corn Fields 状压DP
题面: 农场主John新买了一块长方形的新牧场,这块牧场被划分成M行N列(1 ≤ M ≤ 12; 1 ≤ N ≤ 12),每一格都是一块正方形的土地.John打算在牧场上的某几格里种上美味的草,供他的 ...
- POJ2774:Long Long Message——题解
http://poj.org/problem?id=2774 给定两个字符串 A 和 B,求最长公共子串. 论文题,把两个串合并起来,比较两个串各自的后缀的height值取最大即可. #include ...