[이펙티브 자바 3/E] 아이템11 - equals를 재정의하려거든 hashCode도 재정의하라

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

< Object 명세에서 발췌한 규약 >

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

- equals는 물리적으로 다른 두 객체를 논리적으로는 같다고 할 수 있다. 하지만 Object의 기본 hashCode 메서드는 이 둘이 전혀 다르다고 판단하여, 규약과 달리 (무작위처럼 보이는) 서로 다른 값을 반환한다.

- 좋은 해시 함수라면 서로 다른 인스턴스에 다른 해시코드를 반환한다. => hashCode의 세 번째 규약이 요구하는 속성

- 이상적인 해시 함수는 주어진 (서로 다른) 인스턴스들을 32비트 정수 범위에 균일하게 분배해야 한다.

---

< 좋은 hashCode를 작성하는 간단한 요령 >

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

- 31 * i는 (i << 5) - i 와 같다. 31은 홀수이면서 소수다.

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

- equals 비교에 사용되지 않은 필드는 '반드시' 제외해야 한다.

---

전형적인 hashCode 메서드(PhoneNumber 클래스가 있다고 가정할 때)

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

 

한 줄짜리 hashCode 메서드

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

- 속도는 더 느리므로 성능에 민감하지 않은 상황에서만 사용하자.

---

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

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