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

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

여기서 Object의 명세 규약을 보자!

Object의 HashCode 명세 규약

1. equals 비교에 사용되는 정보가 변경되지 않았다면, 어플리케이션이 실행되는 동안 객체에서 hashCode 메소드는 몇번을 호출해도 일관되게 항상 같은 값을 반환해야 한다. 단 어플리케이션을 다시 실행한다면 이 값이 달라져도 상관없다.

2. Equals(Object) 가 두 객체를 같다고 판단했다면, 두 객체의 hashCode는 똑같은 값을 반환해야 한다.

3. Equals(Object) 가 두 객체를 다르다고 판단했더라도, 두 객체의 hashCode가 서로 다른 값을 반환할 필요는 없지만 다른 값을 반환해야 성능이 해시 테이블의 성능이 좋아진다.

   여기서 중요한건 2번으로, 논리적으로 동치인 객체를 반환했으면 같은 해시코드를 반환해야 한다.

   즉 해시코드를 정의하지 않으면, 물리적으로 다른 두 객체를 논리적으로 같다고 할 수 있지만, Object의 기본 해시코드 메소드는 객체마다 다른 값을 반환하여 잘못된 결과가 나올 수 있다. 다음 예제를 한번 보자.

• 해시코드를 재정의하지 않는 PhoneNumber 객체를 사용한 코드

  Map<PhoneNumber, String> m = new HashMap<>();
  
  public void savePhoneNumber() {    
      m.put(new PhoneNumber(707, 867, 5309), "제니");
  }
  
  public PhoneNumber getJenniePhoneNumber() {
      m.get(new PhoneNumber(707, 867, 5309));
  }

  이 코드에서 getJenniePhoneNumber()를 실행하면 제니가 나와야 할 것 같지만, 실제로는 null을 반환한다. 그 이유는 해시코드를 재정의 하지 않아 논리적으로 동치인 객체를 만들더라도 해시코드는 매번 다르게 나오기 때문이다. 즉 get 메소드는엉뚱한 해시 버킷에 가서 객체를 찾기 때문에 null을 반환하게 된다. 설사 두 인스턴스를 같은 버킷에 담았다러도 hashMap은 해시 코드가 다른 엔트리끼리는 동치성 비교를 시도조차 하지 않기 때문에 null을 반환한다.

HashCode를 정의하는 방법

그럼 어떻게 해결하면 좋을까? 다음 몇가지 예제를 보자

1. hashCode를 상수로 정의한 메소드 - 사용 금지

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

다음 코드는 동치인 모든 객체에서 똑같은 해시코드를 반환하니 적법하다. 하지만 이 방법은 사용하면 안된다. 왜냐하면 모든 객체에게 똑같은 값만 내어주므로 모든 객체가 해시테이블의 버킷 하나에 담겨 마치 연결 리스트처럼 동작하기 때문이다. 이 말은 버킷의 모든 내용들을 탐색을 하게 되고 이는 시간복잡도가 O(n)이 되어 성능상 더 안좋아진다. (해시 테이블의 시간 복잡도 - O(1) )

2. 직접 정의한 hashCode 메소드

   좋은 해시 함수라면 서로 다른 인스턴스에 다른 해시코드를 반환한다. 즉 이상적인 해시 함수는 주어진 인스턴스들을 32비트 정수 범위에 균일하게 분배해야 한다. 이상을 완벽하게 실현하기는 어렵지만 비슷하게 만들기에는 그다지 어렵지 않다.

   다음은 이펙티브 자바에서 말한 hashCode를 작성하는 간단한 요령이다.

3. int 변수 result를 선언한 후 값 c로 초기화 한다.

   1. 이때 c는 해당 객체의 첫번째 핵심 필드(equals 비교에 사용되는 필드)를 단계 2.1 방식으로 계산한 해시코드다.

4. 해당 객체의나머지핵심 필드 f 각각에 대해 다음 작업을 수행한다.

   1. 해당 필드의 해시코드 c를 계산한다.
      1. 기본 타입필드라면, Type.hashCode(f)를 수행한다. 여기서 type은 해당 기본 타입의 박싱 클래스다.
      2. 참조 타입 필드면서 이 클래스의 equals 메소드가 이 필드의 equals를 재귀적으로 호출해 비교한다면, 이 필드의 hashCode를 재귀적으로 호출한다. 계산이 복잡해질 것 같으면, 이 필드의 표전형을 만들어 그 표준형의 hashCode를 호출한다. 필드의 값이 null이면 0을 사용한다. (다른 상수도 괜찮지면 통상적으로 0을 사용한다.)
      3. 필드가 배열이라면, 핵심 원소 각각을 별도 필드처럼 다룬다. 이상의 규칙을 재귀적으로 적용해 각 핵심 원소의 해시코드를 계산한 다음, 단계 2.2 방식으로 갱신한다. 배열에 핵심 원소가 하나도 없다면 단순히 상수(0)를 사용한다. 모든 원소가 핵심 원소라면 Arrays.hashCode를 사용한다.
   2. 단계 2.1에서 계산한 해시코드 c로 result를 갱신한다. 코드로는 result = 31 * result + c;
   3. result 를 반환한다.

   여기서 중요한 점은 다른 필드로부터 계산해 낼 수 있는 필드는 모두 무시해도 되지만, equals 비교에 사용되지 않은 필드는 반드시 제외해야 한다. 그렇지 않으면 위 hashCode 두번째 규약을 어길 확률이 높다. 그리고 자동으로 생성하지 않았으면 똑같은 해시코드를 반환하는지 자문해 보는것이 좋다. 그리고 테스트를 통해 검증을 해보는 것도 좋다.

