[이펙티브자바 3판] ITEM10. equals는 일반 규약을 지켜 재정의하라

이번장의 핵심은...

꼭 필요한 경우가 아니면 equals를 재정의하지 말자

많은 경우 Object의 equals가 여러분이 원하는 비교를 정확히 수행해준다

재정의해야 할 때는 그 클래스의 핵심 필드 모두 빠짐 없이,

아래에 설명되어 있는 5가지 규약을 확실히 지키고 있는지 비교하자

---

equals() vs hashCode()

equals() : 두 객체의 내용이 같은지, 논리적 동등성을 비교하는 것이다

hashCode() : 두 객체가 같은 객체인지, 동일성을 비교할 수 있다

 

equals()는 이럴 땐 재정의하지 말자

1. 각 인스턴스가 본질적으로 고유할 때 

즉, 값을 표현하는게 아니라 동작하는 개체를 표현하는 클래스 

ex) Thread -> Object의 equals 메서드는 이러한 클래스에 딱 맞게 구현

 

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

인스턴스들 사이 따로 값을 비교할 필요가 없다면 재정의하지말자

 

3. 상위 클래스에서 재정의한 equals가 하위 클래스에도 딱 맞아 떨어질 때

Set 구현체는 AbstractSet이 구현한 equals를 상속받아 사용

 

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

위험을 철저히 회피하는 스타일이면 equals 호출을 금지시키자

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

 

equals를 언제 재정의?

객체 식별성이 아닌 논리적 동치성을 확인해야 할 때!

주로 값 클래스이다 (Integer, String .. )

equals가 논리적 동치성을 확인하도록 재정의 해두면 값을 비교할 수 있다

값 클래스라 해도,

같은 인스턴스가 둘 이상 만들어지지 않음을 보장하는 인스턴스 통제 클래스라면 equals를 재정의하지 않아도 된다

(인스턴스 통제 클래스 : Enum, 반복되는 요청에 같은 객체를 반환하는 식 (싱글턴))

 

equals 재정의할 때 따라야하는 일반 규약 (Object 명세에 적힌 규약)

Object에서 말하는 동치관계는 뭐야?

집합을 서로 같은 원소들로 이뤄진 부분집합으로 나누는 연산을 말한다

이 부분집합을 동치 클래스라고 한다 

equals 메서드가 쓸모 있을려면 모든 원소가 같은 동치류에 속한 어떤 원소와도 교환할 수 있어야 한다

x, y는 nulll이 아닌 모든 참조 값이고, 아래를 만족해야 한다

 

1. 반사성 : x.equals(x)  -> true

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

 

2. 대칭성 : x.equals(y)가 true이면 y.equals(x)도 true

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

A객체의 equals는 대소문자를 구분하고, B객체의 equals는 대소문자를 구분하지 않으면 어길 수 있다

 

3. 추이성 : x.equals(y)가 true이고, y.equals(z)도 true 이면, x.equals(z)도 true

객체와 B객체가 같고, B객체와 C객체가 같다면, A와 C객체도 같아야 한다

 

4. 일관성 : x.equals(y)를 반복해서 호출하면 항상 true or false

두 객체가 같다면 앞으로도 영원히 같아야 한다는 뜻이다 (어느 하나 수정되지 않는 한)

가변 객체는 비교 시점에 따라 서로 다를 수도 같을 수도 있는 반면,

불변 객체는 한번 다르면 끝까지 달라야 한다

클래스가 불변이든 가변이든 equals의 판단에 신뢰할 수 없는 자원이 끼어들게 해서는 안 된다

→ 이 제약을 어기면 일관성 조건을 만족시키기가 아주 어려움

 

ex) java.net.URL의 equals는 주어진 URL과 매핑된 호스트의 ip 주소를 이용해 비교

네트워크를 통해야 하는데, 그 결과가 항상 같다고 보장할 수 없음

이런 문제를 피하려면 equals는 항시 메모리에 존재하는 객체만을 사용한 결정적 계산만 수행하도록 한다

 

5. null이 아님 : x.equals(null)은 false

모든 객체가 null이 아니라는 뜻이다

입력이 null인지 확인해 자신을 보호해야한다

// 명시적 null 검사 - 필요 없음
@Override public boolean equals(Object o) {
	if(o==null) return false;
}
// 묵시적 null - 이쪽이 낫다
@Override public boolean equals(Object o) {
	if(!(o instanceof MyType)) return false;
	MyType mt = (MyType) o;
}

따로 null 체크하지 않아도 null이면 타입 확인 단계에서 false를 반환한다 

 

한 예로 위의 5가지 규약을 살펴보자

상위 클래스에 없는 새로운 필드를 하위 클래스에 추가하는 상황을 생각해보자

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

이제 이 두개를 비교하는 코드를 보면,

// 잘못된 코드 (대칭성 위배)
@Override public boolean equals(Object o) {
  if(!(o instanceof ColorPoint)) return false;
  return super.equals(o) && ((ColorPoint)o).color = color;
}
// -> Point의 equals는 색상을 무시하고, 
// ColorPoint의 equals는 입력 매개변수의 클래스 종류가 다르므로 매번 false를 반환할 것

비교 대상이 또 다른 ColorPoint 객체이고, 

super.equals()를 호출할 때, 입력 매개변수의 클래스 종류가 달라서 매번 false를 반환할 것이다

예를 들면,

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와 비교할 때는 색상을 무시하도록 하면 어떨까?

// 잘못된 코드 (추이성 위배)
@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 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

대칭성은 지켜주지만, 추이성이 깨져버린다

또한, 이 방식은 무한 재귀에 빠질 위험이 있다

