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

 equals메서드는 재정의하기 쉬워 보이지만 여러가지 함정이 있어서 자칫하면 끔찍한 결과를 초래한다. 다음에서 열거한 상황 중 하나에 해당한다면 재정의하지 않는 것이 좋다.

[ equals를 재정의하지 않는 상황 ]

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

   - 동작하는 개체를 표현하는 클래스가 여기에 해당(Thread)

2. 인스턴스의 '논리적 동치성'을 검사할 일이 없다.

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

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

   - 이를 회피하고 싶다면 아래와 같은 메서드를 구현해두자.

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

 

✅ equals를 재정의하는 상황

 객체 식별성이 아닌 논리적 동치성을 확인해야 할 때, 즉, 상위 클래스의 equals가 논리적 동치성을 비교하도록 재정의되지 않았을 때 equals를 재정의 한다. 주로 Integer외 String처럼 값 클래스가 이에 해당한다. equals가 논리적 동치성을 확인하도록 재정의해두면, 그 인스턴스는 값을 비교할 뿐만 아니라 Set과 Map의 원소로 사용할 수 있게 된다.

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

 

[ equals 메서드 재정의 일반 규약 ]

반사성	null이 아닌 모든 참조값 x에 대해, x.equals(x)는 true다.
대칭성	null이 아닌 모든 참조값 x, y에 대해, x.equals(y)가 true면 y.equals(x)도 true다.
추이성	null이 아닌 모든 참조값 x, y, z에 대해, x.equals(y)가 true이고, y.equals(z)도 true면 x.equals(z)도 true다.
일관성	null이 아닌 모든 참조값 x, y에 대해, x.equals(y)를 반복해서 호출하면 항상 true 혹은 false를 반환한다.
null-아님	null이 아닌 모든 참조값 x에 대해, x.equals(null)은 false다.

 

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

대칭성은 두 객체는 서로에 대한 동치 여부에 똑같이 답해야 한다는 뜻이다. 대소문자를 구별하지 않는 문자열을 구현한 다음 클래스를 예로 들어보자. 이 클래스에서는 toString 메서드는 원본 문자열의 대소문자를 그대로 돌려주지만, equals에서는 대소문자를 무시한다.

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 cis = new CaseInsensitiveString("BTS");
String s = "bts";

 만약, CaseInsensitiveString과 일반 String 객체가 하나씩 있다고 해보자. 예상할 수 있듯이 cis.equals(s)는 true를 반환한다. 문제는 CaseInsensitiveString의 equals는 일반 String을 알고 있지만, String의 equals는 CaseInsensitiveString의 존재를 모른다는데 있다.

 따라서 s.equals(cis)는 false를 반환하여 대칭성을 명백히 위반한다.

 

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

 이와 같이 equals 메서드를 바꾼다면 위와 같은 문제를 해결할 수 있다.

 

추이성은 첫 번째 객체와 두 번째 객체가 같고, 두 번째 객체와 세 번째 객체가 같다면, 첫 번째 객체와 세 번째 객체가 같아야 한다는 뜻이다. 아래처럼 상위 클래스에는 없는 새로운 필드를 하위 클래스에 추가하는 상황을 생각해보자. 간단히 2차원에서의 점을 표현하는 클래스를 예로 들어보자.

public class Point {
    private final int x;
    private final int y;

    public point(int x, int y) {
        this.x = x;
        this.y = y;
    }

    @Override
    public boolean equals(Object o) {
        if(!(o instanceof Point))
            return false;
        Point p = (Point) o;
        return p.x == x && p.y == y;
    }
}

 

이제 이 클래스를 다시 아래와 같이 확장한다.

public class ColorPoint extends Point {
    private final Color color;

    public ColorPoint(int x, int y, Color color) {
        super(x, y);
        this.color = color;
    }
}

 

 이대로 둔다면 Point의 구현이 상속되어 색상 정보는 무시한 채 비교를 수행한다. 다음 코드처럼 비교 대상이 또 다른 ColorPoint이고, 위치와 색상이 같을 때만 true를 반환하는 equals를 생각해보자.

@Override
public boolean equals(Object o) {
    if(!(o instanceof ColorPoint))
        return false;
    return super.equals(o) && ((ColorPoint) o).color == color;
}

 

 이 메서드는 일반 Point를 ColorPoint에 비교한 결과와 그 둘을 바꿔 비교한 결과가 다를 수 있다. Point의 equals는 색상을 무시하고, ColorPoint의 equals는 입력 매개변수의 클래스 종류가 다르다며 매번 false만 반환할 것이다.

 

 아래 코드는 추이성을 위배한다.

@Override
public boolean equals(Object o) {
    if(!(o instanceof Point))
        return false;
        
    // o가 일반 Point면 색상을 무시하고 비교한다.
    if(!(o instanceof ColorPoint))
        return o.equals(this);
    
    return super.equals(o) && ((ColorPoint) o).color == color;
}

 

이번 코드는 리스코프 치환 원칙을 위배한다. Point의 하위 클래스는 정의상 여전히 Point이므로 어디서든 Point로써 활용될 수 있어야 한다. 그런데 이 방식에서는 그렇지 못하다.

@Override
public boolean equals(Object o) {
    if(o == null || o.getClass() != getClass())
        return false;
    Point p = (Point) o;
    return p.x == x && p.y == y;
}

 

 다음 코드는 equals 규약을 지키면서 값을 추가한 것이다

public class ColorPoint {
    private final Point point;
    private final Color color;

    public ColorPoint(int x, int y, Color color) {
        point = new Point(x, y);
        this.color = Objects.requireNonNull(color);
    }