그리고 위 2.1 단계에서 result를 31로 곱하는데 순서에 따라 해시값이 달라지게 된다. 이 방법으로 비슷한 필드가 여러 개일 때 해시 효과를 크게 높혀준다. 만약 곱셈 없이 구현한다면 모든 anagram(구성하는 철자가 같고 그 순서만 다른 문자열)의 해시코드가 같아진다. 여기서 31을 곱한 이유는 홀수 이면서 소수이기 때문에 31을 사용했다. 만약 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;
}

핵심 필드인 areaCode, prefix, lineNum을 사용해 hashCode 메소드를 만들었다. 이로 인해 동치인 PhoneNumber 인스턴스들은 같은 해시코드를 가질 수 있게 되었고, 단순하면서, 충분히 빠르고, 서로 다른 전화번호들은 다른 해시 버킷들로 문제없이 분배해준다.

여담으로 해시 충돌이 더욱 적은 방법을 써야 한다면 Google의 Guava 라이브러리를 사용해도 된다.

3. 한줄짜리 hashCode 메소드 - 성능 이슈 발생 가능성

이 방법은 Objects 클래스에서 임의의 개수만큼 객체를 받아 해시코드를 계산하는 정적 메소드인 hash를 사용한 방법이다. 이 메소드를 구현하면 hashCode를 코드 한줄로 해결할 수 있다. 다음 예를 보자

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

위 예제를 보면 정말 단순하다는 것을 느낄 수 있다. 그리고 편리해 보인다.

하지만 아쉽게도 속도가 느리다. 그 이유는 입력 인수를 담기 위한 배열이 만들어지게 되고, 입력 중 기본 타입이 있다면 박싱과 언박싱도 거쳐야 하기 때문이다. 그러니 Object의 hash 메소드는 성능에 민감하지 않은 상황에서만 사용하자!

좀 더 들어가자면...

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

해시의 키로 사용되지 않는 경우라면 hashCode가 처음 불릴 때 계산하는 지연 초기화 전략을 사용하면 좋지만 해당 클래스의 스레드를 안전하게 만들도록 신경 써야 한다.

다음 예를 보자

• 해시코드를 지연 초기화하는 hashCode 메소드 - 스레드 안정성까지 고려

private int hashCode;

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

그리고 성능을 높인답시고 해시코드를 계산할 때 핵심 필드를 생략해서는 안된다.

속도야 빨라지겠지만, 해시 품질이 나빠져 해시테이블의 성능을 심각하게 떨어뜨릴 수도 있다. 특히 어떤 필드는 특정 영역에 몰린 인스턴스들의 해시코드를 넓은 범위로 고르게 퍼트려주는 효과가 있을지도 모른다. 즉 해당 영역의 수많은 인스턴스가 단 몇개의 해시코드로 집중되어 해시테이블의 속도가 선형으로 느려질 것이다. (실제로 자바 2에서16개의 문자만으로 해시코드를 계산했는데 URL 같은 점층적으로 길어지는 필드 경우 위와 같은 문제를 야기했다.)

마지막으로 hashCode가 반환하는 값의 생성 규칙을 API 사용자에게 자세히 공표하지 말자. 그래야 클라이언트가 이 값에 의지하지 않게 되고, 추후에 계산 방식을 바꿀 수 있다. 즉 해시 기능에서 결함이 발생했다면 자체적으로 더 나은 해시 방식을 알아낸 경우 다음 릴리스에 자연스럽게 수정할 수 있다.

정리

따라서 정리하면 다음과 같다.

1. Equals를 재정의할 때는 hashCode도 반드시 재정의해야 한다.
2. 재정의한 hashCode는 Object API 문서에 기술된 일반 규약을 따라야 하며, 되도록 해시코드도 서로 다르게 구현해야 한다.
3. 귀찮으면 AutoValue 프레임워크를 사용해 정의하자.