[이펙티브 자바] 아이템10

hyng·2022년 11월 30일

목록 보기

10/13

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

필요하지 않다면 굳이 재정의하지 말자

equals 메서드는 재정의하기 쉬워 보이지만 곳곳에서 문제가 발생할 가능성이 크기 때문에 필요하지 않다면 재정의하지 않는 것이 가장 좋다.
다음 조건에 해당한다면 굳이 재정의하지 말자.

각 인스턴스가 본질적으로 고유하다. ex) 싱글톤, Enum
인스턴스의 논리적 동치성을 검사할 일이 없다.
- 첫 번째가 이에 해당하는데, 인스턴스가 고유하다면 논리적 동치성과 객체 식별성을 똑같은 의미로 볼 수 있으므로 equals 메서드를 호출할 필요가 없다.
상위 클래스에서 재정의한 equals가 하위 클래스에도 딱 들어맞는다.
- 상위 클래스에서 구현한 equals만으로도 충분하다면 굳이 재정의 할 필요가 없다.
클래스가 private 이어서 equals 메서드를 호출할 일이 없다.
- 호출되는 일을 완벽하게 방어하기 위해 아래처럼 호출 시 예외를 던지게 할 수도 있다.

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

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-아님: null이 아닌 모든 참조 값 x에 대해, x.equals(null)은 false다.

이 규약을 어기면 찾기 어려운 버그를 양산하게 될 수 있다.

반사성(reflexivity)

단순히 객체는 자기 자신과 같아야 한다는 뜻이다.

    Point point = new Point(1, 2);
    List<Point> list = new ArrayList<>();
    list.add(point);
    list.contains(point); // true가 나와야함.

대칭성(symmetry)

서로에 대한 동치 여부에 똑같이 답해야 한다는 뜻이다.

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("Polish");
    String s = "Polish";
    System.out.println(cis.equals(s)); // true
    System.out.println(s.equals(cis)); // false

참고
instanceof 대신 getClass 검사로 바꾸는 것은 리스 코프 치환 원칙(하위 클래스는 상위 클래스를 대신할 수 있어야 한다.)을 위배한다.

equals 메 서드는 반대의 경우에도 똑같은 응답을 해야 하는데 String 클래스는 CaseInsensitiveString 클래스를 알지 못하기 때문에 s.equals(cis)는 false가 나온다. (대칭성 위배)

추이성(transitivity)

첫 번째 객체와 두 번째 객체가 같고 두 번째 객체와 세 번째 객체가 같다면 첫 번째 객체와 세 번째 객체 또한 같아야 한다.

class Point {

  private int y;
  private int x;

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

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

class ColorPoint extends Point {
  private final Color color;
  
  ColorPoint(int x, int y, Color color) {
    super(x, y);
    this.color = color;
  }
}

ColorPoint는 Point 클래스를 상속받아 Color 필드를 추가했다. 이때 ColorPoint에서는 equals를 재정의하지 않았기 때문에 Point로부터 상속받은 equals를 사용하게 되는데 그럼 Color 정보는 무시한 채 비교를 수행한다.

그래서 ColorPoint에서 equals 메 서드를 재정의했다.

class ColorPoint extends Point {

  private final Color color;

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

하지만 이방식의 경우는 대칭성이 지켜지지 못한다.

    Point point = new Point(1, 2);
    ColorPoint cp = new ColorPoint(1, 2, Color.RED);

    point.equals(cp); // true
    cp.equals(point); // false

대칭성을 지켜주기 위해 equals를 수정해 보았다.

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

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

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

구체 클래스를 확장해 새로운 값을 추가하면서 equals 규약을 만족시킬 방법은 존재하지 않는다.
대신 컴포지션을 사용해서 상위 클래스에 값을 추가할 수는 없지만 상속으로 지켜지지 못했던 규약들을 지킬 수 있다. (물론 상속에서도 하위 클래스에서 필드를 추가하지 않는다면 규약 지킬 수 있음.)

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

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

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

추상 클래스의 하위 클래스라면 equals 규약을 지키면서도 값을 추가할 수도 있다. 상위 클래스를 직접 인스턴스로 만들 수 없다면 문제가 발생하지 않는다.

일관성(consistency)

두 객체가 같다면(둘 다 모두 수정되지 않는 한) 앞으로도 영원히 같아야 한다는 뜻이다.
즉 클래스가 불변이든 가변이든 equals의 판단에 신뢰할 수 없는 자원이 끼어들게 해서는 안 된다.
ex) 외부 API 이용해서 equals 구현, 외부 API 결과에 따라 equals 결과도 달라지게 됨.

null-아님

NullPointerException을 던지는 것도 허용하지 않는다.
그리고 명시적 null 검사보다는 묵시적 null 검사가 낫다.

// bad
    if (o == null) {
      return false;
    }
    ...

// good
    if (!(o instanceof ColorPoint)) {
      return false; // null일 경우 false 반환, 이 부분이 없으면 아래 코드에서 CaseException이 발생하기 때문에 이 코드가 반드시 필요하다. 
    }
    ColorPoint cp = (ColorPoint) o; // null일 경우 CaseException이
    return cp.point.equals(point) && cp.color.equals(color);