【Java集合类之为List编写equals()方法】

Java集合类之为List编写equals()方法

廖雪峰java教程学习笔记

---

本博客是基于廖雪峰java教程写的学习笔记

---

前言

本人计算机小白一枚，写博客的原因一是为了让自己能够更好地理解知识点，加强记忆，二是为了让有需要的同学康康，三是为了能够结交到有相同兴趣的小伙伴，大家一起加油！！！然后本博客只是对自己在教程中不熟悉的地方做一个记录，所以并不全面。

---

一、为什么要编写equals()方法

List提供了boolean contains(Object o)方法来判断List是否包含某个指定元素，此外，int indexOf(Object o)方法可以返回某个元素的索引，如果元素不存在，就返回-1。
但是要想正确的使用这些方法，就必须要正确地覆写equals()方法，否则放进去的实例就查找不到。不过对于String、Integer这些对象，因为Java标准库已经正确实现了equals()方法，所以我们不需要覆写equals()方法

二、如何编写equals()方法

首先，equals()方法要求我们必须满足以下条件：

• 自反性：对于非null的x来说，x.equals(x)必须返回true；
• 对称性：对于非null的x和y来说，如果x.equals(y)为true，则y.equals(x)也必须为true；
• 传递性：对于非null的x、y和z来说，如果x.equals(y)为true，y.equals(z)也为true，那么x.equals(z)也必须为true；
• 一致性：对于非null的x和y来说，只要x和y状态不变，则x.equals(y)总是一致地返回true或者false；
• 对null的比较：即x.equals(null)永远返回false。

下面提供一个例子以供参考：

public class Person {
	public String name;
	public int age;
}

首先，我们要知道对于这个类的“相等”的逻辑含义，这里，我们认为只要name和age相等，我们就认为两个Person实例相等。
因此，我们这样编写equals()方法：

public boolean equals(Object o) {
    if (o instanceof Person) {
        Person p = (Person) o;
        return this.name.equals(p.name) && this.age == p.age;
    }
    return false;
}

对于引用字符的比较，我们使用equals()方法，对于基本类型字段的比较，我们使用==。

但是这里也有一个问题，就是如果this.name为null，那么equals()方法会报错，因此需要修改成如下形式：

public boolean equals(Object o) {
    if (o instanceof Person) {
        Person p = (Person) o;
        boolean nameEquals = false;
        if (this.name == null && p.name == null) {
            nameEquals = true;
        }
        if (this.name != null) {
            nameEquals = this.name.equals(p.name);
        }
        return nameEquals && this.age == p.age;
    }
    return false;
}

但是如果Person有好几个引用类型的字段，上面的写法就太复杂了，要简化引用类型的比较，我们使用Objects.equals()静态方法：

public boolean equals(Object o) {
	if (o instanceof Person) {
		Person p = (Person) o;
		return Objects.equals(this.name,p.name) && this.age == p.age;
	}
	return false;
}

最后，我们来总结一下equals()方法的正确编写方法：

1. 先确定实例“相等”的逻辑，即哪些字段相等，就认为实例相等；
2. 用instanceof判断传入的待比较的Object是不是当前类型，如果是，继续比较，否则，返回false；
3. 对引用类型用Objects.equals()比较，对基本类型直接用==比较。

---

总结

提示：这里对文章进行总结：
例如：以上就是关于Java中对于List的equals()方法编写的要点。