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

Dayeon myeong·2022년 3월 6일
0

이펙티브자바

목록 보기
6/15

equals 재정의하지 않아도 되는 경우

equals는 반드시 재정의해야하는 것은 아니다. 잘못 재정의 할 경우 오히려 여러 함정과 문제가 있다.

  • 각 인스턴스가 본질적으로 고유한 경우
    • 값을 표현하는 것이 아니라 동작하는 개체를 표현하는 클래스인 경우
    • 예를 들어 Thread 클래스가 있을 때, Object의 equals 메서드로도 충분하다.
    • controller, repository, service 등도 예시로 들 수 있을 듯
  • 논리적 동치성(logical equality)을 검사할 필요가 없는 경우
    • 두 객체의 내부 값들이 일치한지 확인 안해도 될 경우
    • 예를 들어서 두 개의 Random 객체가 같은 난수열을 만드는지 확인하는 것은 의미가 없다.
  • 상위 클래스에서 재정의한 equals가 하위 클래스에도 딱 들어맞는 경우
    • 대부분의 set 구현체는 AbstractSet이 구현한 equals를 상속받아 쓰고, List 구현체들은 Abstract 구현체로부터, Map 구현체들은 AbstractMap 으로부터 상속받아 그대로 쓴다.
  • private이나 패키지 전용 클래스(package private)라서 클래스의 equals 메서드가 절대 호출되지 않아야하는 경우
    • 이런 경우에는 equals 메서드를 반드시 오버라이딩해서 호출되지 않도록 막아야 한다.

이런 경우 차라리 기본 equals를 써라. 기본 equals는 ==과 마찬가지로 객체의 referece value 참조값(주소값) 자체를 비교한다. 재정의하여 필드의 내용 비교가 가능하다.

public boolean equals(Object obj) {
    return (this == obj);
}

equals를 재정의해야하는 경우

객체 식별성(object identity; 두 객체가 물리적으로 같은가)이 아닌 '논리적 동치성'을 확인해야 할 경우 재정의해야한다.

논리적 동치성이란 주소값이 아닌 값 자체, 필드 값 자체가 같은것이라고 보면 될 것 같다.

Integer,String 같은 값 클래스는 두 객체의 물리적인 주소값이 일치하는지가 궁금한 게 아니고 값이 일치하는지를 알고 싶은것이다. equals를 재정의해두면 값 비교는 물론 Map의 키와 Set의 원소로도 사용이 가능하다.

equals 재정의 할 때 지켜야 할 규약 : 동치관계

Object 명세에서 말하는 동치관계란 무엇일까?

집합을 서로 같은 원소들로 이루어진 부분집합으로 나누는 연산. 이 부분집합을 동치 클래스라 한다.
equals 메서드가 쓸모 있으려면 모든 원소가 같은 동치클래스에 속한 어떤 원소와도 교환이 가능해야 한다.

내 생각에는 Integer, String같은 값 클래스의 경우 값이 서로 일치하여 교환되도 무관하고, 혹은 클래스의 경우에는 두 객체의 멤버 변수들을 서로 교환되도 이상이 없는 것이라 보면 될 것 같다.

  • 반사성(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다.

규약 1 : 반사성

null이 아닌 모든 참조 값 x에 대해, x.equals(x)는 true다.

반사성은 객체는 자기 자신과 같아야 한다.

반사성을 어긴다면 인스턴스를 컬렉션에 넣은 다음 contains 메서드를 호출하면 방금 넣은 인스턴스가 없다고 답할 것이다. 왜냐하면 contains 메서드는 내부적으로 equals를 사용하기 때문이다.

(o==null ? e==null : o.equals(e))

규약 2 : 대칭성

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

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

규약 3 : 추이성

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

추이성은 첫 번째 객체와 두 번째 객체가 같고, 두 번째 객체와 세 번째 객체가 같아면, 첫 번째 객체와 세 번째 객체도 같아야 한다.

상위 클래스에 없는 새로운 필드를 하위 클래스에 추가하며 equals를 재정의할 때 추이성 문제가 자주 발생한다. 왜냐하면 하위 클래스에는 새로운 필드들이 더 추가된 것이라 상위 클래스와 하위 클래스의 필드들이 일치하지 않기 때문이다.

equals를 잘못 재정의 했을 경우 : 핵심 필드를 비교하지 않았을 때

Point 클래스와, 여기에 색상 필드를 추가한 하위 클래스 ColorPoint가 있다고 하자.

equals 메서드는 어떻게 해야할까? 그대로 둔다면 Point의 구현이 상속되어 색상 필드는 무시한채 비교를 수행한다. 중요한 정보인 color는 비교하지 못한다.

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

	...
}

