Javaのequalsメソッドを徹底解説！使い方やオーバーライド方法まで -

Javaプログラミングでは、オブジェクト間の等価性を判断する際に、equalsメソッドが欠かせません。

この記事では、equalsメソッドの使い方やオーバーライド方法について詳しく解説します！

オブジェクト同士の比較を行う際の基本となる知識を、しっかりと押さえましょう！

equalsメソッドとは
equalsメソッドの使い方
equalsメソッドのオーバーライド
hashCodeメソッドとの関係
まとめ
追伸

equalsメソッドとは

equalsメソッドは、JavaのObjectクラスに定義されているメソッドで、オブジェクト間の等価性を判断するために使用されます。”==”演算子では、オブジェクトの参照が同じかどうかを判断しますが、equalsメソッドを使うことで、オブジェクトの内容が等しいかどうかを判断することができます。

equalsメソッドの使い方

equalsメソッドは以下のように使用します。

obj1.equals(obj2);

このコードでは、obj1とobj2という2つのオブジェクトが等しいかどうかを判断しています。等しい場合はtrueを、そうでない場合はfalseを返します。

equalsメソッドのオーバーライド

Objectクラスのデフォルトのequalsメソッドは、”==”演算子と同じく、オブジェクトの参照が同じかどうかを判断します。

そのため、独自のクラスでオブジェクトの内容が等しいかどうかを判断するためには、equalsメソッドをオーバーライドする必要があります。

@Override
public boolean equals(Object obj) {
    // オブジェクトが同じクラスのインスタンスであることを確認
    if (!(obj instanceof MyClass)) {
        return false;
    }
    // オブジェクトをキャストし、メンバ変数を比較
    MyClass other = (MyClass) obj;
    return this.member1.equals(other.member1) && this.member2 == other.member2;
}

この例では、

equalsメソッドをオーバーライドし、オブジェクトの内容が等しいかどうかを判断しています。

hashCodeメソッドとの関係

Javaのオブジェクトは、ハッシュベースのコレクション（例: HashMapやHashSet）に格納する際に、hashCodeメソッドを利用してハッシュコードを生成します。equalsメソッドをオーバーライドした場合、hashCodeメソッドも同時にオーバーライドすることが推奨されます。これは、equalsメソッドが等しいと判断したオブジェクトは、hashCodeメソッドによって生成されるハッシュコードも等しくなければならないためです。

hashCodeメソッドのオーバーライド例:

@Override
public int hashCode() {
    int result = 17;
    result = 31 * result + member1.hashCode();
    result = 31 * result + Integer.hashCode(member2);
    return result;
}

この例では、オーバーライドされたequalsメソッドに対応するように、hashCodeメソッドもオーバーライドしています。

結果として、

equalsメソッドで等しいと判断されるオブジェクトは、同じハッシュコードを持つようになります。