JDK的equals方法都写错了，那到底该怎么写呢？（备战2022春招或暑期实习，每天进步一点点，打卡100天，Day3）

•  备战2022春招或暑期实习&＃xff0c;祝大家每天进步亿点点&＃xff01;Day3
• 本篇总结的是 《JDK的equals方法都写错了&＃xff0c;那到底该怎么写呢》&＃xff0c;后续会每日更新~
• 关于《Redis入门到精通》、《并发编程》等知识点可以参考我的往期博客&＃xff1a;《Redis从入门到精通》系列 《并发编程》系列
• 相信自己&＃xff0c;越活越坚强&＃xff0c;活着就该逢山开路&＃xff0c;遇水架桥&＃xff01;生活&＃xff0c;你给我压力&＃xff0c;我还你奇迹&＃xff01;

1、简介

Java程序员都知道java.lang.Object类&＃xff0c;这是所有类的超类。Object类中提供了几个public的方法&＃xff0c;比如&＃xff1a;

public boolean equals(Object var1) {return this &＃61;&＃61; var1;
}public String toString() {return this.getClass().getName() &＃43; "&＃64;" &＃43; Integer.toHexString(this.hashCode());
}


这些public方法第一是提供给所有的子类去扩展&＃xff08;覆盖&＃xff09;&＃xff0c;第二是明确了Java中的类所具备的通用约定。因此Java中的类在覆盖这些方法是&＃xff0c;都需要遵守通用约定&＃xff0c;避免程序员们各玩各的。 ​

那具体应该怎么覆盖&＃xff0c;又应该遵守那些通用约定呢&＃xff1f; 其实这是一个非常复杂的问题&＃xff0c;正如Java大师约书亚·布洛克&＃xff08;Joshua Bloch&＃xff09;所说&＃xff1a;它看似简单&＃xff0c;但是往往很多高级程序员也无法完全正确的实现&＃xff0c;并且如果不严格遵守&＃xff0c;往往会导致非常严重的后果。

2、正文

2.1 什么时候需要重写equals方法

总结一句话就是&＃xff1a;当我们需要比较两个对象是否“逻辑相等”时&＃xff0c;可能需要考虑重写equals方法&＃xff0c;比如我们需要比较值类型的类Integer、String&＃xff0c;这些类经常需要用于承载和比较值是否相等&＃xff0c;或者用于做个Map、Set等集合的Key值&＃xff0c;在这些场景下我们是需要严格的去重写equals方法的。&＃xff08;我这里说的是可能&＃xff0c;是因为很多情况下无招胜有招&＃xff0c;我们或许不需要重写equals方法&＃xff0c;至于那些场景不需要重写equals方法这个会在后面说&＃xff01;&＃xff09; ​

2.2 什么时候不需要重写equals方法

不需要实现equals方法的场景非常多&＃xff0c;我们大致的举例说明一下&＃xff1a;

• 类的每个实例唯一。比如说&＃xff1a;枚举类型&＃xff0c;枚举类型虽然也属于上面说的“值类”&＃xff0c;但是由于枚举类的每个值只会存在一个对象&＃xff0c;因此不需要重写equals方法

• 类的访问权限是私有的&＃xff08;类私有、包级私有&＃xff09;&＃xff0c;并且确保equals方法不会被调用。说白了就是其他类无法调用到这个类的equals方法

• 超类覆写的equals方法&＃xff0c;在子类仍然适用。这种情况下我们就无需再多此一举了&＃xff0c;在Java的JDK源码中&＃xff0c;set、List、Map都直接使用了超类的equals方法&＃xff0c;比如在HashSet提供的方法中&＃xff0c;并未有equals方法的实现&＃xff0c;这是因为其父类AbstractSet中覆写了equals方法&＃xff0c;且父类实现的逻辑对于子类也是可用的。

• 类本身无需提供“逻辑相等”的功能。这种情况其实非常常见&＃xff0c;比如我们在实际开发中经常写的工具类&＃xff0c;这些类的实例只是用来完成某些任务&＃xff0c;并不需要比较它们是否逻辑相等。比如Java提供的java.util.regex.Pattern类&＃xff0c;并未实现equals方法&＃xff0c;因为它觉得没人会比较两个Pattern对象是否相等。

2.3 重写equals方法需要遵守哪些规则

重写equals方法有几条看起来很简单&＃xff0c;但是实现起来几乎无法完全保证的约定&＃xff1a;

1. 自反性&＃xff08;Reflexivity&＃xff09;&＃xff1a;非null情况下&＃xff0c;x.equals(x)必须为true

2. 对称性&＃xff08;Symmetry&＃xff09;&＃xff1a;非null情况下&＃xff0c;x.equals(y) &＃61; true则y.equals(x) &＃61; true

