Item 10. equals는 일반 규약을 지켜 재정의하라

equals 메서드는 재정의하기 쉬워 보이지만 고려해야 할 것들이 많아 생각처럼 쉽지가 않다. 가능하면 재정의하지 않는 것을 권장한다.
아래의 상황 중 하나라도 해당된다면 재정의하지 않는 것을 추천한다.

• 각 인스턴스가 본질적으로 고유하다. 값(상태)을 표현하는 객체가 아닌 동작하는 개체를 표현하는 클래스가 여기에 해당된다. ex)Thread
• 인스턴스의 '논리적 동치성(logical equality)'을 검사할 일이 없다. 내부 값의 세부적인 비교가 필요하지 않다면 재정의 할 필요가 없다.
• 상위 클래스에서 재정의한 equals가 하위 클래스에도 딱 들어맞는다.
• 클래스가 private이거나 pakage-private이고 equals 메서드를 호출할 일이 없다. 아예 equals를 호출할 일이 없다면 아래와 같이 구현해두자.

@Override public boolean equals(Object o){
    throw new AssertionError();
}

호출하면 바로 에러를 던져버린다.

그러면 equals를 재정의할 때는 언제인가? 바로 논리적 동치성을 확인해야 할 때이다. String, Integer 등 값을 표현하는 클래스로 내부적인 값들을 비교할 때 재정의가 필요하다.

다음은 equals를 재정의할 때 반드시 지켜야할 일반 규약이다.

• 반사성(relexivity): 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.queals(z)도 true다
• 일관성(consistency): null이 아닌 모든 참조 값 x,y에 대해, x.equals(y)를 반복해서 호출하면 항상 true를 반환하거나 false를 반환한다.
• null-아님: null이 아닌 모든 참조 값 x에 대해 x.equals(null)은 false다.

이 규약들은 지켜져야 한다. 그렇지 않으면 컬렉션 클래스들은 이 규약이 지켰다는 가정하에 움직이기 때문에 예기치 못한 상황이 만들어질 것이다.
그러면 일반 규약에 다섯가지를 한번 살펴보자.

1. 반사성

객체는 자기 자신과 같아야 한다는 뜻이다. equals에 자신을 비교하면 항상 참이 나와야한다. 너무나 당연한 것이기 때문에 넘어가겠다.

2. 대칭성

두 객체는 서로에 대해서 항상 똑같은 결과가 나와야 한다. 아래는 대소문자를 구별하지 않는 문자열을 구현한 클래스이다.

public final class CaseInsensitiveString {
    private final String s;
    
    public CaseInsensitiveString(String s){
    	this.s = Objects.requireNonNull(s);
    }
    
    // 대칭성 위배
    @Override
    public boolean equals(Object o) {
    	if(o instanceof CaseInsensitiveString)
        	return s.equalsIgnoreCase((CaseInsensitiveString) o).s);
        if(o instanceof String)
        	return s.equalsIgnoreCase((String) o);
        return false;
    }
}

위의 코드를 한번 보자. CaseInsensitiveString 클래스를 String과 값을 비교하면 true로 나올 것이다. 하지만 그 반대의 경우는 어떨까. String은 equals 메소드에 CaseInsensitiveString를 정의하지 않았기 때문에 false로 나올 것이다.
이 부분에서 대칭성을 위반한다.
그렇기 때문에 아래와 같이 형변환을 통해서 접근하는게 더 간단하고 깔끔하다.

public boolean equals(Object o) {
    return o instanceof CaseInsensitiveString && ((CaseInsensitiveString) o).s.(equalsignoreCase(s);
}

3. 추이성

첫 번째 객체와 두 번째 객체가 같고, 두 번째 객체와 세 번째 객체가 같다면, 첫 번째 객체와 세 번째 객체도 같아야 한다는 뜻이다.
예를 들어보자. Point 클래스에 내부 값으로 int형 x,y가 있다고 하자. 그리고 Point를 상속받고 색상을 값을 추가한 ColorPoint에는 내부적으로 x,y,color가 있다.
상식적으로 봐도 Point와 ColorPoint 두 개를 비교하면 color 값이 Point에는 존재하지 않기 때문에 한쪽만 true가 나올 것이다.
그러면 아래와 같이 바꾸면 해결될까?

@Override public boolean equals(Object o) {
    if(!(o instanceof Point))
    	return false;
    
    // o가 Point라면 Point의 equals로 색상을 빼고 비교한다.
    if(!(o instanceof ColorPoint))
    	return o.equals(this);
        
    // o가 ColorPoint면 색상까지 비교한다.
    return super.equals(o) && ((ColorPoint) o).color == color;    
}

위의 코드는 Point와 ColorPoint의 비교를 해결해준다(대칭성). 하지만 추이성을 깨버린다.

ColorPoint p1 = new ColorPoint(1,2, Color.RED);
Point p2 = new Point(1,2);
ColorPoint p3 = new ColorPoint(1,2, Color.BLUE);

p1 == p2 이고 p2 == p3 라면 p1 == p3여야 하지만 색상까지 비교하기 때문에 p1 != p3가 된다.(추이성 위반)

그러면 해법은 무엇일까? 구체 클래스를 확장해 새로운 값을 추가하면서 equals 규약을 만족시킬 방법은 존재하지 않는다. 다른 방법이 있긴 하지만 가능하면 재정의 하지말자.

4. 일관성

가변 객체의 경우 비교 시점에 따라 서로 다른 결과가 나올 수 있다. 하지만 불변 객체의 경우 이 일관성을 반드시 지켜야한다. 같다고 나오면 항상 같아야하며 다르다고 나오면 항상 달라야 한다.
그렇기 때문에 신뢰할 수 없는 자원을 내부적으로 가지고 있으면 안된다. 예를 들어, java.net.URL의 equlas는 주어진 URL과 매핑된 IP 주소를 이용해서 비교한다. 하지만 호스트 이름과 IP 주소의 매핑은 외부 네트워크를 통해서 이루어지며 변동이 이루어질 수 있기 때문에 그 결과가 항상 같다고 볼 수 없다.
그러니 항상 메모리에 존재하는 객체만을 사용해야 한다.

5. null-아님

간단하게 말하면 모든 객체가 null과 같지 않아야 한다는 뜻이다. 그렇다고 equals에 null을 확인하는 조건문을 넣을 필요는 없다.
단순히 instanceof를 사용하는 것만으로 null 값을 걸러준다.

6. 종합

다음은 equals 메서드를 구현하는 방법은 단계별로 정리한 것이다.
1. == 연산자를 사용해 입력이 자기 자신의 참조인지 확인한다. 자기 자신이면 true를 반환한다. 단순히 성능 최적화용으로, 복잡한 작업이 경우 도움이 된다.
2. instanceof 연산자로 입력이 올바른 타입인지 확인한다. 그렇지 않으면 false를 반환한다.
3. 입력을 올바른 타입으로 형변환한다. 2번에서 검사를 통과했다면 이 단계는 true 다
4. 입력 객체와 자기 자신의 대응되는 '핵심' 필드들이 모두 일치하는지 하나씩 검사한다. 가능하다면 다름을 확실하게 구분할 수 있는 객체부터 검사한다. 그래야 빠르게 검사가 진행된다.