[Effective Java] 아이템11: equals를 재정의하려거든 hashCode도 재정의하라

 

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

 

✔️ hashCode 에 관한 규약

다음은 Object 명세에서 발췌한 규약이다.

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

 

 

✔️ 좋은 hashCode를 작성하는 요령

이상적인 해시 함수는 주어진 서로 다른 인스턴스들을 32비트 정수 범위에 균일하게 분배해야 한다. 다음은 좋은 hashCodeㄹ르 작성하는 간단한 요령이다.

1. int 변수 result를 선언한 후 값 c로 초기화한다. 이때 c는 해당 객체의 첫 번째 핵심 필드를 단계 2.a 방식으로 계산한 해시코드다.
   * 핵심 필드란, equals 비교에 사용되는 필드를 말한다. (아이템 10 참조)
2. 해당 객체의 나머지 핵심 필드 f 각각에 대해 다음 작업을 수행한다.
   
   
   1. 해당 필드의 해시코드 c를 계산한다.
      1. 기본 타입 필드라면, Type.hashCode(f)를 수행한다. 여기서 Type은 해당 기본 타입의 박싱 클래스다.
      2. 참조 타입 필드면서 이 클래스의 equals 메서드가 이 필드의 equals를 재귀적으로 호출해 비교한다면, 이 필드의 hashCode를 재귀적으로 호출한다. 계산이 복잡해질 것 같으면, 이 필드의 표준형을 만들어 그 표준형의 hashCode를 호출한다. 필드의 값이 null이면 0을 사용한다. (다른 상수도 괜찮지만 전통적으로 0을 사용한다.)
      3. 필드가 배열이라면 핵심 원소 각각을 별도 필드처럼 다룬다. 이상의 규칙을 재귀적으로 적용해 각 핵심 원소의 해시코드를 계산한 다음, 단계 2.b 방식으로 갱신한다. 배열에 핵심 원소가 하나도 없다면 단순히 상수(0을 추천한다)를 사용한다. 모든 원소가 핵심 원소라면 Arrays.hashCode를 사용한다.
   2. 단계 2.a에서 계산한 해시코드 c로 result를 갱신한다. 코드로는 다음과 같다.
      result = 31 * result + c;
3. result를 반환한다.

📌  2.b 단계에서 곱할 숫자로 31을 정한 이유는 무엇일까?
그것은 바로 31이 홀수이면서 소수(prime)이기 때문이다.
만약 이 숫자가 짝수이고 오버플로가 발생한다면 정보를 잃게 된다.

 

 

✔️ 주의 사항

1️⃣  파생 필드는 해시코드 계산에서 제외해도 된다.
즉 다른 필드로부터 계산해낼 수 있는 필드는 모두 무시해도 된다.

2️⃣  equals 비교에 사용되지 않은 필드는 '반드시' 제외해야 한다.
그렇지 않으면 두 번째 규약을 어기게 될 위험이 있다.

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

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

 

 

✔️ 예시

다음은 PhoneNumber 클래스의 hashCode 메서드에 대한 예시이다.

📍 전형적인 hashCode 메서드

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

위의 메서드는 PhoneNumber 인스턴스의 핵심 필드 3개만을 사용해 간단한 계산을 수행한다.

그 과정에 비결정적 요소는 전혀 없으므로 동치인 인스턴스들은 모두 같은 해시코드를 가질 것이 확실하다.

 

📍 지연 초기화하는 hashCode 메서드

클래스가 불변이고 해시코들르 계산하는 비용이 크다면, 매번 새로 계산하기 보다는 캐싱하는 방식을 고려해야 한다.

다음은 hashCode가 처음 불릴 때 계산하는 지연 초기화(lazy initialization) 전략을 적용한 것이다. (단, 필드를 지연 초기화하려면 클래스를 스레드 안전하게 만들도록 신경써야 한다.)

private int hashCode;	// 자동으로 0으로 초기화된다.

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

 

 

 

 

핵심 정리

equals 를 재정의할 때는 hashCode 도 반드시 재정의해야 한다.
그렇지 않으면 프로그램이 제대로 동작하지 않을 것이다.
재정의한 hashCode는 Object의 API 문서에 기술된 일반 규약을 따라야 하며, 서로 다른 인스턴스라면 되도록 해시코드도 서로 다르게 구현해야 한다.
AutoValue 프레임워크를 사용하면 멋진 equals와 hashCode를 자동으로 만들어준다.