浅谈java 重写equals方法的种种坑

重写java object类的equals方法

  • 覆盖equals方法请遵守约定
  • 什么情况下要覆盖equals方法
  • 容易违反的对称性
  • 不易察觉的传递性

覆盖equals请遵守通用约定

似乎覆盖equals方法看起来似乎是一件平常甚至极其简单的事情,
但是有许多覆盖方式会导致错误,并且会表现出超出预期的行为,
而有可能数小时也无法找到错误的位置。(比如说把参数改成了非Object类型)

1. 类的每一个实例在本质上都是唯一的

( 从内存的角度来讲是这样的),对于代表活动而不是值(value)的类来说更是如此,
 例如Thread。
 Object提供equals的实现对于这些类来说是正确的行为

2. 类没有必要提供“逻辑相等”的测试功能

3.超类已经覆盖了equals方法,超类的行为对于子类来说同样也是合适的

4.类是私有的或者是包级私有的,可以确定它的equals方法永远不会被外界调用

如果非常想规避风险,可以覆盖equals方法,
来确保来自Object或者超类的方法永远不会被意外调用。

那么什么时候应该覆盖equals方法

如果类具有自己特有的“逻辑相等”概念(不同于对象等同的概念)
而且超类没有覆盖equals方法。这通常属于"值类"(value class)的情形

例如 一个圆 Circle类,内有一个私有的成员变量radius半径
可以认为,radius相等代表了两个实例在逻辑上相等(或许可以再加上坐标)

再看String类,程序员在利用equals方法比较值对象的引用时,
更希望知道它们逻辑上是否相等,而不希望知道它们到底是不是同一个对象

为满足要求,不仅必须覆盖equals方法,
而且这样做也使得这个类的实例
可以被用作映射表 (map) 的键 (key) ,或者集合set的元素,
使其表现出符合预期的行为

注意:有一种“值类”不需要覆盖equals方法
即实例受控,甚至于单例模式,
确保每个实例的“值”至多只存在一个对象,甚至仅能存在一个实例
(好像太严格了,不过只能存在一个对象有什么可比的呢,就像客户端只能有一个连接服务器的socket类实例一样)

覆盖equals时请遵守通用约定

自反性,对称性以及传递性是最基础的约定

x.equals(x) = x.equals(x) (好像很傻)
x.equals(y) = y.equals(x)(这也是最容易出现问题的地方)
x.equals(y) = y.equals(z) 那么x.equals(z) == true

一致性:

对于任何非null引用值x和y,只要equals方法的比较操作在对象中引用的信息没有被修该,多次调用x.equals(y)返回的结果一致

对于任何非null的引用值x,x.equals(null)必须返回false
下面是一个不区分大小写字符串类的定义(注意 是反例!!违反了对称性)

public class CaseInsensitiveString {

 private final String s;//存有不可变字符串s

 public CaseInsensitiveString(String s) {
  this.s = s;
 }

 @Override //重写equals方法,请注意参数为Object
 public boolean equals(Object o) {
  if (o instanceof CaseInsensitiveString)//判断传入的是同类型的参数
  {
   return s.equalsIgnoreCase(((CaseInsensitiveString) o).s);
  }
  if (o instanceof String) {
   return s.equalsIgnoreCase(((String) o));
  }
  return false;
 }
}

注意:equals方法中的参数Object o,一定不要定义成其他类型!!

在绝大多数情况都要加上一句instanceof 来给o 赋予类型!!!

这个类的equals方法看起来设计的很有想法,不仅和自身比较,也希望和String类型进行比较。

 //也确实看起来实现了功能
 public static void main(String[] args)
 {
  //不区分大小写的字符串Point
  CaseInsensitiveString cis = new CaseInsensitiveString("Point");
  String s = "point";
  System.out.printf(cis.equals(s)+"");//true

 }

但是 s.equals(cis)却返回了false

 //s.equals(cis)却返回了false
 public static void main(String[] args)
 {
  CaseInsensitiveString cis = new CaseInsensitiveString("Point");
  String s = "point";
  System.out.printf(cis.equals(s)+"");//true
  System.out.printf(s.equals(cis)+"");//false
 }

虽然CaseInsensitiveString类中的equals方法知道普通的字符串对象
但是String类中的equals方法并不知道不区分大小写的字符串,
导致了超出预期的错误
显然违反了对称性。

一旦违反了equals约定,当其他对象面对你的对象是,你完全不知道这些对象的行为会怎样

为了解决这个问题,只需要把企图和String互相操作的代码删除就可以了

