모든 객체의 공통 메서드 - 아이템 10. equals는 일반 규약을 지켜 재정의하라

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

equals를 재정의하면 안 되는 경우

1. 각 인스턴스가 본질적으로 고유한 경우

값을 표현하는 게 아니라 동작하는 개체를 표현하는 클래스가 여기에 해당한다. Thread가 좋은 예로, Object의 equals() 메서드는 이러한 클래스에 딱 맞게 구현되었다.

 

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

public class Main {
    public static void main(String[] args) {
        final Pattern p01 = Pattern.compile("//.*");
        final Pattern p02 = Pattern.compile("//.*");

        System.out.println(p01.equals(p02));   // false
        System.out.println(p01.pattern().equals(p02.pattern()));   // true
    }
}

예를 들어, java.util.regex.Pattern은 equals() 메서드를 재정의해서 두 Pattern의 인스턴스가 같은 정규표현식을 나타내는지를 검사하는, 즉 논리적 동치성을 검사하는 방법도 있다. 하지만, 설계자는 클라이언트가 이 방식이 애초에 필요하지 않다고 판단했기 때문에, Object의 기본 equals() 메서드만으로 해결이 가능하다.

 

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

예를 들어, 대부분의 Set 구현체는 AbstractSet이 구현한 equals() 메서드를 상속받아 쓰고, List 구현체들은 AbstractList로부터, Map 구현체들은 AbstractMap으로부터 상속받아 그대로 쓴다.

 

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

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

여러분이 위험을 철저히 회피하는 스타일이라 equals() 메서드가 실수로라도 호출되는 걸 막고 싶다면 위와 같이 구현하는 것이 좋다.

 

equals를 재정의 해야 하는 경우

객체 식별성(두 객체가 물리적으로 같은가)이 아닌, '논리적 동치성'을 확인해야 하는데, 상위 클래스의 equals() 메서드가 논리적 동치성을 비교하도록 재정의 되지 않았을 경우 equals() 메서드를 재정의 해야 한다.

예를 들어, 두 객체를 equals() 메서드로 비교하는 경우 객체가 같은지가 아니라 값이 같은지를 알고 싶을 것이다. equals() 메서드가 논리적 동치성을 확인하도록 재정의하면, 값을 비교할 수 있을 뿐만 아니라, Map의 키와 Set의 원소로도 사용이 가능하다.

하지만, 값 클래스여도 같은 인스턴스가 둘 이상 만들어지지 않은 '인스턴스 통제 클래스'라면 굳이 재정의하지 않아도 된다.

---

equals 메서드 재정의 일반 규약

equals() 메서드를 재정의하기 위해서는 반드시 일반 규약을 따라야 한다. 아래는 Object 명세에 적힌 규약이다.

 

1. 반사성(reflexivity) : null이 아닌 모든 참조 값 x에 대해, x.equals(x)는 true이다.

2. 대칭성(symmetry) : null이 아닌 모든 참조 값 x, y에 대해, x.equals(y)가 true이면, y.equals(x)도 true이다.

3. 추이성(transitivity) : null이 아닌 모든 참조 값 x, y, z에 대해, x.equals(y)가 true이고 y.equals(z)도 true이면, x.equals(z)도 true이다.

4. 일관성(consistency) : null이 아닌 모든 참조 값 x, y에 대해, x.equals(y)를 반복해서 호출하면 항상 true를 반환하거나 항상 false를 반환한다.

5. null이 아님 : null이 아닌 모든 참조 값 x에 대해, x.equals(null)은 false이다.

 

1. 반사성(reflexivity)

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

 

public class User {
    private String name;

    public User(String name) {
        this.name = name;
    }
}

반사성 성질을 만족하는지 확인하기 위해 User 클래스를 생성하였다.

 

public class Main {
    public static void main(String[] args) {
        Set<User> userSet = new HashSet<>();
        User user = new User("홍길동");
        userSet.add(user);
        System.out.println(userSet.contains(user));   // false일 경우, 반사성을 만족하지 못하는 경우
    }
}

User 인스턴스를 Set 컬렉션에 넣은 다음  contains() 메서드를 호출하였다. 만약, false를 출력한다면 반사성을 만족하지 못한 경우이다.

 

2. 대칭성(symmetry)

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

 