하위 클래스 SmellPoint를 하나 더 만들어 equals를 같은 방식으로 구현했다면,

myColorPoint.equals(mySmellPoint)를 호출하면 StackOverflowError를 일으킨다

 

이런 현상은 모든 객체 지향 언어의 동치관계에서 나타나는 근본적인 문제이다

구체 클래스를 확장해 새로운 값을 추가하면서 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 객체로써 활용될 수 있어야 한다

예를 들어, 주어진 점이 단위 원 안에 있는지 판별하는 메서드가 필요하다면?

// 단위 원 안의 모든 점을 포함하도록 unitCircle를 초기화한다
private static final Set<Point> unitCircle = Set.of(
	new Point(1,0), new Point(0,1),
	new Point(-1,0), new Point(0,-1)
);

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

이렇게 간단히 만들 수 있다

이제 값을 추가하지 않는 방식으로 Point를 확장해보자

만들어진 인스턴스 개수를 생성자에서 세보자

public class CounterPoint extends Point {
	private static final AtomicInteger counter = new AtomicInteger();
	public CounterPoint(int x, int y) {
		super(x,y);
		counter.incrementAndGet();
	}
	public static int numberCreated() {
		return counter.get();
	}
}

CounterPoint 인스턴스를 onUnitCircle() 메서드에 넘기면, 

(Point 클래스의 equals를 getClass를 사용했다면)

x, y 값과는 무관하게 false를 반환할 것이다

onUnitCircle에서 사용한 Set을 포함하여 대부분의 컬렉션은 이 작업에 equals 메서드를 이용하는데,

CounterPoint의 인스턴스는 어떤 Point와도 같을 수 없기 때문이다

반면,

Point의 equals를 instanceof 기반으로 올바로 구현했다면

CounterPoint 인스턴스를 건네줘도 onUnitCircle 메서드가 제대로 동작할 것이다

 

구체 클래스의 하위 클래스에서 값을 추가할 방법은 없지만, 우회 방법이 하나 있다

'상속 대신 컴포지션을 사용하라'

ColorPoint extend Point (or Color) 가 아닌 hava Point, Color (상속 관계가 아닌 구성을 의미)

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

자바 라이브러리에도 구체 클래스를 확장해 값을 추가한 클래스가 종종 있음

ex) java.sql.Timestamp는 java.util.Date를 확장한 후, nanoseconds 필드를 추가

그 결과 Timestamp의 equals 대칭성을 위배하며,

Date 깨체와 한 컬렉션에 넣거나 서로 섞어 사용하면 엉뚱하게 동작할 수 있음

자칫 실수하면 어려운 이상한 오류를 경험할 수 있으니 주의하자!

(Timestamp를 이렇게 설계한 것은 실수니 절대 따라 해서는 안된다)

 

추상 클래스의 하위 클래스에서라면 equals 규약을 지키면서도 값을 추가할 수 있다

(아이템 23 - 태그 달린 클래스보다 클래스 계층구조를 활용하라)

- 아무런 값을 갖지 않는 추상 클래스인 Shape을 위에 두고,

이를 확장하여 radius 필드를 추가한 Circle 클래스와, length와 width 필드를 추가한 Rectangle 클래스를 만들 수 있다. 상위 클래스를 직접 인스턴스로 만드는 게 불가능하다면 지금까지 이야기한 문제들은 일어나지 않는다

 

종합하여 양질의 equals() 메서드 구현 방법을 단계별로 정리해보자

1. == 연산자를 사용해 입력이 자기 자신의 참조인지 확인 (자기 자신이면 true)

단순한 성능 최적화용으로 비교 작업이 복잡한 상황일 때 좋다

 

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

가끔은 그 클래스가 구현한 특정 인터페이스가 될 수도 있다

어떤 인터페이스는 자신이 구현한 클래스끼리도 비교할 수 있도록 equals 규약을 수정하기도 한다

이런 인터페이스를 구현한 클래스라면 equals에서 해당 인터페이스를 사용해야 한다

Set, List, Map, Map.Entry 등의 컬렉션 인터페이스들이 여기 해당함

 

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

앞의 2번에서 instanceof 검사를 했으므로 100% 성공

 

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

모든 필드가 일치하면 true, 하나라도 다르면 false

2번에서 인터페이스를 사용했다면, 입력의 필드 값을 가져올 때도 그 인터페이스의 메서드를 사용해야 한다

타입이 클래스라면 해당 필드에 직접 접근할 수도 있다

 

equals를 다 구현했다면 3가지만 자문해보자

1. 대칭적인가?

2. 추이성이 있는가?

3. 일관적인가?

전형적인 equals() 메서드의 예

public final 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 equlas(Object o) {
		if (o==this) return true;
		if (!(o instanceof PhoneNumber)) return false;
		PhoneNumber pn = (PhoneNumber) o;
		return pn.lineNum == lineNum && pn.prefix == prefix && pn.areaCode == areaCode;
	}
}

마지막 주의사항

equals를 재정의할 땐 hashCode도 반드시 재정의하자 (아이템 11)

 

너무 복잡하게 해결하려 들지 마라

필드들의 동치성만 검사해도 equals 규약을 어렵지 않게 지킬 수 있다

 

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

// 잘못된 예 (입력 타입은 반드시 Object)
public boolean equals(MyClass o) {...}

이건 재정의가 아닌, 다중정의한 것이다

타입을 구체적으로 명시한 equals는 오히려 해가 된다.

@Override를 적으면 컴파일되지 않을 것이다

 

이러한 작업을 대신해줄 오픈소스가 있다

구글 - AutoValue 프레임워크

또한 대다수의 IDE도 같은 기능을 제공