Effective Java | #11. equals 를 재정의하려거든 hashCode도 재정의하라

10. equals는 일반 규약을 지켜 재정의하라 에서는 equals를 재정의하면서 hashCode도 반드시 재정의하라고 권고하고 있다.

equals를 재정의한 클래스 모두에서 hashCode도 재정의해야 한다.

Object 명세에서는 다음과 같은 규약이 존재한다.

Object 명세에 명시된 규약

• 변경되지 않은 정보라면 hashCode 메서드는 몇 번을 호출해도 일관된 값을 반환
• eqauls에서 두 객체가 같다고 판단했다면 두 객체의 hashCode도 동일
• equals가 두 객체를 다르다고 판단하더라도 두 객체의 hashCode가 다를 필요는 없으나 달라야 해시테이블의 성능이 좋아질 것(다르게 하라는 소리를 돌려 말하는 것이쥬?🌝)

hashCode 재정의 시 크게 문제되는 조항은 두 번째다.

즉, 논리적으로 같은 객체는 같은 해시 코드를 반환해야 한다.

• 좋은 해시 함수라면 서로 다른 인스턴스에 다른 해시코드를 반환한다.
• 다음은 좋은 hashCode 를 작성하는 간단한 요령이다.

hashCode 작성 요령

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

• 모두 작성했다면 equals한 두 인스턴스가 동일한 hashCode를 반환하는지 확인할 것
  (AutoValue프레임워크를 사용한다면 테스트 필요 X)

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

/**
 * 휴대폰 번호의 hashCode
 * @return
 */
@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;
}

• 곱할 숫자를 31로 한 것은 31이 홀수&소수이기 때문
  • 결과적으로 31을 이용하면, 이 곱셈을 시프트 연산과 뺄셈으로 대체해 최적화할 수 있음(31*i는 (i<<5)-i와 같다), 검새해볼때는 31 이외의 다른 소수를 사용해도 되지만 관행같은 것이라고 한다.
• 성능을 높인다고 해시코드 계산시 핵심 필드를 생략해서는 안됨
  • 계산 속도는 빨라질지언정 해시테이블 성능이 낮아짐
• hashCode 생성 규칙을 API 사용자에게 자세히 공표하지 말 것.
  • 그래야 클라이언트가 이 값에 의지X, 추후에 계산 방식을 바꿀 수 있음

불변클래스이고 해시코드 계산 비용이 크다면, 캐싱 방식 고려

핵심 정리

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