Effective Java ( 이펙티브 자바 ) - 아이템 11

equals를 재정의하려거든 hashCode 도 재정의하라

---

equals를 재정의한 클래스 모두에서 hashCode도 재정의해야 한다. 그렇지 않으면 hashCode 일반 규약을 어기게 되어 해당 클래스의 인스턴스를 HashMap이나 HashSet 같은 컬렉션의 원소로 사용할 때 문제를 일으킬 것이다. 다음은 Object 명세에서 발췌한 규약이다.

• equals 비교에 사용되는 정보가 변경되지 않았다면, 애플리케이션이 실행되는 동안 그 객체의 hashCode 메서드는 몇 번을 호출해도 일관되게 항상 같은 값을 반환해야 한다. 단, 애플리케이션을 다시 실행한다면 이 값이 달라져도 상관없다.
• equals(Object)가 두 객체를 같다고 판단했다면, 두 객체의 hashCode는 똑같은 값을 반환해야 한다. 
• equals(Object)가 두 객체를 다르다고 판단했더라도, 두 객체의 hashCode가 서로 다른 값을 반환할 필요는 없다. 단, 다른 객체에 대해서는 다른 값을 반환해야 해시테이블의 성능이 좋아진다.

hashCode 재정의를 잘못했을 때 크게 문제가 되는 조항은 두 번째다. 즉, 논리적으로 같은 객체는 같은 해시코드를 반환해야 한다.

Object의 기본 hashCode는 두 객체가 전혀 다르다고 판단하여, 규약과 달리 서로 다른 값을 반환한다.

Map<PhoneNumber, String> m = new HashMap<>();
m.put(new PhoneNumber(707, 867, 5309), "제니");

의 뒤에 m.get(new PhoneNumber(707, 867, 5309)) 를 실행하면 제니가 나와야할 것 같지만, null을 반환한다. PhoneNumber 클래스는 hashCode를 재정의하지 않았기 때문에 논리적 동치인 두 객체가 서로 다른 해시코드를 반환하여 두 번째 규약을 지키지 못한다. 그 결과 엉뚱한 해시 버킷에 가서 객체를 찾으려 한 것이다. 

 

  이 문제는 적절한 hashCode만 작성해주면 해결된다. 올바른 hashCode는 어떤 모습이어야 할까? 안 좋게 작성하려면 아주 간단하다. 다음 코드는 적법하게 구현했지만, 절대 사용해서는 안 된다.

@Override
public int hashCode() { return 42; }

끔찍하게도 모든 객체에게 똑같은 값만 내어주므로 모든 객체가 해시테이블의 버킷 하나에 담겨 마치 연결 리스트처럼 동작한다. 그 결과 평균 수행 시간이 O(1)인 해시테이블이 O(n)으로 느려져서, 객체가 많아지면 도저히 쓸 수 없게 된다.

 

좋은 해시 함수라면 서로 다른 인스턴스에 다른 해시코드를 반환한다. 이상적인 해시 함수는 주어진 ( 서로 다른 ) 인스턴스들을 32비트 정수 범위에 균일하게 분배해야 한다. 책에서는 좋은 hashCode를 작성하는 간단한 요령을 설명하고 있다. 

 

  파생 필드는 해시코드 계산에서 제외해도 된다. 즉, 다른 필드로부터 계산해 낼 수 있는 필드는 모두 무시해도 된다. 핵심 필드만을 계산하자. 즉, equals 비교에 사용되지 않은 필드는 '반드시' 제외해야 한다. 그렇지 않으면 hashCode 규약 두 번째를 어기게 될 위험이 있다.

 

31 을 책에서 곱한 이유는, 곱하는 순서에 따라 result가 달라지게 한다. 그 결과 클래스에 비슷한 필드가 여러 개일 때 해시 효과를 크게 높여준다. 예를 들어 String의 hashCode를 곱셈 없이 구현한다면 모든 아나그램(anagram, 구성하는 철자가 같고 그 순서만 다른 문자열)의 해시코드가 같아진다. 곱할 숫자를 31로 정한 이유는 31이 홀수이면서 소수(prime)이기 때문이다. 이 숫자가 짝수이고 오버플로가 발생한다면 정보를 잃게 된다. 2를 곱하는 것은 시프트 연산과 같은 결과를 내기 때문이다. 소수를 곱하는 이유는 명확하진 않지만 전통적으로 그리 해왔다. 결과적으로 31을 이용하면, 이 곱셈을 시프트 연산과 뺄셈으로 대체해 최적화 할 수 있다.

 

@Override
public int hashCode() {
   int result = Short.hashCode(areaCode);
   result = 31 * result + Short.hashCode(prefix);
   result = 31 * result + Short.hashCode(lineNum);
   return result;
}

앞선 PhoneNumber 클래스에 적용하면 위와 같다

자바 플랫폼 라이브러리의 클래스들이 제공하는 hashCode 메서드와 비교해도 손색이 없다. 단순하고, 충분히 빠르고, 서로 다른 전화번호들은 다른 해시 버킷들로 제법 훌륭이 분배해준다.

 

Objects 클래스는 임의의 개수만큼 객체를 받아 해시코드를 계산해주는 정적 메서드인 hash를 제공한다. 이 메서드를 활용하면 앞서의 요령대로 구현한 코드와 비슷한 수준의 hashCode 함수를 단 한 줄로 작성할 수 있다. 하지만 아쉽게도 속도는 더 느리다. 입력 인수를 만들기 위한 배열이 만들어지고, 입력 중 기본 타입이 있다면 박싱과 언박싱도 거쳐야 하기 때문이다. 그러므로 성능에 민감하지 않은 상황에서만 사용하자.

@Override
public int hashCode() {
   return Objects.hash(lineNum, prefix, areaCode);
}

 

  클래스가 불변이고 해시코드를 계산하는 비용이 크다면, 캐싱하는 방식을 고려해야 한다. 주로 해시의 키로 사용될 것 같다면 인스턴스가 만들어질 때 해시코드를 계산해둬야 한다. 

  해시의 키로 사용되지 않는 경우라면 hashCode가 처음 불릴 때 계산하는 지연 초기화(lazy initialization) 전략은 어떨까? 필드를 지연 초기화하려면 그 클래스를 스레드 안전하게 만들도록 신경 써야 한다(아이템 83). 예시를 위해 PhoneNumber 클래스를 한번 적용해 보겠다. 한 가지, hashCode 필드의 초깃값은 흔히 생성되는 객체의 해시코드와는 달라야 함에 유념하자.

private int hashCode;

@Override
public int hashcode() {
   int result = hashCode;
   if (result == 0) {
      result = Short.hashCode(areaCode);
      result = 31 * result + Short.hashCode(prefix);
      result = 31 * result + Short.hashCode(lineNum);
      hashCode = result;
   }
   return result;
}

 

  성능을 높인답시고 해시코드를 계산할 때 핵심 필드를 생략해서는 안 된다. 속도야 빨라지겠지만, 해시 품질이 나빠져 해시테이블의 성능을 심각하게 떨어뜨릴 수도 있다. 

 

hashCode가 반환하는 값의 생성 규칙을 API 사용자에게 자세히 공표하지 말자. 그래야 클라이언트가 이 값에 의지하지 않게 되고, 추후에 계산 방식을 바꿀 수도 있다. 

 

equals를 재정의할 때는 hashCode도 반드시 재정의해야 한다. Object의 API 문서에 기술된 일반 규약을 따라야 하며, 서로 다른 인스턴스라면 되도록 해시코드도 서로 다르게 구현해야 한다. 하지만 걱정마시라, IDE들이 이런 기능을 제공한다.