이전에 equals, hashCode, toString에 대해서 정리한 적이 있으나 고려하지 않은 부분이 많은 것 같아 작성한다.
equals 메서드는 재정의하기 쉬워보이지만 곳곳에 함정이 도사리고 있어서 자칫하면 끔찍한 결과를 초래한다.
문제를 회피하는 가장 쉬운 길은 아예 재정의하지 않는 것이다.
그냥 두면 그 클래스의 인스턴스는 오직 자기 자신과만 같게 된다.
따라서 다음에서 열거한 상황 중 하나에 해당된다면 재정의하지 않는 것이 최선이다.
1.각 인스턴스가 본질적으로 고유하다.
값을 표현하는 게 아니라 동작하는 개체를 표현하는 클래스가 여기 해당한다.
Thread가 좋은 예로 Object의 equals 메서드는 이러한 클래스에 딱 맞게 구현되었다.
2.인스턴스의 '논리적 동치성'을 검사할 일이 없다.
예컨대 java.util.regex.Pattern은 equals를 재정의해서 두 Pattern의 인스턴스가 같은 정규표현식을 나타내는지 검사하는 즉 논리적 동치성을 검사하는 방법도 있다.
하지만 설계자는 클라이언트가 이 방식을 원하지 않거나 애초에 필요하지 않다고 판단할 수도 있다.
설계자가 후자로 판단했다면 Object의 기본 equals만으로 해결된다.
3.상위 클래스에서 재정의한 equals가 하위 클래스에도 딱 들어맞는다.
예컨대 대부분 Set 구현체는 AbstractSet이 구현한 equals를 상속받아 쓰고 List 구현체들은 AbstractList로 부터, Map 구현체들은 AbstractMap으로 부터 상속받아 그대로 쓴다.
4.클래스가 private이거나 package-private이고 equals 메서드를 호출할 일이 없다.
equals가 실수로라도 호출되는 걸 막고 싶다면 다음처럼 구현해두면 된다.
@Override public boolean equals(Object o) {
throw new AssertionError(); // 호출 금지!
}
그렇다면 equals를 재정의해야 할 때는 언제일까?
객체 식별성(두 객체가 물리적으로 같은가)이 아니라 논리적 동치성을 확인해야 하는데 상위 클래스의 equals가 논리적 동치성을 비교하도록 재정의되지 않았을 때이다.
주로 값 클래스들이 여기 해당한다.
값 클래스란 Integer, String 처럼 값을 표현하는 클래스를 말한다.
두 값 객체를 equals로 비교하는 프로그래머는 객체가 같은지가 아니라 값이 같은지를 알고 싶어 할 것이다.
equals가 논리적 동치성을 확인하도록 재정의해두면 그 인스턴스는 값을 비교하길 원하는 프로그래머의 기대에 부응함은 물론 Map의 키와 Set의 원소로 사용할 수 있게 된다.
값 클래스라 해도 값이 같은 인스턴스가 둘 이상 만들어지지 않음을 보장하는 인스턴스 통제 클래스(아이템 1)라면 equals를 재정의하지 않아도 된다.
Enum(아이템 34)도 여기 해당한다. 이런 클래스에서는 어차피 논리적으로 같은 인스턴스가 2개 이상 만들어지지 않으니 논리적 동치성과 객체 식별성이 사실상 똑같은 의미가 된다.
따라서 Object의 equals가 논리적 동치성까지 확인해준다고 볼 수 있다.
equals 메서드를 재정의할 때는 반드시 일반 규약을 따라야 한다.
다음은 Object 명세에 적힌 규약이다.
equals 메서드는 동치 관계를 구현하며 다음을 만족한다.
1. 반사성 - null이 아닌 모든 참조값 x에 대해 x.equals(x)는 true다.
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다.
4. 일관성 - null이 아닌 모든 참조값 x,y에 대해 x.equals(y)를 반복해서 호출하면 항상 true 나 false를 반환한다.
5. null-아님 - null이 아닌 모든 참조값 x에 대해 x.equals(null)은 false다.
이 규약을 어기면 프로그램이 이상하게 동작하거나 종료될 것이고 원인이 되는 코드도 찾기 굉장히 어려울 것이다.
한 클래스의 인스턴스는 다른 곳으로 빈번히 전달된다.
그리고 컬렉션 클래스들을 포함해 수 많은 클래스는 전달받은 객체가 equals 규약을 지킨다고 가정하고 동작한다.
위의 규약은 그리 복잡하지 않다.
동치 관계를 만족시키기 위한 다섯 요건을 하나씩 알아보겠다.
반사성은 단순히 말하면 객체는 자기 자신과 같아야 한다는 뜻이다.
이 요건을 일부러 어기는 경우가 아니라면 만족시키지 못하기가 더 어려워 보인다.
이 요건을 어긴 클래스는 인스턴스를 컬렉션에 넣은 다음 contains 메서드를 호출하면 방금 넣은 인스턴스가 없다고 답할 것이다.
대칭성은 두 객체는 서로에 대한 동치 여부에 똑같이 답해야 한다는 뜻이다.
반사성과 달리 대칭성 요건은 자칫하면 어길 수 있어 보인다.
대소문자를 구별하지 않는 문자열을 구현한 다음 클래스를 예로 살펴보겠다.
이 클래스에서 toString 메서드는 원본 문자열 대소문자를 그대로 돌려주지만 equals에서는 대소문자를 무시한다.
// 코드 10-1 잘못된 코드 - 대칭성 위배! (54-55쪽)
public 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의 equals는 순진하게 일반 문자열과도 비교를 시도한다.
다음처럼 CaseInsensitiveString과 String 객체가 하나씩 있다고 해보자.
CaseInsensitiveString cis = new CaseInsensitiveString("Polish");
String s = "polish";예상할 수 있듯 cis.equlas(s)는 true를 반환한다.
문제는 CaseInsensitiveString의 equals는 일반 String을 알고 있지만 String의 equals는 CaseInsensitiveString의 존재를 모른다는 데 있다.
따라서 s.equals(cis)는 false를 반환하여 대칭성을 명백히 위반한다.
이번에는 CaseInsensitiveString을 컬렉션에 넣어보자.
List<CaseInsensitiveString> list = new ArrayList<>();
list.add(cis);
이 다음에 list.contains(s)를 호출하면 어떤 결과가 나올까? 테스트 대상 OpenJDK에서는 false를 반환하기는 한다.
하지만 이는 순전히 구현하기 나름이라 OpenJDK 버전이 바뀌거나 다른 JDK에서는 true를 반환하거나 런타임 예외를 던질 수도 있다.
equals 규약을 어기면 그 객체를 사용하는 다른 객체들이 어떻게 반응할지 알 수 없다.
이 문제를 해결하려면 CaseInsensitiveString의 equals를 String과도 연동하겠다는 허황한 꿈은 버려야 한다.
equals는 다음처럼 간단한 모습으로 바꿀 수 있다.
@Override public boolean equals(Object o) {
return o instanceof CaseInsensitiveString &&
((CaseInsensitiveString) o).s.equalsIgnoreCase(s);
}
추이성은 첫 번째 객체와 두 번째 객체가 같고 두 번째 객체와 세 번째 객체가 같다면 첫 번째 객체와 세 번째 객체도 같아야 한다는 뜻이다.
이 요건도 간단하지만 자칫하면 어기기 쉽다.
상위 클래스에 없는 새로운 필드를 하위 클래스에 추가하는 상황을 생각해보자.
equals 비교에 영향을 주는 정보를 추가한 것이다.
간단히 2차원에서의 점을 표현하는 클래스를 예로 들어보자.
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 메서드는 어떻게 해야 할까?
그대로 둔다면 Point의 구현이 상속되어 색상 정보는 무시한 채 비교를 수행한다.
equals 규약을 어긴 것은 아니지만 중요한 정보를 놓치게 되니 받아들일 수 없는 상황이다.
다음 코드처럼 비교 대상이 또 다른 ColorPoint이고 위치와 색상이 같을 때만 true를 반환하는 equals를 생각해보자.
// 코드 10-2 잘못된 코드 - 대칭성 위배! (57쪽)
@Override
public boolean equals(Object o) {
if (!(o instanceof ColorPoint))
return false;
return super.equals(o) && ((ColorPoint) o).color == color;
}이 메서드는 일반 Point를 ColorPoint에 비교한 결과와 그 둘을 바꿔 비교한 결과가 다를 수 있다.
Point의 equals는 색상을 무시하고 ColorPoint의 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와 비교할 때는 색상을 무시하도록 하면 해결 될까?
// 코드 10-3 잘못된 코드 - 추이성 위배! (57쪽)
@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)와 p2.equals(p3)는 true를 반환하는데 p1.equals(p3)가 false를 반환한다.
추이성에 명백히 위배된다.
p1과 p2, p2와 p3의 비교에서는 색상을 무시했지만 p1과 p3의 비교에서는 색상까지 고려했기 때문이다.
또한 이 방식은 무한 재귀에 빠질 위험도 있다.
Point의 또 다른 하위 클래스로 SmellPoint를 만들고 equals는 같은 방식으로 구현했다고 해보자.
그런 다음 myColorPoint.equals(mySmellPoint)를 호출하면 StackOverflowError를 일으킨다.
그러면 해결 방법은 무엇일까?
사실 이 현상은 모든 객체 지향 언어의 동치관계에서 나타나는 근본적인 문제다.
구체 클래스를 확장해 새로운 값을 추가하면서 equals 규약을 만족시킬 방법은 존재하지 않는다..
객체 지향적 추상화의 이점을 포기하지 않는 한은 말이다.
이 말은 얼핏 equals 안의 instanceof 검사를 getClass 검사로 바꾸면 규약도 지키고 값도 추가하면서 구체 클래스를 상속할 수 있다는 뜻으로 들린다.
// 잘못된 코드 - 리스코프 치환 원칙(59쪽) 위배!
@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;
}
이번 equals는 같은 구현 클래스의 객체와 비교할 때만 true를 반환한다.
괜찮아보이지만 실제로 활용할 수는 없다.
Point의 하위 클래스는 정의상 여전히 Point이므로 어디서든 Point로써 활용될 수 있어야한다.
그런데 이 방식은 그렇지 못하다.
예를 들어 주어진 점이 (반지름이 1인) 단위 원 안에 있는지를 판별하는 메서드가 필요하다고 해보자.
아래는 이를 구현한 코드다.
// 단위 원 안의 모든 점을 포함하도록 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.contains(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(); }
}
리스코프 치환 원칙에 따르면 어떤 타입에 있어 중요한 속성이라면 그 하위 타입에서도 마찬가지로 중요하다.
따라서 그 타입의 모든 메서드가 하위 타입에서도 똑같이 잘 작동해야 한다.
이는 앞서 "Point의 하위 클래스는 정의상 여전히 Point이므로 어디서든 Point로써 활용되어 있어야 한다."를 격식 있게 표현한 말이다.
그런데 ConuterPoint의 인스턴스를 onUnitCircle 메서드에 넘기면 어떻게 될까?
Point 클래스의 equals를 getClass를 사용해 작성했다면 onUnitCircle은 false를 반환할 것이다.
CounterPoint의 인스턴스의 x, y 값과는 무관하게 말이다.
왜 그럴까? 원인은 컬렉션 구현체에서 주어진 원소를 담고 있는지를 확인하는 방법에 있다.
onUnitCircle에서 사용한 Set을 포함하여 대부분의 컬렉션은 이 작업에 equals 메서드를 이용하는데 CounterPoint의 인스턴스는 어떤 Point와도 같을 수 없기 때문이다.
반면 Point의 equals를 instanceof 기반으로 올바르게 구현했다면 CounterPoint 인스턴스를 건네줘도 onUnitCircle 메서드가 제대로 동작할 것이다.
구체 클래스의 하위 클래스에서 값을 추가할 방법은 없지만 괜찮은 우회 방법이 하나 있다.
"상속 대신 컴포지션을 사용하라"는 아이템 18의 조언을 따르면 된다.
Point를 상속하는 대신 Point를 ColorPoint의 private 필드로 두고 ColorPoint와 같은 위치의 일반 Point를 반환하는 뷰 메서드를 public으로 추가하는 식이다.
// 코드 10-5 equals 규약을 지키면서 값 추가하기 (60쪽)
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);
}
}
자바 라이브러리에도 구체 클래스를 확장해 값을 추가한 클래스가 종종 있다.
한 가지 예로 java.sql.Timestamp는 java.util.Date를 확장한 후 nanoseconds 필드를 추가했다.
그 결과로 Timestamp의 equals는 대칭성을 위배하며 Date 객체와 한 컬렉션에 넣거나 서로 섞어 사용하면 엉뚱하게 동작할 수 있다.
그래서 Timestamp의 API 설명에는 Date와 섞어 쓸 때의 주의사항을 언급하고 있다.
둘을 명확히 분리해 사용하는 한 문제될 것은 없지만 섞이지 않도록 보장해줄 수단은 없다.
자칫 실수하면 디버깅하기 어려운 이상한 오류를 경험할 수 있으니 주의해야 한다.
Timestamp를 이렇게 설계한 것은 실수니 절대 따라해서는 안된다.
만약 추상 클래스의 하위 클래스에서라면 equals 규약을 지키면서도 값을 추가할 수 있다.
예컨대 아무런 값을 갖지 않는 추상 클래스인 Shape를 위에 두고 이를 확장하여 radius 필드를 추가한 Circle 클래스와 length와 width 필드를 추가한 Rectangle 클래스를 만들 수 있다.
상위 클래스를 직접 인스턴스로 만드는 게 불가능하다면 지금까지 이야기한 문제들은 일어나지 않는다.
일관성은 두 객체가 같다면 (수정되지 않는 한) 앞으로도 영원히 같아야 한다는 뜻이다.
가변 객체는 비교 시점에 따라 서로 다를 수도 혹은 같을 수도 있는 반면 불변 객체는 한번 다르면 끝까지 달라야한다.
클래스를 작성할 때는 불변 클래스로 만드는 게 나을지를 심사숙고하자.(아이템 17)
불변 클래스로 만들기로 했다면 equals가 한번 같다고한 객체와는 영원히 같다고 답하고 다르다고 한 객체와는 영원히 다르다고 답하도록 만들어야 한다.
클래스가 불변이든 가변이든 equals 판단에 신뢰할 수 없는 자원이 끼어들게 해서는 안된다.
이 제약을 어기면 일관성 조건을 만족시키기가 아주 어렵다.
예컨대 java.net.URL의 equals는 주어진 URL과 매핑된 호스트의 IP 주소를 이용해 비교한다.
호스트 이름을 IP 주소로 바꾸려면 네트워크를 통해야 하는데, 그 결과 항상 같다고 보장할 수 없다.
이는 URL의 equals가 일반 규약을 어기게하고 실무에서도 종종 문제를 일으킨다.
URL의 equals를 이렇게 구현한 것은 커다란 실수였으니 절대로 따라해서는 안된다.
하위 호환성이 발목을 잡아 잘못된 동작을 바로잡을 수도 없다.
이런 문제를 피하려면 equals는 항시 메모리에 존재하는 객체만을 사용한 계산만을 수행해야 한다.
마지막 요건은 공식 이름이 없으니 임의로 'null-아님'이라 부르겠다.
null-아님은 이름처럼 모든 객체가 null과 같지 않아야 한다는 뜻이다.
의도하지 않았으멩도 o.equals(null)이 true를 반환하는 상황은 상상하기 어렵지만 실수로 NullPointerException을 던지는 코드는 흔할 것이다.
이 일반 규약은 이런 경우도 허용하지 않는다.
수많은 클래스가 다음 코드처럼 입력이 null인지를 확인해 자신을 보호한다.
@Override public boolean equals(Object o) {
if(o == null)
return false;
...
}
이러한 검사는 필요치 않다.
동치성을 검사하려면 equals를 건네받은 객체를 적절히 형반환한 후 필수 필드들의 값을 알아내야 한다.
그러려면 형변환에 앞서 instanceof 연산자로 입력 매개변수가 올바른 타입인지 검사해야 한다.
@Override public boolean equals(Object o) {
if (!(o instanceof MyType))
return false;
MyType mt = (MyType) o;
...
}
equals가 타입을 확인하지 않으면 잘못된 타입이 인수로 주어졌을 때 ClassCastException을 던져서 일반 규약을 위배하게 된다.
그런데 instanceof는 첫 번째 피연산자가 null이면 false를 반환한다.
따라서 입력이 null이면 타입 확인 단계에서 false를 반환하기 때문에 null 검사를 명시적으로 하지 않아도 된다.
지금까지의 내용을 종합해서 양질의 equals 메서드 구현 방법을 단계 별로 정리해보겠다.
1. == 연산자를 사용해 입력이 자기 자신의 참조인지 확인한다.
자기 자신이면 true를 반환한다. 이는 단순한 성능 최적화용으로 비교 작업이 복잡한 상황일 때 값어치를 할 것이다.
2. instanceof 연산자로 입력이 올바른 타입인지 확인한다. 그렇지 않다면 false를 반환한다.
이때의 올바른 타입은 equals가 정의된 클래스인 것이 보통이지만 가끔은 그 클래스가 구현한 특정 인터페이스가 될 수도 있다.
어떤 인터페이스는 자신을 구현한 (서로 다른) 클래스끼리도 비교할 수 있도록 equals 규약을 수정하기도 한다.
이런 인터페이스를 구현한 클래스라면 equals에서 (클래스가 아닌) 해당 인터페이스를 사용해야 한다.
Set, List, Map, Map.Entry 등의 컬렉션 인터페이스들이 여기 해당한다.
3. 입력을 올바른 타입으로 형변환한다.
앞서 2번에서 instanceof 검사를 했기 때문에 이 단계는 100% 성공한다.
4.입력 객체와 자기 자신의 대응되는 핵심 필드들이 모두 일치하는지 하나씩 검사한다.
모든 필드가 일치하면 true를 하나라도 다르면 false를 반환한다.
2단계에서 인터페이스를 사용했다면 입력의 필드 값을 가져올 때도 그 인터페이스의 메서드를 사용해야 한다.
타입이 클래스라면 (접근 권한에 따라) 해당 필드에 직접 접근할 수도 있다.
float과 double을 제외한 기본 타입 필드는 == 연산자로 비교하고, 참조 타입 필드는 각각의 equals 메서드로, float과 double 필드는 각각 정적 메서드인 Float.compare(float, float)와 Double.compare(double, double)로 비교한다.
float과 double을 특별 취급하는 이유는 Float.NaN, -0.0f, 특수한 부동소수 값 등을 다뤄야 하기 때문이다.
Float.equals와 Double.equals 메서드를 대신 사용할 수도 있지만 이 메서드들은 오토박싱을 수반할 수 있으니 성능상 좋지 않다.
배열 필드는 원소 각각을 앞서의 지침대로 비교한다.
배열의 모든 원소가 핵심필드라면 Arrays.equals 메서드들 중 하나를 사용하자.
때로는 null도 정상 값으로 취급하는 참조 타입 필드도 있다.
이런 필드는 정적 메서드인 Objects.equlas(Object, Object)로 비교해 NullPointerException 발생을 예방하자.
앞서의 CaseInsensitiveString 예처럼 비교하기가 아주 복잡한 필드를 가진 클래스도 있다.
이럴 때는 그 필드의 표준형을 저장해둔 후 표준형끼리 비교하면 훨씬 경제적이다.
이 기법은 특히 불변 클래스(아이템 17)에 제격이다.
가변 객체라면 값이 바뀔 때 마다 표준형을 최신 상태로 갱신해줘야 한다.
어떤 필드가 먼저 비교하느냐가 equals의 성능을 좌우하기도 한다.
최상의 성능을 바란다면 다를 가능성이 더 크거나 비교하는 비용이 싼 (혹은 둘 다 해당하는) 필드를 먼저 고려하자.
동기화용 락 필드 같이 객체의 논리적 상태와 관련 없는 필드는 비교하면 안된다.
핵심 필드로부터 계산해낼 수 있는 파생 필드 역시 굳이 비교할 필요는 없지만 파생 필드를 비교하는 쪽이 더 빠를 때도 있다.
파생 필드가 객체 전체의 상태를 대표하는 상황이 그렇다.
예컨대 자신의 영역을 캐시해두는 Polygon 클래스가 있다고 해보자.
그렇다면 모든 변과 정점을 일일이 비교할 필요 없이 캐시해둔 영역만 비교하면 결과를 곧바로 알 수 있다.
equals를 다 구현했다면 세 가지만 자문해보자.
대칭적인가? 추이성이 있는가? 일관적인가?
자문에서 끝내지 말고 단위 테스트를 작성해 돌려보자.
단, equals 메서드를 AutoValue를 이용해 작성했다면 테스트를 생략해도 안심할 수 있다.
세 요건 중 하나라도 실패한다면 원인을 찾아서 고치자.
물론 나머지 요건인 반사성과 null-아님도 만족해야 하지만, 이 둘이 문제되는 경우는 거의 없다.
다음은 이상의 비법에 따라 작성해본 PhoneNumber 클래스용 equals 메서드다.
// 코드 10-6 전형적인 equals 메서드의 예 (64쪽)
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 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;
}
// 나머지 코드는 생략 - hashCode 메서드는 꼭 필요하다(아이템 11)!
}
마지막 주의사항이 있다.
1. equals를 재정의할 땐 hashCode도 반드시 재정의하자.
2. 너무 복잡하게 해결하려 들지 말자. 필드들의 동치성만 검사해도 equals 규약을 어렵지 않게 지킬 수 있다.
3. Object 외의 타입을 매개변수로 받는 equals 메서드는 선언하지 말자. 많은 프로그래머가 equals를 다음과 같이 작성해놓고 문제의 원인을 찾아 헤맨다.
// 잘못된 예 - 입력 타입은 반드시 Object여야 한다!
public boolean equals(MyClass o) {
...
}
이 메서드는 Object.equals를 재정의한 게 아니다.
다중정의(아이템 52)한 것이다.
기본 equals를 그대로 둔 채 추가한 것일지라도 이처럼 '타입을 구체적으로 명시한' equals는 오히려 해가 된다.
이 메서드는 하위 클래스에서의 @Override 어노테이션이 긍정 오류를 내게 하고 보안 측면에서도 잘못된 정보를 준다.
이번 절 예제 코드들에서처럼 @Override 어노테이션을 일관되게 사용하면 이러한 실수를 사전에 예방할 수 있다.(아이템 40)
예를 들어 다음 equals 메서드는 컴파일 되지 않고 무엇이 문제인지를 정확히 알려주는 오류 메세지를 보여줄 것이다.
// 여전히 잘못된 예 - 컴파일되지 않음
@Override
public boolean equals(MyClass o) {
...
}
equals(hashCode도 마찬가지)를 작성하고 테스트하는 일은 지루하고 이를 테스트하는 코드도 항상 뻔하다.
다행히 이 작업을 대신해줄 오픈소스가 있으니 구글이 만든 AutoValue 프레임워크다.
클래스에 어노테이션 하나만 추가하면 AutoValue가 이 메서드들을 알아서 작성해주며 직접 작성하는 것과 근본적으로 똑같은 코드를 만들어줄 것이다.
대다수의 IDE도 같은 기능을 제공하지만 생성된 코드가 AutoValue만큼 깔끔하거나 읽기 좋지는 않다.
또한 IDE는 나중에 클래스가 수정된 걸 자동으로 알아채지는 못하니 테스트 코드를 작성해둬야 한다.
이런 단점을 감안하더라도 사람이 직접 작성하는 것보다는 IDE에 맡기는 편이 낫다.
핵심 정리
꼭 필요한 경우가 아니면 equals를 재정의하지 말자.
많은 경우에 Object의 equals가 원하는 비교를 정확히 수행해준다.
재정의해야할 때는 그 클래스의 핵심 필드 모두를 빠짐없이 다섯 가지 규약을 확실히 지켜가며 비교해야 한다.
'Book > Effective Java' 카테고리의 다른 글
| [Effective Java]12.toString을 항상 재정의하라 (0) | 2022.06.04 |
|---|---|
| [Effective Java]11.equals를 재정의하면 hashCode도 재정의하라 (0) | 2022.06.04 |
| [Effective Java] 9.try-finally보다는 try-with-resources를 사용하라 (0) | 2022.06.03 |
| [Effective Java] 8.finalizer와 cleaner 사용을 피하라 (0) | 2022.06.03 |
| [Effective Java] 7.다 쓴 객체 참조를 해제하라 (0) | 2022.06.03 |