public final class SampleObject {
    private final String s;

    public SampleObject(String s) {
        this.s = Objects.requireNonNull(s);
    }

    /** 대칭성 위배 */
    @Override
    public boolean equals(Object o) {
        if (o instanceof SampleObject) {
            return s.equalsIgnoreCase(((SampleObject) o).s);
        }
        if (o instanceof String) {
            return s.equalsIgnoreCase((String) o);
        }
        return false;
    }
}

위 코드는 대칭성을 위배한 잘못된 코드이다.

 

public class Main {
    public static void main(String[] args) {
        SampleObject sampleObject = new SampleObject("hello");
        String string = "hello";

        System.out.println(sampleObject.equals(string));   // true
        System.out.println(string.equals(sampleObject));   // false
    }
}

문제는 CaseInsensitiveString의 equals() 메서드는 String을 알고 있지만, String의 equals() 메서드는 CaseInsensitiveString의 존재를 모른다는 데 있다. 이 경우 대칭성을 명백히 위반한다.

 

public final class SampleObject {
    private final String s;

    public SampleObject(String s) {
        this.s = Objects.requireNonNull(s);
    }

    /** 대칭성 만족 */
    @Override
    public boolean equals(Object o) {
        return o instanceof SampleObject
                && ((SampleObject) o).s.equalsIgnoreCase(s);
    }
}

대칭성을 만족시키기 위해 SampleObject끼리만 비교하도록 한다. equals() 메서드를 수정한 결과는 위와 같다.

 

3. 추이성(transitivity)

추이성이란 첫 번째와 두 번째 객체가 같고, 두 번째 객체와 세 번째 객체가 같으면, 첫 번째 객체와 세 번째 객체도 같아야 한다는 의미이다. 추이성 문제는 상위 클래스에 없는 새로운 필드를 하위 클래스에 추가하여, equals() 메서드를 재정의할 때 자주 발생하는 문제이다.

 

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;
    }
}

부모 클래스인 Point 클래스를 정의한다.

 

public class ColorPoint extends Point {
    private final Color color;

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

Point 클래스를 상속받는 ColoPoint 클래스를 정의하고, 새로운 필드를 추가한다. 이 경우 equals() 메서드는 어떻게 해야 할까? 그대로 둔다면 Point의 구현이 상속되어 색상 정보는 무시한 채 비교를 수행한다. equals 규약을 어긴 것은 아니지만, 중요한 정보를 놓치게 되니 받아들일 수 없는 상황이다.

 

1) 잘못된 코드 - 대칭성 위배

public class ColorPoint extends Point {
    private final Color color;

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

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

위 코드와 같이 비교 대상이 또 다른 ColorPoint이고 위치와 색상이 같을 때만 true를 반환하는 equals() 메서드를 재정의하였다.

 

public class Main {
    public static void main(String[] args) {
        Point p = new Point(1, 2);
        ColorPoint cp = new ColorPoint(1, 2, Color.RED);

        System.out.println(p.equals(cp));   // true 출력
        System.out.println(cp.equals(p));   // false 출력
    }
}

 

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

 

2) 잘못된 코드 - 추이성 위배

public class ColorPoint extends Point {
    private final Color color;

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

    @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;
    }
}

앞에서 보았던 대칭성 문제를 해결하기 위해 ColorPoint 클래스의 equals() 메서드를 재구성하였다.

 

public class Main {
    public static void main(String[] args) {
        ColorPoint p01 = new ColorPoint(1, 2, Color.RED);
        Point p02 = new Point(1, 2);
        ColorPoint p03 = new ColorPoint(1, 2, Color.BLUE);

        System.out.println(p01.equals(p02));   // true 출력
        System.out.println(p02.equals(p03));   // true 출력
        System.out.println(p01.equals(p03));   // false 출력
    }
}

하지만, 이 방식은 대칭성은 지켜주지만, 추이성을 깨버린다.

 

3) 잘못된 코드 - 리스코프 치환 원칙 위배

public class ColorPoint extends Point {
    private final Color color;

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

