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

Jimin Lim·2022년 3월 13일
Java
0

Effective Java

목록 보기
10/38
post-thumbnail
post-custom-banner

아이템10

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

Object에서 final이 아닌 메서드(equals, hashCode, toString, clone, finalize)는 모두 Overriding을 염두에 두고 설계된 것이라 재정의 시 지켜야 하는 일반 규약이 명확히 정의되어 있다.

equals를 재정의하지 않는 경우

equals method는 아래의 상황 중 하나라면 재정의하지 않는 것이 최선이다.

  1. 각 인스턴스가 본질적으로 고유하다.
    값(Integer)을 표현하는 게 아니라 동작하는 개체를 표현하는 클래스(Thread)는 equals 메서드에 딱 맞게 구현되었다.
  2. 인스턴스의 logical equality를 검사할 일이 없다.
    java.util.regax.Pattern은 equals를 재정의해 두 Pattern의 인스턴스가 같은지 비교하는 논리적 동치성을 검사한다. 하지만 설계자가 클라이언트가 이 방식을 원하지 않거나 애초에 필요하지 않다고 판단한다면 Object의 기본 equals만드로 해결된다.
  3. 상위 클래스에서 재정의한 equals가 하위 클래스에도 들어맞는다.
    Set 구현체는 AbstractSet이 구현한 equals를 상속받아 쓴다.
  4. 클래스가 private이거나 package-private이고 equals 메서드를 호출할 일이 없다.
    만약 equals가 실수로 호출되는 것을 막고 싶다면 다음과 같이 에러를 던지면 된다.
    @Override public boolean equals(Object o) {
	throw new AssertionError(); // 호출 금지!
}

equals를 재정의하는 경우

그렇다면 equals를 재정의해야 할 때는 언제일까?
물리적으로 같은지가 아니라 논리적 동치성을 확인해야 하는데, 상위 클래스의 equals가 논리적 동치성을 비교하도록 재정의되지 않았을 때다.

값 클래스

예를 들어, 값 (Integer, String) 클래스의 경우 객체가 같은지가 아니라 값이 같은지를 주로 알고 싶어 할 것이다. equals로 논리적 동치성을 확인하도록 재정의해두면, 값을 비교하고, Map의 키와 Set의 원소로도 사용할 수 있게 된다.
하지만 값 클래스라 해도 값이 같은 인스턴스가 둘 이상 만들어지지 않음을 보장하는 인스턴스 통제 클래스라면 재정의하지 않아도 된다.논리적으로 같은 인스턴스가 2개 이상 만들어지지 않으니 논리적 동치성과 객체 식별성이 사실상 같은 의미가 되기 때문이다.

equals 메서드를 재정의할 때의 일반 규약

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다.

반사성

객체는 자기 자신과 같아야 한다.

대칭성

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

public final class CaseInsensitiveString{
  private final String s;

  public CaseInsensitiveString(String s){
    this.s = Obejcts.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을 알고 있지만, 그 반대는 알지 못한다. 따라서 아래와 같이 양방향으로 일치하지 않는다.

CaseInsensitiveString cis = new CaseInsensitiveString("Polish");
String s = "polish";

cis.equals(s); // true
s.equals(cis); // false

따라서 String과의 연동을 하지 않고 CaseInsensitiveString끼리 비교하도록 해야 한다.

추이성

A == B and B == C 라면 A == C 여야 한다.

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를 확장한 코드가 color를 추가한다면 원래의 equals 메소드에서는 color를 무시하도록 되어있다.
따라서 비교 대상이 또 다른 ColorPoint이고 위치와 색상이 같을 때만 true를 반환하는 equals를 생각해본다면 다음과 같다.

//color 비교 포함
    @Override public boolean equals(Object o) {
    	if(!o instanceof ColorPoint)
    		return false;
    	return super.equals(o) && ((ColorPoint) o).color == color;
    }
//비교 결과
      Point p = new Point(1,2);
      ColorPoint cp = new ColorPoint(1,2, Color.RED);
      p.equals(cp);    // true
      cp.equals(p);    // false

만약 여기서 ColorPoint.equals가 Point와 비교할 때 color를 무시하게 한다면 다음과 같다.

//ColorPoint.equals(point)일 때 color를 무시 
    @Override public boolean equals(Obejct 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;
    }
//결과
      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

이전 방식의 문제인 대칭성은 해결하였으나 추이성은 위배하게 된다.

그렇다고 아래와 같이 instanceof 검사 대신 getClass 검사를 하라는 것은 아니다.

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

이렇게 구현한다면 같은 구현 클래스의 객체와 비교할 때만 true를 반환한다. 리스코프 치환 원칙에 따르면 어떤 타입의 모든 메서드가 하위 타입에서도 똑같이 잘 작동해야 한다.

우회 방법

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(){ // view 메서드 패턴
    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);
  }
}

