[아이템 10] equals는 일반 규약을 지켜 재정의하라

equals() 메소드 재정의를 주의하자.

equals 메소드는 재정의하기 쉬워 보이지만 곳곳에 함정이 도사리고 있다.

따라서 자칫하면 끔찍한 결과를 초래한다.

문제를 회피하는 가장 쉬운 길은 아예 재정의하지 않는 것이다.

👉🏻 equals에 대한 정의는 최상위 클래스인 Object에 정의되어 있기 때문에 자동 형변환이 지원된다.

그냥 두면 그 클래스의 인스턴스는 오직 자기 자신과만 같게 된다.

그러니 다음에서 열거한 상황 중 하나에 해당된다면 재정의하지 않는 것이 최선이다.

 

재정의하지 않는 것이 더 나은 상황들

각 인스턴스가 본질적으로 고유하다.

인스턴스가 본질적으로 고유하다라....값을 표현하는 것이 아니라 동작하는 개체를 표현하는 클래스가 여기에 해당된다.

Thread가 좋은 예로, Object의 equals 메소드는 이러한 클래스에 딱 맞게 구현되었다.

 

인스턴스의 논리적 동치성(logical equality)을 검사할 일이 없다.

논리적 동치성(logical equality)는 객체의 주소 번지가 같은지에 대한 동치가 아닌, 객체가 가지고 있는 논리적인 값의 동치를 의미한다.

굳이 재정의할 필요가 있는가....라는 의문이 드는 상황이라면 Object의 기본 equals 메소드 만으로도 충분하다.

 

상위 클래스에서 재정의한 equals가 하위 클래스에도 딱 들어맞느다.

대부분의 하위 클래스들은 상속 받은 상위 클래스의 equals 메소드를 그대로 사용하고 있기에, 하위 클래스가 상속받은 클래스라면 굳이 새로운 equals 메소드를 재정의 할 필요가 없다.

 

클래스가 private이거나 package-private이고 equals 메소드를 호출할 일이 없다.

위와 같은 경우라면 당연히 재정의 하지 않는 것이 정상이다.

만약 equals 메소드 호출을 방지해야 하는 상황이라면 다음과 같이 재정의하여 메소드 호출을 방지할 수도 있다.

@Override
public boolean equals(Object o){
	throw new AssertionError(); //호출 금지
}

 

그렇다면 equals를 언제 재정의해야 할까?

객체 식별성이 아니라 논리성 동치성을 확인해야 하는데,
상위 클래스의 equals가 논리성 동치성을 비교하도록 재정의 되어 있지 않은 경우!

 

위 comment가 하이라이트라고 치기에는 말이 너무 길지만, 

정리하자면!

객체간 구별을 하는 상황이 아닌, 객체 내 논리 값에 대한 동치를 비교해야 하는 상황에서

상위 클래스에서 마땅한 equals 메소드가 재정의 되어 있지 않은 경우에는 하위 클래스가 상위 클래스의 equals 메소드로부터

이득을 얻지 못하기에 하위 클래스에서 equals 메소드를 재정의하는 것이다.

주로 값 클래스들(Integer, String)이 여기 해당된다.

 

일반적으로 프로그래머들이 equals 메소드를 사용하는 이유는 객체의 식별성 보다는 객체 내의 논리 값의 동치를 확인하고 싶어하는 경우가 더 많을 것이므로, equals가 논리적 동치성을 확인하도록 재정의해두면, 그 인스턴스는 값을 비교하길 원하는 프로그래머의 기대에 부응함은 물론 Map의 키와 Set의 원소로 사용할 수 있게 된다.

 

값 클래스에 많이 사용된다 하더라도! 값이 같은 인스턴스가 둘 이상 만들어지지 않음을 보장하는 인스턴스 통제 클래스라면 equals를 재정의 하지 않아도 된다. (Enum도 여기에 해당된다)

👉🏻어차피 논리적으로 같은 인스턴스가 2개 이상 만들어지지 않으니 논리적 동치성과 객체 식별성이 사실상 똑같은 의미가 된다.

👉🏻Object의 equals 메소드가 논리적 동치성까지 보장해준다고 볼 수 있다.

 

equals 메소드를 재정의할 때, 반드시 따라야 할 일반 규약

• 반사성(reflexivity) : null이 아닌 모든 참조 값 x에 대해, x.equals(x)는 true이다
• 대칭성(symmetry): null이 아닌 모든 참조 값 x, y에 대해 x.equals(y)가 true이면 y.equals(x)도 true이다
• 추이성(transitivity): null이 아닌 모든 참조 값 x,y,z에 대해, x.equals(y)가 true이고, y.equals(z)가 true이면 x.equals(z) 또한 true이다
• 일관성(consistency): null이 아닌 모든 참조 값 x, y에 대해, x.equals(y)를 반복해서 호출하면 항상 true를 반환하거나 항상 false를 반환한다.
• null아님(nonNull): null이 아닌 모든 참조 값 x에 대해, x.equals(null)은 false이다.