    @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() 메서드를 재구성하였다. 위 소스코드의 경우 같은 구현 클래스의 객체와 비교할 때만 true를 반환하도록 구현하였다. 괜찮아 보이지만 실제로 활용할 수는 없다. Point의 하위 클래스는 정의상 여전히 Point이므로 어디서든 Point로써 활용될 수 있어야 한다. 하지만, 위 코드를 사용한다면 그렇지 못하다. 즉, 리스코프 치환 원칙을 위배하는 것이다.

 

해결 방법01 - 상속 대신 컴포지션을 사용하라

컴포지션이란 기존 클래스가 새로운 클래스의 구성 요소로 쓰이는 것을 의미한다. 기존 클래스를 확장하는 대신, 새로운 클래스를 만들고 private 필드로 기존 클래스의 인스턴스를 참조하게 한다. 컴포지션을 통해 새 클래스의 인스턴스 메서드들은 기존 클래스에 대응하는 메서드를 호출해 그 결과를 반환하도록 한다.

 

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

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

    /** ColorPoint의 Point 뷰를 반환 */
    public Point asPoint() {
        return this.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);
    }
}

Point 클래스를 상속받는 대신 Point를 ColorPoint의 private 필드로 두고, ColorPoint와 같은 위치의 일반 Point를 반환하는 뷰 메서드를 public으로 추가하는 방식이다.

 

1. ColorPoint와 ColorPoint의 비교 : ColorPoint의 equals를 이용하여 color 값까지 모두 비교한다.

2. ColorPoint와 Point의 비교 : ColorPoint의 asPoint() 메서드를 이용하여 Point로 바꿔, Point 클래스의 equals() 메서드를 이용해 x, y 값을 비교한다.

3. Point와 Point의 비교 : Point의 equals() 메서드를 이용해 x, y 값을 비교한다.

 

해결 방법02 - 추상 클래스의 하위 클래스를 사용하라

추상 클래스의 하위 클래스에서는 equals 규약을 지키면서도 값을 추가할 수 있다. 상위 클래스의 인스턴스를 직접 생성하는 것이 불가능하기 때문에, 하위 클래스끼리의 비교가 가능한 것이다.

 

4. 일관성(consistency)

일관성은 두 객체가 같다면 앞으로도 영원히 같아야 한다는 뜻이다. 가변 객체는 비교 시점에 따라 서로 다를 수도 혹은 같을 수도 있는 반면, 불변 객체는 한번 다르면 끝까지 달라야 한다. 클래스를 작성할 때 불변 클래스로 만드는 게 나을지를 심사숙고하자. 불변 클래스로 만들기로 했다면 equals() 메서드가 한번 같다고 한 객체와는 영원히 같다고 답하고, 다르다고 한 객체와는 영원히 다르다고 답하도록 만들어야 한다.

또한, 클래스가 불변이든 가변이든 equals() 메서드의 판단에 신뢰할 수 없는 자원이 끼어들게 해서는 안된다. 이 제약을 어기게 되면 일관성 조건을 만족시키기가 아주 어렵다. 예를 들어, java.net.URL의 equals() 메서드는 주어진 URL과 매핑된 호스트의 IP 주소를 이용해 비교한다. 호스트 이름을 IP 주소로 바꾸려면 네트워크를 통해야 하는데, 그 결과가 항상 같다고 보장할 수 없다. java.net.URL의 equals() 메서드를 이런 방식으로 구현한 것은 커다란 실수였으니 절대로 따라 해서는 안 된다.

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

 

5. null이 아님

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

 

잘못된 코드 - 명시적 null 검사

@Override
public boolean equals(Object o) {
    if (o == null) {
        return false;
    }
}

수많은 클래스에서 위 코드와 같이 명시적으로 입력이 null인지를 확인해 자신을 보호한다.

 

올바른 코드 - 묵시적 null 검사