equals를 잘못 재정의 했을 경우 : 대칭성 위배

다음 코드처럼 비교 대상이 또다른 ColorPoint이고 위치와 색상이 같을 때만 true를 반환하는 equals를 생각해보자. 이 메서드는 일반 Point를 ColorPoint에 비교한 결과와 그 둘을 바꿔 비교한 결과가 다를 수 있다.

Point에서의 equals는 생상을 무시하여 ture를 반환하고,

ColorPoint에서의 equals는 입력 매개변수의 클래스 조류가 다르다며 매번 false를 반환할 것이다. 

    @Override public boolean equals(Object o) {
    	if(!o instanceof ColorPoint)
    		return false;
    	return super.equals(o) && ((ColorPoint) o).color == color;
    }
    public static void main(){
      Point p = new Point(1,2);
      ColorPoint cp = new ColorPoint(1,2, Color.RED);
      p.equals(cp);    // true
      cp.equals(p);    // false
    }

ColorPoint의 equals는 입력 매개변수의 클래스 종류가 다르다며 매번 false만 반환할 것이다.

equals를 잘못 재정의 했을 경우 : 추이성 위배

그럼 아예 ColorPoint와 Point와 비교할 때는 색상을 무시하도록 하면 해결이 될까??

이 방식은 색상을 무시하고 비교하니 대칭성은 지켜주지만 추이성을 깨버린다!!!!

    @Override public boolean equals(Obejct o){
      if(!(o instanceof Point))
        return false;
      if(!(o instanceof ColorPoint)) //o가 일반Point면 색상을 무시하고 비교한다!!
        return o.equals(this);
      return super.equals(o) && ((ColorPoint) o).color == color;
    }
    public static void main(){
      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 

		//추이성 위반
    }

p1.equals(p2);와 p2.equals(p3);는 true를 반환하는데, p1.equals(p3);는 false를 반환해 추이성에 위배된다.point와 colorpoint끼리의 비교는 색상을 무시하여 true를 반환햇지만, colorpoint p1 와 colorpoint p3비교에서는 색상까지 비교해버려 false를 반환한다.

equals를 잘못 재정의 했을 경우 : 무한 재귀

이 방식은 무한 재귀에 빠질 위험도 있다. Point의 또 다른 하위 클래스로 SmellPoint를 만들고 equals는 같은 방식으로 구현했다고 해보자. 그런다음 colorPoint.equals(smellPoint)를 호출하면 stackoverflowError를 일으킨다.

colorPoint의 equals를 처음 사용하면 같은 클래스가 아닐경우 상대편 클래스의 equals로 비교한다. smellPoint의 equals를 호출하게 되는데, smellPoint의 equals에서도 같은 클래스가 아닐 경우 상대편 클래스의 equals를 비교하며 무한 반복한다.

    //SmellPoint.java의 equals
    @Override public boolean equals(Obejct o){
      if(!(o instanceof Point))
        return false;
      if(!(o instanceof SmellPoint)) // 상대편의 equals를 호출!!
        return o.equals(this);
      return super.equals(o) && ((SmellPoint) o).color == color;
    }
    public static void main(){
      ColorPoint p1 = new ColorPoint(1,2, Color.RED);
      SmellPoint p2 = new SmellPoint(1,2);
      p1.equals(p2);
      // 1. ColorPoint의 equals: 2번째 if문 때문에 SmellPoint의 equals로 비교
      // 2. SmellPoint의 equals: 2번째 if문 때문에 ColorPoint의 equals로 비교
      // 3. 1~2 무한 재귀로 인한 StackOverflow Error
    }

