Object는 객체를 만들 수 있는 구체 클래스지만 기본적으로 상속해서 사용하도록 설계되었다. Object에서 final이 아닌 메소드(equals, hasCode, toString, clone, finalize)는 모두 재정의(overriding)를 염두에 두고 설계된 것이라 재정의 시 지켜야 하는 일반 규약이 명확히 정의되어 있다. 메소드를 잘못 구현하면 대상 클래스가 이 규약을 준수한다고 가정하는 클래스(HashMap과 HashSet 등)를 오동작하게 만들 수 있다.
equals 메소드는 재정의하기 쉬워 보이지만 곳곳에 함정이 있어 자칫하면 끔찍한 결과를 초래한다. 아예 재정의하지 않으면 그 클래스의 인스턴스는 오직 자기 자신과만 같게 되므로, 다음에서 열거한 상황 중 하나에 해당한다면 재정의하지 않는 것이 최선이다.
각 인스턴스가 본질적으로 고유하다.
값을 표현하는 게 아니라 동작하는 개체를 표현하는 클래스가 여기 해당하며, 대표적으로 Thread가 여기에 해당한다.
인스턴스의 '논리적 동치성(logical equality)'을 검사할 일이 없다.
java.util.regex.Pattern은 equals를 재정의해서 두 Pattern의 인스턴스가 같은 정규표현식을 나타내는지 검사하는 방법이지만, 이런 검사가 필요하지 않다면 Object의 기본 equals만으로 해결된다.
상위 클래스에서 재정의한 equals가 하위 클래스에도 딱 들어맞는다.
예컨대 대부분의 Set 구현체는 AbstractSet이 구현한 equals를 상속받아 쓰고, List 구현체들은 AbstractList로부터, Map 구현체들은 AbstractMap으로부터 상속받아 그대로 쓴다.
클래스가 private이거나 package-private이고 equals 메소드를 호출할 일이 없다.
equals가 실수로라도 호출되는 걸 막고 싶다면 다음처럼 구현해두자.
1 2 3 | @Override public boolean equals(Object o) { throw new AssertionError(); // 호출 금지! } | cs |
equals는 객체 식별성(object identity, 두 객체가 물리적으로 같은가)이 아니라 논리적 동치성을 확인해야 하는데, 상위 클래스의 equals가 논리적 동치성을 비교하도록 재정의되지 않았을 때에 재정의해야 한다. 주로 값 클래스(Integer와 String처럼 값을 표현하는 클래스)들과 Enum이 여기에 해당한다. 값 클래스라 해도, 값이 같은 인스턴스가 둘 이상 만들어지지 않음을 보장하는 인스턴스 통제 클래스라면 equals를 재정의하지 않아도 된다. 이런 클래스에서는 논리적 동치성과 객체 식별성이 사실상 똑같은 의미가 된다.
equals 메소드를 재정의할 때는 반드시 일반 규약을 따라야 한다. 다음은 Object 명세에 적힌 규약이다.
equals 메소드는 동치관계(equivalence relation)를 구현하며, 다음을 만족한다.
반사성(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-아님: null이 아닌 모든 참조 값 x에 대해, x.equals(null)은 false다.
이 규약을 어기면 프로그램이 이상하게 동작하거나 종료될 것이고, 원인이 되는 코드를 찾기도 굉장히 어려울 것이다.
Object 명세에서 말하는 동치관계란, 집합을 서로 같은 원소들로 이뤄진 부분집합으로 나누는 연산이다. 이 부분집합을 동치류(equivalence class, 동치 클래스)라 하는데, equals 메소드가 쓸모 있으려면 모든 원소가 같은 동치류에 속한 어떤 원소와도 서로 교환될 수 있어야 한다.
반사성은 단순히 말하면 객체는 자기 자신과 같아야 한다는 뜻이다. 이 요건을 어긴 클래스의 인스턴스를 컬렉션에 넣은 다음 contains 메소드를 호출하면 방금 넣은 인스턴스가 없다고 답할 것이다.
대칭성은 두 객체는 서로에 대한 동치 여부에 똑같이 답해야 한다는 뜻이다. 대소문자를 구별하지 않는 문자열을 구현한 다음 클래스를 예로 살펴보자.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | // 잘못된 코드 - 대칭성 위배! 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; } ... // 나머지 코드는 생략 } | cs |
CaseInsensitiveString의 equals는 순진하게 일반 문자열과도 비교를 시도한다. 다음처럼 CaseInsensitiveString과 일반 String 객체가 하나씩 있다고 해보자.
1 2 | CaseInsensitiveString cis = new CaseInsensitiveString("Polish"); String s = "polish"; | cs |
여기서 문제는 CaseInsensitiveString의 equals는 일반 String을 알고 있지만 String의 equals는 CaseInsensitiveString의 존재를 모른다는 데 있다. 따라서 cis.equals(s)는 true를 반환하는데 반해, s.equals(cis)는 false를 반환하여 대칭성을 위반한다. equals 규약을 어기면 그 객체를 사용하는 다른 객체들이 어떻게 반응할지 알 수 없다. 이 문제를 해결하려면 CaseInsensitiveString의 equals를 String과도 연동하겠다는 허황된 꿈을 버려야 한다.
1 2 3 4 | @Override public boolean equals(Object o) { return o instanceof CaseInsensitiveString && ((CaseInsensitiveString) o).s.equalsIgnoreCase(s); } | cs |
추이성은 첫 번째 객체와 두 번째 객체가 같고, 두 번째 객체와 세 번째 객체가 같다면, 첫 번째 객체와 세 번째 객체도 같아야 한다는 뜻이다. 상위 클래스에는 없는 새로운 필드를 하위 클래스에 추가하는, 간단히 2차원에서의 점을 표현하는 클래스를 예로 들어보자.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | 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; } ... // 나머지 코드는 생략 } | cs |
이제 이 클래스를 확장해서 점에 색상을 더해보자.
1 2 3 4 5 6 7 8 9 10 | public class ColorPoint extends Point { private final Color color; public ColorPoint(int x, int y, Color color) { super(x, y); this.color = color; } ... // 나머지 코드는 생략 } | cs |
equals 메소드를 그대로 둔다면 Point의 구현이 상속되어 색상 정보는 무시한 채 비교를 수행한다. equals 규약을 어긴 것은 아니지만, 중요한 정보를 놓치게 되니 받아들일 수 없는 상황이다. 비교 대상이 또 다른 ColorPoint이고 위치와 색상이 같을 때만 true를 반환하는 equals를 생각해보자.
1 2 3 4 5 6 | // 잘못된 코드 - 대칭성 위배! @Override public boolean equals(Object o) { if (!(o instanceof ColorPoint)) return false; return super.equals(o) && ((ColorPoint) o).color == color; } | cs |
Point의 equals는 색상을 무시하고, ColorPoint의 equals는 입력 매개변수의 클래스 종류가 다르다며 매번 false만 반환할 것이다. 각각의 인스턴스를 하나씩 만들어 실제로 동작하는 모습을 확인해보자.
1 2 | Point p = new Point(1, 2); ColorPoint cp = new ColorPoint(1, 2, Color.RED); | cs |
p.equals(cp)는 true를, cp.equals(p)는 false를 반환한다. ColorPoint.equals가 Point와 비교할 때는 색상을 무시하도록 하면 해결될까?
1 2 3 4 5 6 7 8 9 10 11 12 | // 잘못된 코드 - 추이성 위배! @Override public boolean equals(Object o) { if (!(o instanceof Point)) return false; // o가 일반 Point면 색상을 무시하고 비교한다. if (!(o instanceof ColorPoint)) return o.equals(this); // o가 ColorPoint면 색상까지 비교한다. return super.equals(o) && ((ColorPoint) o).color == color; } | cs |
이 방식은 대칭성은 지켜주지만, 추이성은 깨버린다.
1 2 3 | ColorPoint p1 = new ColorPoint(1, 2, Color.RED); Point p2 = new Point(1, 2); ColorPoint p3 = new ColorPoint(1, 2, Color.BLUE); | cs |
이제 p1.equals(p2)와 p2.equals(p3)는 true를 반환하는데, p1.equals(p3)가 false를 반환한다. p1과 p2, p2와 p3 비교에서는 색상을 무시했지만, p1과 p3 비교에서는 색상까지 고려했기 때문이다. 또한, 이 방식은 무한 재귀에 빠질 위험도 있다. Point의 또 다른 하위 클래스로 SmellPoint를 만들고, equals는 같은 방식으로 구현한 뒤, myColorPoint.equals(mySpellPoint)를 호출하면 StackOverflowError를 일으킨다.
구체 클래스를 확장해 새로운 값을 추가하면서 equals 규약을 만족시킬 방법은 존재하지 않는다. 이 말은 얼핏, equals 안의 instanceof 검사를 getClass 검사로 바꾸면 규약도 지키고 값도 추가하면서 구체 클래스를 상속할 수 있다는 뜻으로 들리지만, 그렇게 한다면 같은 구현 클래스의 객체와 비교할 때만 true를 반환하고, Point의 하위 클래스가 어디서든 Point로 활용될 수 있지 못하게 만든다. 이는 리스코프 치환 원칙(Liskov substitution principle)을 위배하게 되는 것인데, 리스코프 치환 원칙이란 어떤 타입에 있어 중요한 속성이라면 그 하위 타입에서도 마찬가지로 중요하므로, 그 타입의 모든 메소드가 하위 타입에서도 똑같이 잘 작동해야 한다는 원칙이다.
구체 클래스의 하위 클래스에서 값을 추가할 방법은 없지만 괜찮은 우회 방법이 하나 있다. 상속 대신 컴포지션을 사용하는 방법인데, Point를 상속하는 대신 Point를 ColorPoint의 private 필드로 두고, ColorPoint와 같은 위치의 일반 Point를 반환하는 뷰(view) 메소드를 public으로 추가하는 식이다.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 | // 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); { // 이 ColorPoint의 Point 뷰를 반환한다. public Point asPoint() { return point; } @Override public boolean equals(Object o) { if (!(o instanceof ColorPoint)) return false; ColorPoint cp = (ColorPoint) o; return cp.point.equals(point) && cp.color.equals(color); } ... // 나머지 코드 생략 } | cs |
일관성은 두 객체가 같다면 어느 하나 혹은 두 객체 모두가 수정되지 않은 한 앞으로도 영원히 같아야 한다는 뜻이다. 클래스가 불변이든 가변이든 equals의 판단에 신뢰할 수 없는 자원이 끼어둘게 해서는 안 된다. 예컨데 java.net.URL의 equals는 주어진 URL과 매핑된 호스트의 IP 주소를 이용해 비교한다. 호스트 이름을 IP 주소로 바꾸려면 네트워크를 통해야 하는데, 그 결과가 항상 같다고 보장할 수 없다. 하위 호환성이 발목을 잡아 잘못된 동작은 바로잡을 수도 없으므로, equals는 항시 메모리에 존재하는 객체만을 사용한 결정적(deterministic) 계산만 수행해야 한다.
null-아님은 이름처럼 모든 객체가 null과 같지 않아야 한다는 뜻이다. 실수로 NullPointerException을 던지는 코드는 흔한데, 일반 규약은 이런 경우도 허용하지 않는다. 수많은 클래스가 다음 코드처럼 입력이 null인지를 확인해 자신을 보호한다.
1 2 3 4 5 6 | // 명시적 null 검사 - 필요 없다! @override public boolean equals(Object o) { if (o == null) return false; ... } | cs |
이러한 검사는 필요치 않다. 동치성을 검사하려면 equals는 건네받은 객체를 적절히 형변환한 후 필수 필드들의 값을 알아내야 한다. 그러려면 형변환에 앞서 instanceof 연산자로 입력 매개변수가 올바른 타입인지 검사해야 한다.
1 2 3 4 5 6 7 | // 묵시적 null 검사 - 이쪽이 낫다. @Override public boolean equals(Object o) { if (!(o instanceof MyType)) return false; MyType mt = (MyType) o; ... } | cs |
equals가 타입을 확인하지 않으면 잘못된 타입이 인수로 주어졌을 때 ClassCastException을 던져서 일반 규약을 위배하게 된다. 그런데 instanceof는 두 번째 피연산자와 무관하게 첫 번째 피연산자가 null이면 false를 반환한다. 따라서 입력이 null이면 타입 확인 단계에서 false를 반환하기 때문에 null 검사를 명시적으로 하지 않아도 된다.
1. ==연산자를 사용해 입력이 자기 자신의 참조인지 확인한다.
2. instanceof 연산자로 입력이 올바른 타입인지 확인한다.
3. 입력을 올바른 타입으로 형변환한다.
4. 입력 객체와 자기 자신의 대응되는 '핵심' 필드들이 모두 일치하는지 하나씩 검사한다.
equals를 다 구현했다면 세 가지만 자문해보자. 대칭적인가? 추이성이 있는가? 일관적인가? 자문에서 끝내지 말고 단위 테스트를 작성해 돌려보고, 세 요건 중 하나라도 실패한다면 원인을 찾아서 고치자. 물론 나머지 요건인 반사성과 null-아님도 만족해야 한다. 참고로 구글이 만든 AutoValue 프레임워크를 이용하면, 클래스에 애너테이션 하나로 깔끔하고 읽기 좋은 상태를 유지한 채로 테스트 진행이 가능하다.
추가적인 주의사항으로 equals를 재정의할 땐 hashCode도 반드시 재정의하자. 또한 너무 복잡하게 해결하려 들지 말자. 마지막으로 Object 외의 타입을 매개변수로 받는 equals 메소드는 선언하지 말자.
꼭 필요한 경우가 아니면 equals를 재정의하지 말자. 많은 경우에 Object의 equals가 여러분이 원하는 비교를 정확히 수행해준다. 재정의해야 할 때는 그 클래스의 핵심 필드 모두를 빠짐없이, 다섯 가지 규약을 확실히 지켜가며 비교해야 한다.