10. equals는 일반 규악을 지켜 재정의하라
이전 포스팅에 이어, Object Equlas 명세 중 하나인 추이성 부터 포스팅을 시작하도록 하겠습니다.
추이성은, A=B 이고, B=C이면, A=C라는 의미입니다.
즉, 첫 번째 객체와 두 번째 객체가 같고, 두 번째 객체와 세 번째 객체가 같다면, 첫 번째 객체와 세 번째 객체도 같아야 한다는 의미입니다.
이 요건도 자칫하면 어기기가 쉽습니다. 예를 들어, 상위 클래스에는 없는 새로운 필드를 하위 클래스에 추가하는 상황을 가정하겠습니다. 즉, euals 비교에 영향을 주는 정보를 추가한 것입니다.
책의 예시처럼, 2차원에서의 점을 표현하는 클래스를 예로 들어보겠습니다.
package item10;
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를 확장하는 클래스를 만들겠습니다.
package item10;
import java.awt.*;
public class ColorPoint extends Point {
private final Color color; // 새로운 필드 추가
public ColorPoint(int x, int y, Color color) {
super(x, y);
this.color = color;
}
}equals 메서드는 어떻게 해야할까요? Point 클래스는 그저 새롭게 추가된 색상 정보는 무시한 채, x,y 좌표만 비교할 것입니다. 물론 규악을 어긴 것은 아니지만, Color라는 중요한 정보를 놓치게 되는 것입니다. 다음 예시처럼, 비교 대상이 또 다른 ColorPoint고, 위치와 색상이 같을 때 true를 반환하는 equals를 보겠습니다.
@Override
public boolean equals(Object o) {
if (!(o instanceof ColorPoint))
return false;
return super.equals(o) && ((ColorPoint) o).color == color;
}이 메서드는, 10-1 포스팅에서 예시를 든 것과 같이, 대칭성을 위반합니다.
Point를 ColorPoint에 비교한 결과와 그 둘을 바꿔 비교한 결과가 다를 수 있기 때문입니다.
Point의 equals는 색상을 무시하고, ColorPoint의 equals는 입력 매개변수의 클래스 종류가 다르다며 매번 false만 반환 할 것입니다.
Point p = new Point(1, 2);
ColorPoint cp = new ColorPoint(1, 2, Color.RED);
System.out.println("p.equals(cp) = " + p.equals(cp));
System.out.println("cp.equals(p) = " + cp.equals(p));p.equals(cp) = true
cp.equals(p) = false
Process finished with exit code 0예상한 것처럼, p.equals(cp)는 true를, cp.equals(p)는 false를 반환합니다.
그렇다면, ColorPoint.equals가 Point와 비교할 때, 색상을 무시하도록 하면 해결될까요?
@Override
public boolean equals(Object 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;
} ColorPoint p1 = new ColorPoint(1, 2, Color.RED);
Point p2 = new Point(1, 2);
ColorPoint p3 = new ColorPoint(1, 2, Color.BLUE);
System.out.println("p1.equals(p2) = " + p1.equals(p2));
System.out.println("p2.equals(p3) = " + p2.equals(p3));
System.out.println("p1.equals(p3) = " + p1.equals(p3));이 방식은 대칭성은 지켜주지만, 추이성을 깨버립니다.
p1과 p2, p2와 p3 비교에서는 색상을 무시하였지만, p1과 p3 비교에서는 색상까지 고려했기 때문입니다.
또한, 이 방식은 무한 재귀에 빠질 위험도 있습니다. Point의 또 다른 하위 클래스가 이싿고 가정하고, equals는 같은 방식으로 구현했다고 해봅시다. 그런 다음. ColorPoint.equals(XxxPoint)를 호출하면, 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로써 활용될 수 있어야 합니다. 그런데 이 방식에서는 그렇지 못합니다. 예ㅖ를 들어, 주어진 점이 단위 원 안에 있는지를 판별하는 메서드가 있다고 가정합시다.
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.contains(p);
}그리고, 값을 추가하지 않는 방식으로 Point를 확장하겠습니다.
package item10;
import java.util.Set;
import java.util.concurrent.atomic.AtomicInteger;
public class CounterPoint extends Point{
private static final AtomicInteger count = new AtomicInteger();
public CounterPoint(int x, int y) {
super(x, y);
count.incrementAndGet();
}
public static int numberCreated() {
return count.get();
}
}리스코프 치환 원칙은, 어떤 타입에 있어 중요한 속성이라면 그 하위 타입에서도 마찬가지로 중요합니다. 따라서, 그 타입의 모든 메서드가 하위 타입에서도 똑같이 잘 작동해야 합니다.
즉, "Pount의 하위 클래스는 정의상 여전히 Point이므로 어디서는 Point로 활용될 수 있어야 한다." 라는 의미입니다.
그런데, CounterPoint의 인스턴스를 onUnitCircle 메서드에 넘기면 어떻게 될까요?
CounterPoint cp = new CounterPoint(1, 2);
System.out.println("onUnitCircle(cp) = " + onUnitCircle(cp));onUnitCircle(cp) = false
Process finished with exit code 0Point 클래스의 equals를 getClass로 비교했다면, onUnitCircle는 false를 반환합니다. CounterPount의 x,y와는 무관하게 말입니다.
왜 그럴까요?
원인은, 컬렉션 구현체에서 주어진 원소를 담고 있는지를 확인하는 방법에 있습니다.
onUnirCircle에서 사용한 Set를 포함하여, 대부분의 컬렉션은 이 작업(contains)에 equals 메서드를 이용하는데, CounterPoint의 인스턴스는 어떤 Point와도 같을 수 없기 때문입니다. 반면 Point의 equals를 intanceOf 기반으로 올바로 구현했다면, CounterPoint의 인스턴스를 건네줘도 제대로 작동 할 것입니다.
10-1번에 포스팅한 contains 메서드를 참고하시면 될 것 같습니다.
구체 클래스의 하위 클래스에서 값을 추가할 방법은 없지만, 우회 방법이 하나 있습니다.
바로, "상속 대신 컴포지션을 사용하라"는 itme 18을 따르면 됩니다.
Point를 상속하는 대신, Pount를 ColorPoint의 private 필드로 두고, ColorPoint와 같은 위치의 일반 Point를 반환하는 뷰(view)메서드를 public로 추가하는 방식입니다.
package item10;
import java.awt.*;
import java.util.Objects;
public class ColorPoint extends Point {
private final Point point;
private final Color color;
public ColorPoint(int x, int y, Color color) {
super(x, y);
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);
}
}여기서 asPoint에 중점을 두어야 하는데, CounterPoint가 가진 Point의 속성을 반환하는 메서드입니다. 이것으로 구체 클래스의 하위 클래스에서, 마치 새로운 필드를 추가한 것 같은 효과를 줄 수 있습니다.
자바 라이브러리에도 구체 클래스를 확장해 값을 추가한 클래스가 종종 있습니다.
한 가지 예로, java.sql.Timestamp는 java.util.Date를 확장한 후 nanosecondes 필드를 추가했습니다. 결과로, Timestamp의 equals는 대칭성을 위배하며, Date 객체와 한 컬렉션에 넣거나 서로 섞어 사용하면 엉뚱하게 동작할 수 있습니다. 그래서, Timestamp의 API 명세에는, Date와 섞어 쓸 때의 주의사항을 언급하고 있습니다.
결과적으로, Timestamp를 이렇게 설계한 것은 실수니, 절대 따라해서는 안됩니다.
private int nanos;하위 클래스에서의 equals 규약을 지키면서도 값을 추가할 수 있는 아름다운 방법이 있는데, 바로 추상 클래스를 구현하는 것입니다.
"태그 달린 클래스보다는 클래스 계층 구조를 활용하라"(Item. 23)을 따르는 클래스 계층구조에서는 아주 중요한 사실이라고 합니다. 예를 들어, 아무런 값을 갖이 않는 추상 클래스 Shape를 두고, 이를 확장하여 radius 필드를 추가한 Circle, length와 width 필드를 추가한 Rectangle 클래스를 만들 수 있습니다.
즉, 상위 클래스를 직접 인스턴스로 만드는 것이 불가능하다면, 지금까지 이야기한 문제들은 일어나지 않습니다.
해당 포스팅은 Item. 23에서 포스팅 하도록 하겠습니다.
일관성은, 두 객체가 같다면 (어느 하나 혹은 두 객체가 모드 수정되지 않으면) 앞으로도 영원히 같아야 한다는 뜻입니다. 가변 객체는 비교 시점에 따라 서로 다를 수도, 같은 수도 있지만 불변 객체는 한번 다르면 끝까지 달라야합니다.
클래스를 작성할 때는, 불변 클래스로 만드는게 나을지를 심사숙고해야 합니다.(Item. 17)
불변 클래스로 만들기로 했다면, equals가 한번 같다고 한 객체는 영원히 같다고 답하고, 다르다면 영원히 다르다고 답하도록 만들어야 합니다.
equals는 클래스가 불변이든, 가변이든 판단에 신뢰할 수 없는 자원이 끼어들게 해서는 안 됩니다. 이 제약을 어기면 일관성 조건을 만족시키기가 아주 어렵습니다.
예를 들어, java.net.URL의 equals는 주어진 URL과 매핑된 호스트의 IP 주소를 이용해 비교합니다. 그런데, 호스트 이름을 IP 주소로 바꾸려면 DNS 라든지 네트워크를 통해야 하는데, 그 결과가 항상 같다고 보장할 수 없습니다.
이는 URL의 equals가 일반 규악을 어기게 하고, 실무에서도 종종 문제를 일으킵니다. URL equals 또한 이렇게 구현한 것은 커다란 실수입니다.
private transient InetAddress hostAddress;
/**
* The URLStreamHandler for this URL.
*/
transient URLStreamHandler handler;
...
public boolean equals(Object obj) {
if (!(obj instanceof URL))
return false;
URL u2 = (URL)obj;
return handler.equals(this, u2);
}이런 문제를 해결, 아니 피하려면 equals는 항시 메모리에 존재하는 객체만을 사용한 결정적(deterministic) 계산만 수행해야 합니다.
마지막 조건은 null-아님 인데, 이름처럼 모든 객체가 null과 같지 않아야 한다는 것입니다. o.equals(null)이 true를 반환하는 상황은 어렵지만, 실수로 NullPointerException을 던지는 코드는 흔할 것입니다.
이 규악은, 이 경우도 허용하지 않습니다. 수 많은 클래스가 다음 코드처럼 입력이 null인지를 확인해 자신을 보호합니다.
// 명시적 null 검사 - 필요 없음
@Override
public boolean equals(Object o) {
if ( o== null )
return false;
...
}이러한 검사는 필요하지 않습니다. 동치성을 검사하려면 equals는 건네받은 객체를 적절히 형변환한 후 필수 필드들의 값을 알아내야하기 때문입니다. 그러려면 형변환에 앞에서 intanceof 연산자로 입력 매개변수가 올바른 타입인지 검사해야 합니다.
// 묵시적 null 검사 - 좋은 예시
@Override
public boolean equals(Object o) {
if (!(o instanceof MyType))
return false;
MyType mt = (MyType) o;
...
}첫 번째 예시처럼, equals가 타입을 확인하지 않으면, 잘못된 타입이 인수로 주어졌을 때 ClassCastException을 던져서 일반 규약을 위반하게 됩니다. 그런데 intanceof는 (두 번째 피연산자와 무관하게) 첫 번째 피연산자가 null이면 flase를 반환합니다. 따라서, 입력이 null이면 타입 확인 단계에서 flase를 반환하기 때문에 null 검사를 명시적으로 하지 않아도 되는 것입니다.
지금까지의 내용을 종합해서 양질의 equals 메서드 구현 방법을 정리하겠습니다.
1. == 연산자를 사용해 입력이 자기 자신의 참조인지 확인한다.
- 자기 자신이면 true를 반환하여 단순 성능 최적화용으로, 비교 작업이 복잡한 상황일 때 빛을 발휘합니다.
2. intanceof 연산자로 입력이 올바른 타입인지 확인한다.
- 그렇지 않다면 false를 반환합니다. 이 때, 올바른 타입은 equals가 정의된 클래스인 것이 보통이지만, 가끔은 그 클래스가 구현한 특정한 인터페이스가 될 수도 있습니다. 어떤 인터페이스는 자신을 구현한 (서로 다른) 클래스끼리도 비교할 수 있도록 equals 규약을 수정하기도 합니다. 이런 인터페이스를 구현한 클래스라면, equals에서 (클래스가 아닌) 해당 인터페이스를 사용해야 합니다. Set, List, Map, Map.Entry 등의 컬렉션 인터페이스들이 여기 해당합니다.
3. 입력을 올바른 타입으로 형변환한다.
- 간단하게 2번에서 intanceof 검사를 했기 때문에, 성공합니다.
4. 입력 객체와 자기 자신의 대응되는 '핵심' 필드들이 모두 일치하는지 하나씩 검사한다.
- 모든 필드가 일치하면 true를, 하나라도 다르면 false를 반환합니다. 2단계에서 인터페이스를 사용했다면 입력의 필드 값을 가져올 때도 그 인터페이스의 메서드를 사용해야 합니다. 타입이 클래스라면 해당 필드에 직접 접근할 수도 있습니다.
float와 douvle을 제외한 기본 타입 필드는 == 연산자로 비교하고, 참조 타입 필드는 각각의 equals 메서드로, float와 double 필드는 각각 정적 메서드인 Float.compare, Double.compare로 비교합니다. float와 double을 특별 취급하는 이유는, Float.NaN, -0.0f 등 특수한 부동소수 값을 다뤄야 하기 때문입니다.
Float.equals 등 메서드를 대신 사용할 수 있지만, 이 메서드는 오토박싱을 수반할 수 있으니 성능상 좋지 않습니다. 배열의 경우, 필드는 원소 각각을 앞의 지침대로 비교합니다. 배열의 모든 원소가 핵심 필드라면 Arrays.equals 메서드들 중 하나를 사용하는 것이 좋습니다.
때론 null도 정상 값으로 취급하는 참조 타입 필드도 있습니다. 이런 필드는 정적 메서드인 Objects.equals로 비교해 NullPointerException 발생을 예방하는 것이 좋습니다.
앞서 10-1의 예시 CaseInsensitiveString 예처럼, 비교하기가 아주 복잡한 필드를 가진 클래스도 있습니다. 이런 경우, 그 필드의 표준형을 저장해둔 후 표준형끼리 비교하면 훨씬 경제적입니다. 이 기법은 특히 불변 클래스(Item. 17)에 제격인데, 가변 객체라면 값이 바뀔 때마다 표준형을 최신 상태로 갱신해줘야 합니다.
마찬가지로 해당 아이템 순서에서 포스팅 하도록 하겠습니다.
또한, 어떤 필드를 먼저 비교하느냐가 equals의 성능을 좌우하기도 합니다. 최상의 성능을 바란다면, 다를 가능성이 크거나 비교하는 비용이 싼 필드를 먼저 비교합니다. 동기화 용 락(LOCK) 필드 같이 객체의 논리적 상태와 관련 없는 필드는 비교하면 안 됩니다. 핵심 필드로부터 계산해낼 수 있는 파생 필드 역시 굳이 비교할 필요는 없지만, 파생 필드를 비교하는 쪽이 더 빠를 때도 있습니다.
예를 들어 자신의 영역을 캐싱해두는 Polygon 클래스가 있다고 합시다. 그렇다면 모든 변화 정점을 일일이 비교할 필요 없이 캐시해둔 영역만 비교하면 결과를 곧바로 알 수 있습니다.
equals를 다 구현했다면, 세 가지만 자문해봅시다.
1. 대칭적인가?
2. 추이성이 있는가?
3. 일관적인가?
단위 테스르를 작성해 돌려봅시다. 단, equals 메서드를 AutoValue를 이용해 작성했다면 테스트를 생략해도 안심할 수 있습니다. 물론 나머지 요건인 반사성과 null-아님도 만족해야 하지만, 이 둘이 문제되는 경우는 별로 없습니다.
다음은 지금까지의 묘리에 따라 작성해본 PhoneNumber 클래스용 equals 메서드입니다.
package item10;
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)
return true;
if( !(o instanceof PhoneNumber))
return false;
PhoneNumber pn = (PhoneNumber) o;
return pn.lineNum == lineNum && pn.prefix == prefix && pn.areaCode == areaCode;
}
}
고지가 다와가, 아름다운 equals 코드를 보니 눈물이 아른거리네요...
드디어 마지막 주의사항입니다.
다음 아이템 (Item. 11)의 포스팅 내용인
"equals를 재정의할 땐 hashCode도 반드시 재정의하자
그리고, 너무 복잡하게 해결하려 들지 말자입니다. 쉽게 말해 필드들의 동치성만 검사해도 equals 규약을 어렵지 않게 지킬 수 있습니다. 오히려 너무 깊게 생각하다가 문제를 일으키디고 합니다. 일반적으로 alias는 비교하지 않는 것이 좋습니다. 예를 들어 File 클래스라면 심볼릭 링크를 비교해 같은 파일을 가리키는지를 확인 하려 들면 안됩니다. 다행이 File 클래스는 이런 시도를 하지 않습니다.
Object 외의 타입을 매개변수로 받는 equals 메서드는 선언하지 않는 것이 좋습니다. 많은 프로그래머가 equals를 다음과 같이 작성해놓고 문제의 원인을 찾습니다.
public boolean equals(MyClass o) {
...
}이 메서드는 equals를 재정의 한 것이 아닙니다. 입력 타입이 Object가 아니므로 재정의가 아니라 다중정의(Item. 52)한 것입니다. 기본 equals를 그대로 둔 채로 추가한 것일지라도, 이처럼 '타입을 구체적으로 명시한' equals는 오히려 해가 됩니다. 이 메서드는 @Override 에너테이션이 긍정 오류(flase positive; 거짓 양성)를 내게 하고 보안 측면에서도 잘못된 정보를 줍니다. 이번 절 예제 코드들에서처럼, @Override 에너테이션을 일관되게 사용하면 이러한 실수를 예방할 수 있습니다. (Item. 40)
예를 들어, 다음 equals 메서드 또한 컴파일되지 않고, 무엇이 문제인지를 정확히 알려주는 오류 메시지를 보여줄 것입니다.
@Override
public boolean equals(MyClass o) {
...
}equals를 작성하고 테스트하는 일은 지루하고, 테스트 코드도 항상 뻔합니다.
다행히 이 작업을 대신해줄 오픈소스가 있는데, 바로 구글에서 만든 AutoValue 프레임 워크가 있습니다. 클래스에 애너테이션 하나만 추가하면 AutoValue가 이 메서드를 알아서 작서해주며, 직접 작성하는 것과 근본적으로 같은 코드를 만들 것입니다.
10-1에서 제가 첫번째 예시로 든 equals 메서드도... 단순히 command+n 으로 equals를 선택하여 Title만 비교하도록 지정한 한 것일 뿐입니다.
정리하여, 꼭 필요한 경우가 아니면 equals를 재정의하지 않는 것이 좋습니다. 많은 경우에 Object의 equals가 원하는 비교를 수행해줍니다. 재정의해야 할 때는 그 클래스의 핵심 필드 모두를 빠짐없이, 다섯가지 규약을 확실히 지켜야합니다.
회고
가장 길었던 포스팅입니다... equals가 위험하다는 말은 여럿 들었어도, 근본적인 원인을 몰랐는데.. 결국에 결론은 IDE가 사용해주는 자동 완성도 좋지만 이것이 왜 그런지 알 수 있었던 계기가 된 것 같습니다.
그리고.. 이번 포스팅이 역대급으로 많은 java 라이브러리의 클래스들을 하나하나 파며 분석한 포스팅입니다. 뭐랄까, 한층 더 성장한 계기가 팍팍 느껴지는 것 같습니다. ㅎㅎ
다음 포스팅은 haseCode로 돌아오겠습니다.
감사합니다.
