摘要：總之，在編寫(xiě)單個(gè)類(lèi)的方法時(shí)比較簡(jiǎn)單，當(dāng)涉及子類(lèi)繼承時(shí)，就要多考慮一下了。另外不要忘記覆蓋方法哦。

相信讀過(guò) 《Effective Java》 的讀者都已經(jīng)知道編寫(xiě) equals 方法的作用與重要性，基本概念不多做解釋?zhuān)@里就總結(jié)一下如何編寫(xiě)正確的 equals 方法。

equals 在 Java 和 Scala 中含義相同，都需要滿(mǎn)足以下五個(gè)條件：

自反性

對(duì)稱(chēng)性

傳遞性

一致性

anyObject.equals(null) == false

現(xiàn)在我們有三個(gè)問(wèn)題：

假如我們只有一個(gè)類(lèi) Person，如何寫(xiě)？

假如 Person 類(lèi)有一個(gè)子類(lèi) Student，相互不能判斷（一定返回 false），如何寫(xiě)？相互可以判斷，如何寫(xiě)？

假如 Person 和 Student 可以相互判斷，但另一子類(lèi) Teacher 只能和同類(lèi)判斷，如何寫(xiě)？

《Effective Java》 中最后推薦的寫(xiě)法步驟是：

通過(guò) == 判斷是否是同一個(gè)對(duì)象

用 instanceof 判斷是否是正確的類(lèi)型，注意這里已經(jīng)包含了 null 的情況，所以不用多帶帶另寫(xiě)

將對(duì)象轉(zhuǎn)換成正確的類(lèi)型

對(duì)需要判斷的域分別進(jìn)行對(duì)比

需要注意，基本類(lèi)型用 == 判斷，例外是 float 用 Float.compare，double 用 Double.compare，因?yàn)橛?NaN 等特殊值存在。

上述第二步中還有另一個(gè)變種，是使用 getClass 進(jìn)行類(lèi)型判斷，這樣的話(huà)只有類(lèi)型完全一致才能返回 true，如果只是單一的類(lèi)還好，要是涉及類(lèi)之間的繼承，則違背了 Liskov Substitution Principle，所以最后書(shū)中的結(jié)論是：

There is no way to extend an instantiable class and add a value component while preserving the equals contract.

由于現(xiàn)在的 IDE 例如 IntelliJ IDEA 已經(jīng)可以自動(dòng)為我們生成 equals 方法，還可以選擇是否允許子類(lèi)判斷，是否可為 null 等判斷，所以我們就不必手動(dòng)編寫(xiě)了，但是生成的結(jié)果也是符合上面的 4 步的：

class Person{
    private String name;
    private int age;

    @Override 
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) { // 不涉及繼承，問(wèn)題 1 和 問(wèn)題 2 前半的寫(xiě)法
            return false;
        }

        Person person = (Person) o;

        if (age != person.age) {
            return false;
        }
        return name != null ? name.equals(person.name) : person.name == null;
    }
    
    @Override 
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (!(o instanceof Person)) { // 涉及繼承，使得與子類(lèi)之間也可以判斷，問(wèn)題 2 后半的寫(xiě)法
            return false;
        }

        Person person = (Person) o;

        if (age != person.age) {
            return false;
        }
        return name != null ? name.equals(person.name) : person.name == null;
    }
}

scala 中編寫(xiě)的方式大致相同，但是結(jié)合其語(yǔ)法，相比似乎又簡(jiǎn)單又繁瑣。
簡(jiǎn)單是指當(dāng)沒(méi)有子類(lèi)，或和子類(lèi)判斷一定為 false 時(shí)（違反LSP），可以這樣寫(xiě)：

class Person(val name: String, val age: Int) { 
  override def equals(other: Any): Boolean = other match { // 問(wèn)題 1 的寫(xiě)法
    case that: this.getClass == that.getClass &&
                Person => name == that.name && 
                age == that.age
    case _ => false
  }
}

繁瑣是指假如這時(shí)出現(xiàn)了一個(gè)子類(lèi) Student 且增加了一個(gè)域 sid，假如我們需要兩個(gè)類(lèi)可相互判斷，則上述方法在判斷一個(gè) Person 對(duì)象和一個(gè) Student 對(duì)象時(shí)一定會(huì)返回 false。

因此《Programming in Scala》中建議采用如下的編寫(xiě)方式：

class Person(val name: String, val age: Int) {
  def canEqual(other: Any): Boolean = other.isInstanceOf[Person]

  override def equals(other: Any): Boolean = other match { // 問(wèn)題 2 的寫(xiě)法
    case that: Person =>
      (that canEqual this) &&
        name == that.name &&
        age == that.age
    case _ => false
  }
}

class Student(override val name: String, override val age: Int, val sid: Int) extends Person(name, age){
}

上面 canEqual 方法的作用和 Java 代碼中判斷 instanceof 的作用是一致的，但比 Java 中的判斷更加靈活，比如可以限定不同子類(lèi)與父類(lèi)的判斷關(guān)系。

比如有一個(gè) Person 的子類(lèi) Teacher，我們希望它只能和 Teacher 類(lèi)進(jìn)行判斷，與 Person 和 Student 判斷都返回 false，該如何寫(xiě)呢？一種錯(cuò)誤的寫(xiě)法如下：

class Teacher(override val name: String, override val age: Int, val tid: Int) extends Person(name, age){
  override def equals(other: Any): Boolean = other match {
    case that: Teacher =>
      this.getClass == that.getClass &&
        name == that.name &&
        age == that.age
    case _ => false
  }
}

val s1 = new Student("z", 1, 2)
val t1 = new Teacher("z", 1, 2)
println(s1 == t1) // true
println(t1 == s1) // false 違反了對(duì)稱(chēng)性

正確的寫(xiě)法應(yīng)該是：

class Teacher(override val name: String, override val age: Int, val tid: Int) extends Person(name, age){
  override def canEqual(other: Any): Boolean = other.isInstanceOf[Teacher]

  override def equals(other: Any): Boolean = other match { // 問(wèn)題 3 的寫(xiě)法
    case that: Teacher =>
      super.equals(that) &&
        (that canEqual this) &&
        name == that.name &&
        age == that.age &&
        tid == that.tid
    case _ => false
  }
}

注意只覆蓋了 canEqual 方法也會(huì)違反對(duì)稱(chēng)性。在 Java 中要實(shí)現(xiàn)相同的效果，則也需要編寫(xiě)類(lèi)似的 canEqual 方法，就留給讀者自己考慮了。

總之，在編寫(xiě)單個(gè)類(lèi)的 equals 方法時(shí)比較簡(jiǎn)單，當(dāng)涉及子類(lèi)繼承時(shí)，就要多考慮一下了。

另外不要忘記覆蓋 hashcode 方法哦。