Java集合——3.编写equals方法

目录

• Java中的equals方法
  • equals方法的作用
    • ==与equals的区别
  • equals方法的实现规范
  • 正确实现equals方法的步骤
  • 常见错误及解决方案
    • 错误1：null.equals(null)
  • 总结

---

Java中的equals方法

在Java编程中，判断两个对象是否相等是一个常见需求。无论是在集合中查找元素，还是比较对象内容，都离不开equals方法。

equals方法的作用

equals方法用于判断两个对象是否"相等"，但这里的"相等"并非指引用相同（即==的含义），而是指两个对象的内容或逻辑状态是否一致。

在集合操作中：

• List.contains(Object o)：通过equals判断是否包含指定元素
• List.indexOf(Object o)：通过equals查找元素位置
• Set：通过equals确保元素唯一性
• Map：通过equals判断键的相等性

==与equals的区别

• ==：判断两个引用是否指向同一个对象（内存地址相同）
• equals：判断两个对象的内容或逻辑状态是否相等

示例：

String s1 = new String("hello");
String s2 = new String("hello");

System.out.println(s1 == s2);      // false（不同对象）
System.out.println(s1.equals(s2)); // true（内容相同）

equals方法的实现规范

要正确实现equals方法，必须遵循以下规范：

1. 自反性：对于任何非null对象x，x.equals(x)必须返回true
2. 对称性：对于任何非null对象x和y，若x.equals(y)为true，则y.equals(x)也必须为true
3. 传递性：对于任何非null对象x、y、z，若x.equals(y)和y.equals(z)为true，则x.equals(z)也必须为true
4. 一致性：只要对象状态未变，多次调用equals应返回相同结果
5. 非空性：任何非null对象x，x.equals(null)必须返回false

这些规范看似复杂，但只要按照标准模式实现，就能满足所有要求。

正确实现equals方法的步骤

以Person类为例，我们需要根据业务逻辑定义"相等"的标准（如姓名和年龄都相同则认为相等）：

import java.util.Objects;

class Person {
    private String name;
    private int age;

    public Person(String name, int age) {
        this.name = name;
        this.age = age;
    }

    // 实现equals方法
    @Override
    public boolean equals(Object o) {
        if (o instanceof Person p) {
        return Objects.equals(this.name, p.name) && this.age == p.age;
    }
    return false;
    }
}

常见错误及解决方案

错误1：null.equals(null)

null 是字面量，不是对象，不能调用方法，因此 null.equals(null) 会编译错误NullPointerException。

解决方案：应使用 Objects.equals() 方法来安全地比较两个可能为 null 的对象，避免调用 null.equals()。

总结

• 理解equals与==的本质区别：equals判断内容相等，==判断引用相同
• 标准实现步骤：
  1. 用instanceof判断传入的待比较的Object是不是当前类型，如果是，继续比较，否则，返回false；
  2. 对引用类型用Objects.equals()比较，对基本类型直接用==比较。
• 引用类型比较应使用Objects.equals处理，省去了判断null的麻烦。两个引用类型都是null时它们也是相等的。