한 클래스의 인스턴스는 다른 곳으로 빈번히 전달된다.

그리고 컬렉션 클래스들을 포함해 수많은 클래스는 전달받은 객체가 equals규약을 지킨다고 가정하고 동작한다.

 

그렇다면 Object 명세에서 말하는 동치관계란 무엇일까? 쉽게 말해, 집합을 서로 같은 원소들로 이뤄진 부분 집합으로 나누는 연산이다. 이 부분 집합을 동치류(equivalence class:동치 클래스)라 한다.

equals 메소드가 쓸모 있으려면 모든 원소가 같은 동치류에 속한 어떤 원소와도 서로 교환할 수 있어야 한다.

다섯 요소들을 요약하자면 다음과 같다.

반사성은 단순히 말하면 객체는 자기 자신과 같아야 한다는 뜻이다.

대칭성은 두 객체는 서로에 대한 동치 여부에 똑같이 답해야 한다는 듯이다.

추이성은 첫 번째 객체와 두 번째 객체가 같고, 두 번째와 세 번째가 같다면 첫번째와 세번째도 같아야 한다는 뜻이다.

일관성은 두 객체가 같다면 (어느 하나 혹은 두 객체 모두가 수정되지 않는 한) 앞으로도 영원히 같아야 한다는 뜻이다.

null-아님은 이름처럼 모든 객체가 null과 같지 않아야 한다는 뜻이다.

 

주의해야 할 것 중 하나가

구체 클래스를 확장해 새로운 값을 추가하면서 equals 규약을 만족시킬 방법은 존재하지 않는다.

리스코프 치환 원칙(Liskov substitution principle)에 따르면, 어떤 타입에 있어 중요한 속성이라면 그 하위 타입에서도 마찬가지로 중요하다.

 

구체 클래스의 하위 클래스에서 값을 추가할 방법은 없지만 괜찮은 우회 방법이 하나 있다.

"상속 대신 컴포지션을 사용하라"라는 방법이다. 이는 아이템 18에서 상세히 다룬다.

 

일관성 측면에서,

불변 객체는 한 번 다르면 끝까지 달라야 한다. 클래스를 작성할 때는 불변 클래스로 만드는 게 나을지를 심사숙고하자.

클래스가 불변이든 가변이든 equals의 판단에 신뢰할 수 없는 자원이 끼어들게 해서는 안된다.

equals는 항시 메모리에 존재하는 객체만을 사용한 결정적 계산만 수행해야 한다.

 

null 아님 측면에서,

굳이 null인지를 check하는 equals 메소드를 오버라이딩 할 필요는 없다.

생성된 인스턴스가 형변환을 통하여 일치하는 인스턴스인지 확인하는 로직을 따르면 null 검사를 명시적으로 하지 않아도 null이 아닌 객체는 equals에서 false를 반환하게 된다.

 

---

그렇다면 지금까지의 내용을 종합해서 양질의 equals 메소드 구현하는 방법을 단계별로 정리하면 다음과 같다.

1. == 연산자를 사용해 입력이 자기 자신의 참조인지 확인한다. 이는 단순한 성능 최적화 용으로, 비교 작업이 복잡한 상황일 때 값어치를 할 것이다.
2. instanceOf 연산자로 입력이 올바른 타입인지 확인한다. 
3. 입력을 올바른 타입으로 형변환한다. 앞서 2번 단계가 수행되었다면 이 단계는 100% 성공한다.
4. 입력 객체와 자기 자신의 대응되는 '핵심' 필드들이 모두 일치하는지 하나씩 검사한다. 2단계에서 인터페이스를 사용했다면 입력의 필드 값을 가져올 대도 그 인터페이스의 메소드를 사용해야 한다.

 

추가적으로 마지막 주의사항은 다음과 같다

• equals를 재정의할 땐 hashCode도 반드시 재정의하자
• 너무 복잡하게 해결하려 들지 말자.
• Object 외의 타입을 매개변수로 받는 equals 메소드는 선언하지 말자.

---

핵심 정리

꼭 필요한 경우가 아니면 equals를 재정의하지 말자. 많은 경우에 Object의 equals가 여러분이 원하는 비교를 정확히 수행해준다. 재정의해야 할 때는 그 클래스의 핵심 필드 모두를 빠짐없이, 다섯가지 규약을 확실히 지켜가며 비교해야 한다.