사실 구체 클래스를 확장해 새로운 값을 추가하면서 equals 규약을 만족시킬 방법은 존재하지 않는다.

equals를 잘못 재정의 했을 경우 : 리스코프 치환 법칙 위배

리스코프 치환 법칙 - 상위 타입의 모든 메서드가 하위 타입에도 똑같이 잘 작동해야 한다.

그렇다고 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를 반환한다.Point 의 하위 클래스는 정의상 여전히 Point이므로 어디서든 Point로써 활용될 수 있어야 한다. 하지만 이 방식에서는 그렇지 못하고 오직 구현 클래스가 같을 때만 비교를 진행한다.

예를 들어 주어진 점이 반지름 1인 원안에 있는지를 판별하는 메서드가 필요하다고 해보자. 

private static final Set<Point> unitCircle = Set.of(
	new Point(1,0), new Point(0,1),
	new Point(-1,0), new Point(,-1));

public static boolean onUnitCircle(Point p) {
	return unitCircle.contains(p);
}

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

그리고 값을 추가하지 않는 방식으로 구체 클래스를 확장해 인스턴스의 개수를 생성자에서 세는 클래스를 만든다.

public class CounterPoint extends Pont {
	private static final AtomicInteger counter = new AomicInteger();

	public CounterPoint(int x, int y) {
		super(x,y);
		counter.incrementAndGet();
	}

	public static int numberCreated() {return counter.get();}

}

리스코프 치환 원칙에 따르면 어떤 타입에 있어 중요한 속성이라면 그 하위 타입에서도 마찬가지로 중요하다. 따라서 그 타입의 모든 메서드가 하위 타입에서도 똑같이 잘 작동해야 한다. 이는 곧  Point의 하위 클래스는 여전히 Point이므로 어디서든 Point로써 활용될 수 있어야 한다는 뜻이다.

그런데 CounterPoint의 인스턴스를 onUnitCircle 메서드에 넘기면 어떻게 될까? Point equals를 getClass를 사용해 작성했기 때문에 onUnitCircle은 false를 반환한다. CounterPoint인스턴스의 x,y값과는 무관하게 말이다.

왜냐하면 컬렉션 구현체에서 주어진 원소를 담고 있는지 확인하는 contains 메서드에서는 이 작업에 equals를 사용하는데, 현재 equals는 getClass를 기반으로 재정의되어있다. 따라서 CounterPoint의 인스턴스는 getClass때문에 어떤 Point와도 같을 수 없기 때문이다.

만약에 getClass대신에 instanceof기반으로 equals를 올바르게 구현했다면 컬렉션의 contains 메서드에서 CounterPoint인스턴스를 건네줘도 onUnitCircle 메서드는 제대로 동작할 것이다.

해결방법 : 상속대신 컴포지션 사용하기

지금까지 구체 클래스를 확장해 새로운 값을 추가하면서 equals 규약을 만족시키지 못했었다. 문제를 해결하는 방법은 상속 대신에 컴포지션을 사용하는 것이다(아이템 18)

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

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

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

규약 4 : 일관성

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

일관성이란 두 객체가 같다면 (어느 하나 혹은 두 객체 모두가 수정되지 않는 한) 앞으로도 영원히 같아야 한다는 뜻이다.

클래스가 불변이든 가변이든 equals의 판단에 신뢰할 수 없는 자원이 끼어들게 해서는 안 된다.
예를 들어, java.net.URL의 equals는 주어진 URL과 매핑된 호스트의 IP주소를 이용해 비교하는데,호스트 이름을 IP주소로 바꾸려면 네트워크를 통해야 하므로 그 결과가 항상 같다고 보장할 수 없다.

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

규약 5 : null 아님

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

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