3. 传递性&＃xff08;Transitive&＃xff09;&＃xff1a;非null情况下&＃xff0c;x.equals(y) &＃61; true && y.equals(z) &＃61; true则x.equals(z) &＃61; true

4. 一致性&＃xff08;Consistent&＃xff09;&＃xff1a;非null情况下&＃xff0c;x.equals(y) &＃61; true只要x或y其中任意一个对象不被修改&＃xff0c;那么x.equals(y) &＃61; true应该恒成立

5. 非空性&＃xff08;Non-nullity&＃xff09;&＃xff1a;x不为null的情况下&＃xff0c;x.equals(null)必须返回false

看到这五条规则是不是觉得头大&＃xff0c;平时我们在写的时候&＃xff0c;压根就没考虑过这么多条条框框&＃xff0c;只有能实现功能上的逻辑相等了就行&＃xff01;

其实我觉得这么想也不能说是完全不对&＃xff0c;因为如果一定要完完全全的按照它这个规范来&＃xff0c;那么面向对象很多功能都用不了了&＃xff0c;比如说继承。 其实Java的JDK中也是有些代码不满足上面说的这五条规范的&＃xff0c;比如我们看下如下这段代码&＃xff08;猜猜它会输出什么&＃xff1f;&＃xff09;&＃xff1a;

package com.lizba.tips;import java.sql.Timestamp;
import java.util.Date;/*** 

*    Java自带jdk equals方法的对称性测试* 

是的你没看错&＃xff0c;第一个输出了true&＃xff0c;第二个输出了false。很显然这不满足第二点&＃xff1a;对称性&＃xff08;Symmetry&＃xff09;。

Date equals to Timestamp: true
Timestamp equals to Date: false


基于这种情况&＃xff0c;Java并没有很好的办法去解决。只能说告诉你不用混用Date和Timestamp&＃xff0c;并且无论如何不要去equals比较Date和Timestamp&＃xff0c;这个在Timestamp中的类和equals方法上也是有说明的&＃xff01; ​

2.4 实现高质量equals方法的诀窍

上面聊了一些什么时候需要重写equals方法、什么时候不需要重写equals方法、重写equals方法需要遵守的规则。这里我们聊一聊实现高质量equals方法的诀窍。 在这里我将会引用java.util.AbstractSet类中的equals方法来阐述如何写一个高质量的equals方法&＃xff0c;因为小捌发现它非常经典。 ​

java.util.AbstractSet中的equals方法&＃xff1a;

public abstract class AbstractSet extends AbstractCollection implements Set {// ...public boolean equals(Object o) {if (o &＃61;&＃61; this)return true;if (!(o instanceof Set))return false;Collection c &＃61; (Collection) o;if (c.size() !&＃61; size())return false;try {return containsAll(c);} catch (ClassCastException unused)   {return false;} catch (NullPointerException unused) {return false;}}// ...}


第一点&＃xff1a;o &＃61;&＃61; this 使用&＃61;&＃61;操作符&＃xff0c;判断比较对象和当前对象的引用是否相等&＃xff0c;如果相等代表同一个对象&＃xff0c;那就直接返回true。 ​

第二点&＃xff1a;o instanceof Set 通过instanceof操作符检查参数类型是否正确&＃xff0c;如果类型都不对就不需要比较了。 ​

第三点&＃xff1a;c.size() !&＃61; size() 这是在Abstract中的特殊存在&＃xff0c;并不是所有的都需要这样比较&＃xff0c;提前比较大小的好处是无需进行每个域的比较&＃xff0c;如果大小都不相等&＃xff0c;就可以直接返回了。通常情况下&＃xff0c;这样做性能更好&＃xff01; ​

第四点&＃xff1a;containsAll(c) 对该类中的每一个域进行比较&＃xff0c;如果所有的域都相等则返回true&＃xff0c;如果不相等返回false。 ​

第五点&＃xff1a;重写hashcode 重写equals方法时一定要重写hashcode方法&＃xff0c;比如java.util.AbstractSet中重写了hashCode()方法&＃xff0c;它将每个域的hashcode进行了拼接

public int hashCode() {int h &＃61; 0;Iterator i &＃61; iterator();while (i.hasNext()) {E obj &＃61; i.next();if (obj !&＃61; null)h &＃43;&＃61; obj.hashCode();}return h;
}


第六点&＃xff1a;不要修改equals(Object o)的参数类型 这一点看似很简单&＃xff0c;但是如果你不是用IDE自动生成的equals方法&＃xff0c;而是自己手动敲得代码&＃xff0c;很容易会将Object类型&＃xff0c;改成当前类的类型&＃xff0c;这种做法是不对的哈&＃xff01;因为这不是重写&＃xff08;Override&＃xff09;&＃xff0c;这是重载&＃xff08;Overload&＃xff09;

&＃x1f447;&＃x1f3fb; 关注公众号 我们一起备战明年春招&＃x1f447;&＃x1f3fb;