Point를 상속하는 대신 필드로 추가하고 Point를 반환하는 방법을 사용하였다.

일관성

두 객체가 같다면 앞으로도 영원히 같아야 한다.
예를 들어 java.net.URL의 경우, equals는 주어진 URL과 매핑된 호스트의 IP주소를 이용해 비교하도록 되어있다. 하지만 호스트 이름을 IP주소로 바꾸려면 네트워크를 통해야 하므로 그 결과가 항상 같다고 보장할 수 없다.

null-아님

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

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

동치성을 검사하려면 intanceof로 타입을 확인한 후, 타입을 변환시키기 때문에 o == null 로 확인할 필요가 없다.

equals 메서드 구현 방법

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

  2. instanceof 연산자로 입력이 올바른 타입인지 확인한다.
    가끔 클래스가 구현한 특정 인터페이스를 비교하는 경우가 있다. 이때, 인터페이스를 구현한 클래스라면 equals에서 (클래스가 아닌) 해당 인터페이스를 사용해야한다.
    예를 들어 Set, List, Map, Map.Entry 등 컬렉션 인터페이스들이 이 경우에 해당한다.

  3. 입력을 올바른 타입으로 형변환 한다.
    2번에서 instanceof 연산자로 입력이 올바른 타입인지 검사를 했기에 이 단계는 100% 성공한다.

  4. 입력 객체와 자기 자신의 대응되는 '핵심' 필드들이 모두 일치하는지 하나씩 검사한다.
    모두 일치해야 true를 반환한다. 2단계에서 인터페이스를 사용했다면, 입력의 필드 값을 가져올 때도 그 인터페이스의 메서드를 사용해야 한다.

전형적인 equals 메서드의 예

public 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) { //1번, 자기 자신 참조인지 확인
            return true;
        }

        if(!(o instanceof PhoneNumber)) { //2번, instanceof 확인 
        	return false;
        }

        PhoneNumber pn = (PhoneNumber) o; //3번 형변환
        //4번 핵심 필드 일치하는지 확인
        return pn.lineNum == lineNum && pn.prefix == prefix
                && pn.areaCode == areaCode;
    }
}

주의 사항

  • float과 double을 제외한 기본 타입 필드는 ==연산자로 비교한다.
  • 참조 타입 필드는 각각 equals 메서드로, float와 double 필드는 각각 정적 메서드인 Float.compare(float, float)로 비교한다.
  • null도 정상 값으로 취급하는 참조 타입 필드의 경우, 정적 메서드인 Objects.equals(Object, Object)로 비교해 NullPointerExcepion 발생을 예방한다.
  • 예시의 CaseInsentiveString 처럼 복잡한 필드를 가진 클래스는 표준형을 저장해둔 후 표준형끼리 비교하는 것이 훨씬 경제적이다.
  • 최상의 성능을 바란다면 비용이 싼 필드를 먼저 비교하자.
  • equals를 재정의할 땐 hashCode도 재정의하자
  • Object 외의 타입을 매개변수로 받는 equals 메서드는 선언하지 말자
  • AutoValue 프레임워크 - equals 테스트해주는 오픈 소스
  • 꼭 필요한 경우가 아니면 equals를 재정의하지 말자
profile
Jimin Lim
💻 ☕️ 🏝 🍑 🍹 🏊‍♀️
이전 포스트

[아이템 9] try-finally 대신 try-with-resources를 사용하라

다음 포스트

[아이템 11] equals를 재정의하려거든 hashCode도 재정의하라

post-custom-banner

0개의 댓글