Java equals() 與 toString() 方法深度解析與最佳實踐

前言

java.lang.Object 定義了所有 Java 對象的公共行為，其中 equals() 和 toString() 是最常被覆寫的兩個方法。正確理解並實現它們，是編寫高質量 Java 代碼的基礎。

一、默認行為分析

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

public class Demo {
    public static void main(String[] args) {
        Person p = new Person("lixin", 27);
        Person q = new Person("jingxiaoqing", 21);

        System.out.println(p.equals(q));  // false - 默認比較引用地址
        System.out.println(p.toString()); // Person@15db9742 - 默認 類名@哈希碼
    }
}

• equals()：默認使用 == 比較對象引用，即內存地址。
• toString()：默認返回 getClass().getName() + "@" + Integer.toHexString(hashCode())，調試價值極低。

二、覆寫 equals() 規約與實現

1. 五大規約（JLS）

1. 自反性：x.equals(x) 返回 true
2. 對稱性：x.equals(y) 返回 true ⇒ y.equals(x) 返回 true
3. 傳遞性：x.equals(y) 且 y.equals(z) ⇒ x.equals(z)
4. 一致性：多次調用結果不變，前提是用於比較的信息未修改
5. 非空性：x.equals(null) 返回 false

2. 標準實現模板

@Override
public boolean equals(Object obj) {
    if (this == obj) return true;                    // 同一引用
    if (obj == null || getClass() != obj.getClass()) return null; // 空檢查 & 類型檢查
    Person other = (Person) obj;
    return Objects.equals(name, other.name) && age == other.age; // 核心字段比較
}

關鍵點：

• 參數類型必須是 Object，否則是重載而非覆寫。
• 使用 Objects.equals() 安全處理 null 值（Java 7+）。
• 基本類型直接 ==，引用類型用 equals()。
• 覆寫 equals() 必須 覆寫 hashCode()，否則無法在 HashSet/HashMap 中正常工作。

3. hashCode() 配套實現

@Override
public int hashCode() {
    return Objects.hash(name, age);
}

三、覆寫 toString() 最佳實踐

1. 標準格式

推薦格式：ClassName[field1=value1, field2=value2, ...]

@Override
public String toString() {
    return "Person[name=" + name + ", age=" + age + "]";
}
// 或使用 Java 9+ Objects.toString()
return "Person[" + "name=" + name + ", age=" + age + "]";

2. 實用技巧

• 調試神器：IDE 變量面板、日誌框架、異常堆棧自動調用 toString()。
• 避免循環引用：雙向關聯對象（如 Parent-Child）需防止無限遞歸，可用 @ToString.Exclude (Lombok) 或手動判斷。
• 敏感字段脫敏：密碼、Token 等字段返回 **** 或省略。
• 集合/數組美化：Arrays.toString(arr)、List.toString() 已內部實現良好格式。

四、IDE 自動生成與 Lombok 簡化

1. IDEA/Eclipse 生成

右鍵 → Generate → equals() and hashCode() / toString()，勾選相關字段即可。

2. Lombok 註解 (強烈推薦)

@Data // 包含 @EqualsAndHashCode + @ToString + @Getter/@Setter/@RequiredArgsConstructor
@EqualsAndHashCode(of = {"name", "age"}) // 指定比較字段
@ToString(exclude = {"password"})       // 排除敏感字段
public class User {
    private String username;
    private String password;
    private int age;
}

編譯期自動生成標準實現，消除樣板代碼，減少錯誤。

五、常見錯誤與避坑

六、總結

• equals() 定義業務邏輯上的「相等」，核心是選擇唯一標識字段（如 ID）或全字段比較（值對象）。
• toString() 服務於「可觀測性」，應清晰、完整、安全地展示對象狀態。
• 善用 Objects 工具類與 Lombok，讓代碼簡潔、正確、可維護。
• 將覆寫這兩個方法作為實體類、值對象、DTO 的標準配置，養成肌肉記憶。

細節決定質量，從 equals 和 toString 開始，寫出專業的 Java 代碼。