public class CaseInsensitiveString {

 private final String s;//存有不可变字符串s

 public CaseInsensitiveString(String s) {
  this.s = s;
 }

 @Override //重写equals方法,请注意参数为Object
 public boolean equals(Object o) {
  if (o instanceof CaseInsensitiveString)//判断传入的是同类型的参数
  {
   return s.equalsIgnoreCase(((CaseInsensitiveString) o).s);
  }
  /*删除掉的与String互操作的代码*/
  return false;
 }

}

考虑这样一种情况

有一个坐标类,内有成员变量x和y
并提供equals方法

public class Point {
 private final int x;
 private final int y;
 public Point(int x,int y)
 {
  this.x=x;
  this.y=y;
 }
 @Override
 public boolean equals(Object o )
 {
  if(o instanceof Point)
  {
   Point p = (Point)o;
   return (this.x == p.x && this.y==p.y);
  }
  return false;
 }
}

好像简单到不能再简单的定义
那么扩展(继承)一下,为这个点添加颜色信息

public class ColorPoint extends Point{
 private final Color color;
 public ColorPoint(int x,int y,Color color)
 {
  super(x,y);
  this.color=color;
 }
}

现在考虑一下

equals方法是什么样的呢?
如果子类ColoePoint完全不提供equals方法,而是直接使用父类的equals方法
在equals做比较的时候颜色信息就被忽略掉了。
虽然这么做不会违反equals约定
但显然是无法接受的。

那么就重写一个equals方法。只有当坐标点x,y相同且颜色也相同时
equals才返回true

public class ColorPoint extends Point{
 private final Color color;
 public ColorPoint(int x,y);
  this.color=color;
 }
 @Override
 public boolean equals(Object o)
 {
  if(o instanceof ColorPoint)
  {
   return (super.equals(o)&& this.color==
   ( (ColorPoint) o ).color);//使用父类的equals方法
  }
  return false;
 }
}

这个方法的问题在于,比较普通点(没有颜色的Point实例)和
有色点(ColorPoint实例)比较,以及相反的情况时可能会得到不同的结果
前一种忽略的颜色信息,而后一种总时返回false(因为参数类型不正确)

 public static void main(String[] args)
 {
  Point p = new Point(1,2);
  ColorPoint cp = new ColorPoint(1,2,Color.RED);
  System.out.printf(p.equals(cp)+"");//true
  System.out.printf(cp.equals(p)+"");//false

 }

可以尝试以ColorPoint.equals在进行“混合颜色比较时”忽略颜色信息
但这样做确实提供了对称性,但却牺牲了传递性。
那该怎么解决???

事实上,这是面向对象语言中关于等价关系的一个基本问题。
我们无法在扩展可实例化的类的同时,既增加新的组件,同时又保留equals约定
虽然没有一种令人满意的办法既可以扩展可实例化的类,又增加组件,但还有一种不错的方法。复合优先于继承

我们不再让ColorPoint继承Point,
而是在ColorPoint类中添加一个私有的Point域
以及一个公有的视图(view)方法
此(view)方法返回一个与该色点处在相同位置的普通Point对象。

public class ColorPoint{
 private final Color color;
 private final Point point;
 public ColorPoint(int x,Color color)
 {
  point = new Point(x,y);
  this.color=color;
 }
 /*view*/
 public Point asPoint()
 {
  return point;
 }

 @Override
 public boolean equals(Object o)
 {
  if(o instanceof ColorPoint)
  {
   ColorPoint cp =(ColorPoint)o;
   return this.point.equals(cp.point)&&
   this.color.equals(cp.color);//调用Point以及Color类的equals方法
  }
  //那么有色点与无色点会被判断为不相同而返回false
  return false;
 }
}

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持我们。

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。

相关推荐