@Override
public boolean equals(Object o) {
    if (!(o instanceof MyType) {
        return false;
    }
    MyType myType = (MyType) o;
}

동시성을 검사하기 위해서 equals() 메서드는 건네받은 객체를 적절히 형 변환한 후 필수 필드들의 값을 알아내야 한다. 따라서, 형 변환에 앞서 instanceof 연산자를 통해 입력 매개변수가 올바른 타입인지 검사해야 한다. 입력이 null이면 타입 확인 단계에서 false를 반환하므로 null 검사를 명시적으로 하지 않아도 된다.

 

양질의 equals 메서드 구현 방법

지금까지의 내용을 종합해서 양질의 equals() 메서드 구현 방법을 단계별로 정리해 보았다.

 

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

자기 자신이면 true를 반환한다. 이는 단순한 성능 최적화용으로, 비교 작업이 복잡한 상황일 때 값어치를 할 것이다.

 

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

이때의 올바른 타입은 equals() 메서드가 정의된 클래스인 것이 보통이지만, 가끔은 그 클래스가 구현한 특정 인터페이스가 될 수도 있다. 어떤 인터페이스는 자신을 구현한 서로 다른 클래스끼리도 비교할 수 있도록 equals 규약을 수정하기도 한다. 이런 인터페이스를 구현한 클래스라면 equals() 메서드에서 해당 인터페이스를 사용해야 한다. Set, List, Map, Map.Entry 등의 컬렉션 인터페이스들이 여기에 해당한다.

 

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

앞서 두 번째 단계에서 instanceof 연산자를 사용했기 때문에, 이 단계는 100% 성공한다.

 

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

모든 필드가 일치한다면 true를 반환하고, 하나라도 다르다면 false를 반환한다. 두 번째 단계에서 인터페이스를 사용했다면 입력의 필드 값을 가져올 때도 그 인터페이스의 메서드를 사용해야 한다.

 

equals 구현 시 추가 주의 사항

1. 기본 타입 필드의 비교

float와 double을 제외한 기본 타입 필드는 '==' 연산자로 비교한다.

 

2. 참조 타입 필드의 비교

참조 타입 필드의 경우 equals() 메서드를 이용해 비교한다.

 

3. float, double 필드의 비교

float와 double 필드는 각각 Float.compare(float, float)와 Double.compare(double, double) 정적 메서드를 이용해 비교한다. Float.equals()와 Double.equals() 메서드는 오토 박싱을 수반하기 때문에 성능상 좋지 않으니, 사용을 자제한다.

 

4. 배열 필드

배열 필드의 경우 원소 각각을 앞서의 지침대로 비교한다. 배열의 모든 원소가 핵심 필드라면 Arrays.equals() 메서드들 중 하나를 사용한다.

 

5. null을 정상 값으로 취급하는 참조 타입 필드

때로는 null도 정상 값으로 취급하는 참조 타입 필드가 존재한다. 이런 필드의 경우 정적 메서드인 Objects.equals(Object, Object) 메서드를 이용해 비교하여 NullPointException 발생을 예방한다.

 

6. 비교하기 복잡한 필드를 가진 클래스

비교하기가 아주 복잡한 필드를 가진 클래스의 경우, 그 필드의 표준형을 저장해둔 후 표준형끼리 비교하면 훨씬 경제적이다.

 

7. 필드의 비교 순서는 equals() 메서드의 성능을 좌우한다.

최상의 성능을 바란다면 다를 가능성이 더 크거나, 비교하는 비용이 싼 필드를 먼저 비교한다. 파생 필드가 객체 전체 상태를 대표하는 경우, 파생 필드부터 비교한다.

 

8. equals() 메서드를 재정의할 때는 hashCode도 반드시 재정의한다.

 

9. 너무 복잡하게 해결하려 들지 말자

필드들의 동치성만 검사해도 equals 규약을 어렵지 않게 지킬 수 있다. 오히려 너무 공격적으로 파고들다가 문제를 일으키기도 한다.

 

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

public boolean equals(MyClass o) {   // 입력 타입은 반드시 Object여야 한다.
    ...
}

기본 equals() 메서드를 그대로 둔 채로 추가한 것일지라도, 위와 같이 타입을 구체적으로 명시한 equals() 메서드는 오히려 해가 된다.

 

최종 정리

꼭 필요한 경우가 아니라면 equals() 메서드를 재정의하지 않는 것이 낫다. 많은 경우에 Object의 equals() 메서드가 프로그래머들이 원하는 비교를 정확이 수행해준다. 재정의해야 할 때는 그 클래스의 핵심 필드 모두를 빠짐없이, 다섯 가지 규약을 확실히 지켜가며 비교해야 한다.

---

출처

ㆍ 이펙티브 자바 Effective Java 3/E. 조슈아 블로크 저자(글) · 개앞맵시(이복연) 번역

ㆍ https://github.com/2021BookChallenge/Effective-Java/blob/main/03%EC%9E%A5/item10.md