    public Point asPoint() {
        return point;
    }

    @Override
    public boolean equals(Object o) {
        if(!(0 instanceof ColorPoin))
            return false;
        ColorPoint cp = (ColorPoint) o;
        return cp.point.equals(point) && cp.color.equals(color);
    }
}

 자바 라이브러리에도 구체 클래스를 확장해 값을 추가한 클래스가 종종 있다. 한 가지 예로 java.sql.Timestamp는 java.util.Date를 확장한 후 nanoseconds 필드를 추가했다. 그 결과로 Timestamp의 equals는 대칭성을 위배하며, Date 객체와 한 컬렉션에 넣거나 서로 섞어 사용하면 엉뚱하게 동작할 수 있다.

 

추상 클래스의 하위 클래스에서라면 equals 규약을 지키면서도 값을 추가할 수 있다. "태그 달린 클래스보다는 클래스 계층 구조를 활용하라"는 아이템 23의 조언을 따르는 클래스 계층구조에서는 아주 중요한 사실이다. 예컨대 아무런 값을 갖지 않는 추상 클래스인 Shape를 위에 두고,  이를 확장하여 radius 필드를 추가한 Circle 클래스와 length와 width 필드를 추가한 Rectangle 클래스를 만들 수 있다.

 

 일관성은 두 객체가 같다면 앞으로도 영원히 같아야 한다는 뜻이다. 불변 객체는 한번 다르면 끝까지 달라야 한다. 클래스가 불변이든 가변이든 equals의 판단에 신뢰할 수 없는 자원이 끼어들게 해서는 안된다. 예컨대 java.net.URL의 equals는 주어진 URL과 매핑된 호스트의 IP 주소를 이용해 비교한다. 호스트 이름을 IP 주소로 바꾸려면 네트워크를 통해야 하는데, 그 결과가 항상 같다고 보장할 수 없다. 이는 URL의 equals가 일반 규약을 어기게 한다. 이런 문제를 피하려면 equals는 항시 메모리에 존재하는 객체만을 사용한 결정적 계산만 수행해야 한다.

 

 마지막 요건인 'null-아님'은 이름처럼 모든 객체가 null과 같지 않아야 한다는 뜻이다. 수많은 코드가 다음 코드처럼 입력이 null인지를 확인해 자신을 보호한다. instanceof는 첫 번째 피연산자가 null이면 false를 반환한다.

// 명시적 null 검사가 필요 없다.
@Override
public boolean equals(Object o) {
    if(!(o instanceof MyType))
        return false;
    MyType mt = (MyType) o;
    // ...
}

✅ 지금까지의 내용을 종합한 단계별 정리

1. == 연산자를 사용해 입력이 자기 자신의 참조인지 확인한다.

2. instanceof 연산자로 입력이 올바른 타입인지 확인한다.

3. 입력은 올바른 타입으로 형변환한다.

4. 입력 객체와 자기 자신의 대응되는 '핵심' 필드들이 모두 일치하는지 하나씩 검사한다.

5. float과 double을 제외한 기본 타입 필드는 == 연산자로 비교하고, 참조 타입 필드는 각각의 equals 메서드로 비교한다. float과 double필드는 각각 정적 메서드인 Float.compare(float, float)와 Double.compare(double, double)로 비교한다.(부동 소수점으로 인해) 물론 equals 메서드를 대신 사용할 수 있지만, 오토박싱을 수반하니 성능상 좋지 않다.

6. null도 정상값으로 취급하는 참조 타입 필드의 경우, 정적 메서드인 Objects.equals(Object, Object)로 비교해 NullPointException 발생을 예방하자.

7. 앞에서 언급한 CaseInsensetiveString 예처럼 비교하기가 복잡한 필드를 가진 클래스는 그 필드의 표준형을 저장해둔 후, 표준형끼리 비교하면 훨씬 경제적이다.

8. 어떤 필드를 먼저 비교하느냐가 equals의 성능을 좌우하기도 한다. 다를 가능성이 더 크거나 비교하는 비용이 싼 필드를 먼저 비교하자. 동기화용 락 필드같이 객체의 논리적 상태와 관련없는 필드는 비교하면 안된다.

9. equals를 재정의할 땐 hashCode도 재정의하자.

10. Object 외의 타입을 매개변수로 받는 equals 메서드는 선언하지 말자.

11. equals를 작성하고 테스트를 대신해줄 오픈소스는 바로 구글이 만든 AutoValue 프레임워크다.

 

 

 equals를 다 구현했다면 세가지만 자문해보자. 대칭적인가? 추이성이 있는가? 일관적인가? 다음은 이상의 비법에 따라 작성해본 PhoneNumber 클래스용 equals 메서드다.

public final class PhoneNumber {
    private final short areaCode, prefix, lineNum;

    public PhoneNumber(int areaCode, int prefix, int lineNum) {
        this.areaCode = rangeCheck(areaCode, 999, "지역코드");
        this.prefix = rangeCheck(prefix, 999, "프리픽스");
        this.lineNum = rangeCheck(lineNum, 9999, "가입자번호");
    }

    private static short rangeCheck(int val, int max, String arg) {
        if(val < 0 || val > max) {
            throw new IllegalArgumentException(arg + ": " + val);
        }
        return (short) val;
    }

    @Override
    public boolean equals(Object o) {
        if(o == this)
            return true;
        if(!(o instanceof PhoneNumber))
            return false;
        PhoneNumber pn = (PhoneNumber) o;
        return pn.lineNum == lineNum && pn.prefix == prefix && pn.areaCode == areaCode;
    }

    // ...
}