本文从从Bitcask存储模型讲起,谈轻量级KV系统设计与实现。从来没有最好的K-V系统,只有最适合应用业务实际场景的系统,做任何的方案选择,要结合业务当前的实际情况综合权衡,有所取有所舍。
内部的放到gitlab pages的博客,需要统计PV,不蒜子不能准确统计,原因在于gitlab的host设置了strict-origin-when-cross-origin, 导致不蒜子不能正确获取referer,从而PV只能统计到网站的PV。 为了方便统计页面的PV,这里简单的写了一个java程
PCM 自然界中的声音非常复杂,波形极其复杂,通常我们采用的是脉冲代码调制编码,即PCM编码。PCM通过抽样、量化、编码三个步骤将连续变化的模拟信号转换为数字编码。 采样率 采样频率,也称为采样速度或者采样率,定义了每秒从连续信号中提取并组成离散信号的采样个数,它用赫兹(Hz)来表示。采样频率的倒数
本文介绍如何离线生成sst并在线加载,提供一种用rocksdb建立分布式kv系统替换mongodb的思路
验证用户输入是否正确是我们应用程序中的常见功能。Spring提供了`@Valid`和@`Validated`两个注解来实现验证功能,本文详细介绍 [@Valid]和[@Validated]注解的区别 。
引入pdf2dom <dependency> <groupId>net.sf.cssbox</groupId> <artifactId>pdf2dom</artifactId> <version>1.8</version&
grafana 是一款非常优秀的可视化报表工具,有设计精良的可视化工具,今天来聊一聊如何将grafana集成到自己的应用中。 原理是: grafana允许iframe访问,开启auth.proxy, java 后端鉴权后代理grafana 前端通过iframe访问后端代理过的grafana graf
介绍 Call Graph是一款IDEA插件,用于可视化基于IntelliJ平台的IDE的函数调用图。 这个插件的目标是让代码更容易理解,有助于读懂和调试代码。当前只支持Java。针对Typescript、Javascript或Python工具,可以使用作者的另外一款工具Codemap(https:
原理 通过线程安全findAndModify 实现锁 实现 定义锁存储对象: /** * mongodb 分布式锁 */ @Data @NoArgsConstructor @AllArgsConstructor @Document(collection = "distributed-loc
Singleton 单例模式 单例模式是确保每个应用程序只存在一个实例的机制。默认情况下,Spring将所有bean创建为单例。 你用@Autowired获取的bean,全局唯一。 @RestController public class LibraryController { @Autowired
pipeline 分布式任务调度器 目标: 基于docker的布式任务调度器, 比quartzs,xxl-job 更强大的分布式任务调度器。 可以将要执行的任务打包为docker镜像,或者选择已有镜像,自定义脚本程序,通过pipeline框架来实现调度。 开源地址: https://github.c
python训练的模型,转换为onnx模型后,用python代码可以方便进行推理,但是java代码如何实现呢? 首先ONNX 推理,可以使用`onnxruntime` ```xml com.microsoft.onnxruntime onnxruntime 1.15.1 ``` 另外,训练的模型需要
要获取内网地址,可以尝试连接到10.255.255.255:1。如果连接成功,获取本地套接字的地址信息就是当前的内网IP。 python实现: ```python import socket def extract_ip(): st = socket.socket(socket.AF_INET, s
为什么要有索引 gremlin 其实是一个逐级过滤的运行机制,比如下面的一个简单的gremlin查询语句: g.V().hasLabel("label").has("prop","value") 运行原理就是: 找出所有的顶点V 然后过滤出
最近在分析一个应用中的某个接口的耗时情况时,发现一个看起来极其普通的对象创建操作,竟然每次需要消耗 8ms 左右时间,分析后发现这个对象可以通过对象池模式进行优化,优化后此步耗时仅有 0.01ms。
点赞再看,动力无限。Hello world : ) 微信搜「 程序猿阿朗 」。 本文 Github.com/niumoo/JavaNotes 和 未读代码网站 已经收录,有很多知识点和系列文章。 此篇文章介绍 Java JMX 技术的相关概念和具体的使用方式。 当前文章属于Java 性能分析优化系列
如何将Java JAR 转化为 win/mac/linux 独立可执行程序?不需要预装 JRE 运行?
点赞再看,动力无限。 微信搜「 程序猿阿朗 」。 本文 Github.com/niumoo/JavaNotes 和 未读代码博客 已经收录,有很多知识点和系列文章。 Java 19 在2022 年 9 月 20 日正式发布,Java 19 不是一个长期支持版本,直到 2023 年 3 月它将被 JD
点赞再看,动力无限。Hello world : ) 微信搜「 程序猿阿朗 」。 本文 Github.com/niumoo/JavaNotes 和 未读代码博客 已经收录,有很多知识点和系列文章。 前言 Java 反编译,一听可能觉得高深莫测,其实反编译并不是什么特别高级的操作,Java 对于 Cla
JSON 对于开发者并不陌生,如今的 WEB 服务、移动应用、甚至物联网大多都是以 **JSON** 作为数据交换的格式。学习 JSON 格式的操作工具对开发者来说是必不可少的。这篇文章将介绍如何使用 **Jackson** 开源工具库对 JSON 进行常见操作。