//묵시적 null 검사
@Override
public boolean equals(Object o) {
  if(!(o instanceof MyType)) {
      return false;
  }
  MyType myType = (MyType) o;
}

입력이 null이면 타입 확인 단계에서 false를 반환하므로 null 검사를 명시적으로 하지 않아도 된다.

종합적인 equals 메서드 재정의 방법

  1. ==연산자를 사용해 입력이 자기 자신의 참조인지 확인한다.자기 자신이면 true를 반환한다. 단순한 성능 최적화용으로 비교 작업이 복잡한 상황일 때 값어치를 한다.**
  2. instanceof 연산자로 입력이 올바른 타입인지 확인한다.
    • 가끔 해당 클래스가 구현한 특정 인터페이스를 비교할 수도 있다. 어떤 인터페이스는 자신을 구현한 서로 다른 클래스들끼리도 비교할 수 있도록 equals를 정의하기도 한다. 이런 인터페이스를 구현한 클래스라면 equals에서 클래스가 아닌 해당 인터페이스를 사용해야한다
    • ex) Set, List, Map, Map.Entry 등 컬렉션 인터페이스들
  3. 입력을 올바른 타입으로 형변환 한다.2번에서 instanceof 연산자로 입력이 올바른 타입인지 검사 했기 때문에 이 단계는 100% 성공한다.
  4. 입력 객체와 자기 자신의 대응되는 핵심 필드들이 모두 일치하는지 하나씩 검사한다.모두 일치해야 true를 반환한다.
  5. 구체 클래스를 확장해 새로운 값을 추가하면서 equals 규약을 만족시키기 위해서는 상속보다는 컴포지션을 사용해라.

기타 사항

  • 기본 타입: == 연산자 비교
  • 참조 타입: equals 메서드로 비교
  • float, double 필드: 정적 메서드 Float.compare(float, float)와 Double.compare(double, double)로 비교한다.
    • 왜냐하면 Float.NaN, -0.0f, 특수한 부동소수 값 등을 다루기 때문이다.
    • Float.equals(float)나 Double.equals(double)을 사용하는 것도 안된다.왜냐하면 이 메서드들은 오토 박싱을 수반해 성능상 좋지 않기 때문이다.
  • 배열 필드: 원소 각각을 지침대로 비교한다. 모두가 핵심 필드라면 Arrays.equals()를 사용한다.
  • null 정상값 취급 방지: Object.equals(object, object)로 비교하여 NullPointException 발생을 예방한다.
  • 비교하기 복잡한 필드를 가진 클래스: 필드의 표준형(canonical form)을 저장한 후 표준형끼리 비교
  • 필드의 비교 순서는 equals 성능을 좌우한다.: 다를 가능성이 크거나 비교하는 비용이 싼 필드부터 비교파생 필드가 객체 전체 상태를 대표하는 경우, 파생 필드부터 비교
  • *equals를 재정의할 땐 hashCode도 반드시 재정의하자
  • 너무 복잡하게 해결하려 들지 말자.
  • Object 외의 타입을 매개변수로 받는 equals 메서드는 선언하지 말자.public boolean equals(MyClass o): 입력 타입이 Object가 아니므로 오버로딩한 것이다.(다중 정의)
public boolean equals(Myclass o) {//오버라이딩한게아님. 다중정의한거임.
... 
}

결론

꼭 필요한 경우가 아니면 equals를 재정의하지 말자. 많은 경우에 Object의 equals가 여러분이 원하는 비교를 정확히 수행해준다. 재정의해야 할 때는 그 클래스의 핵심 필드 모두를 빠짐없이, 다섯 가지 규약을 확실히 지켜가며 비교해야 한다.

참고

이펙티브 자바

자바봄 블로그
https://javabom.tistory.com/2?category=833277

profile
Dayeon myeong
부족함을 당당히 마주하는 용기
이전 포스트

[ 이펙티브 자바 ] 아이템 11 equals를 재정의하려거든 hashCode도 재정의하라

다음 포스트

[ 이펙티브 자바 ] 아이템 18 상속보다는 컴포지션을 사용하라

0개의 댓글