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

  equals를 재정의한 클래스 모두에서 hashCode도 재정의해야 한다. 그렇지 않으면 클래스 인스턴스를 HashMap 같은 컬랙션의 원소로 사용할 때 문제가 발생한다.

  자바 레퍼런스의 Object에 있는 hashCode의 명세를 보면 다음과 같이 hashCode를 설명한다.

    1. equals 비교에 상요되는 정보가 변경되지 않았다면, 애플리케이션이 실행되는 동한 그 객체의 hashCode 메서드는 호출 횟수와

      무관하게 같은 값을 반환해야 한다. 단, 애플리케이션을 재실행 한다면 값이 달라져도 상관없다.

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

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

    3. equals(Object)가 두 객체를 다르다 판단했어도, 두 객체의 hashCode가 서로 다른 값을 반환할 필요가 없다.

      단, 다른 객체에 대해 다른 값을 반환하면 해시테이블의 성능이 좋아진다.

  equals는 물리적으로 다른 두 객체를 논리적으로 같다 할 수 있지만 Object의 기본 hashCOde 메서드는 이 둘이 전혀 다르다 판단해 규약과 달리 서로 다른 값을 반환한다.

  좋은 해시 함수는 서로 다른 인스턴스에 다른 해시코드를 반환해야 한다. 이상적인 해시 함수는 서로 다른 인스턴스들을 32비트 정수 범위에 균일하게 분배해야 한다.

  좋은 hashCode를 작성하는 방법은 다음과 같다.

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

        - 이때 c는 해당 객체의 첫번째 핵심 필드를 단계 2.1 방식으로 계산한 해시코드다.

        - 핵심 필드는 euqals 비교에 사용되는 필드다.

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

        2.1. 해당 필드의 해시코드 c를 계산한다.

          - 기본타입 필드면 Type.hashCode(f)를 수행한다. Type은 해당 기본 타입의 래퍼 클래스다.

          - 참조 타입 필드면서 해당 크래스의 euqals가 필드의 equals를 재귀적으로 호출한다면, 이 필드의 hashCode를

            재귀적으로 호출한다. 필드값이 null이면 0을 사용한다.

          - 필드가 배열이면 각 핵심 원소를 별도의 필드처럼 다룬다. 배열에 핵심 원소가 하나도 없으면 상수 0을 사용한다.

            모든 원소가 핵심이면 Arrays.hashCode를 사용한다.

       2.2. 2.1에서 계산한 해시코드 c로 result를 갱신한다.(result = 31 * result + c;)

    3. result를 반환한다.

  파생 필드(다른 필드로부터 계산해 낼 수 있는 필드)는 무시해도 된다. 또 한 euqals 연산에 사용되지 않는 필드는 반드시 제외해야 위에서 말한 "equals(Object)가 두 객체를 같다고 판단하면, 두 객체의 hashCode는 똑같은 값을 반환해야 한다"를 만족할 수 있다.

  단계 2.2의 곱셈은 필드를 곱하는 순서에 따라 다르기 때문에 비슷한 필드가 여러개면 해시 효과를 크게 높여준다. 곱한 숫자가 31인 이유는 31이 홀수면서 소숴이기 떄문이다. 숫자가 짝수고 오버플로가 발생하면 정보를 잃는다(2를 곱하는 것은 시프트 연산과 같기 때문이다).

  위 방식을 통해 작성한 hashCode의 예시는 다음과 같다.

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

  Objects 내에는 임의의 개수만큼 객체를 받아 해시코드를 계산해주는 정적 메서드인 hash를 제공한다. 하지만 이 메서드는 입력 인수를 담기 위한 배열을 만들고, 기본 타입에 대한 박식, 언박싱을 거쳐야 하기 때문에 느리다. 따라서 성능에 민감하지 않은 상황에서만 사용하자. 이 hash 메서드의 로직은 다음과 같다.

// Objects의 hash
public static int hash(Object... values) {
    return Arrays.hashCode(values);
}
 
// Arrays의 hash
public static int hashCode(Object a[]) {
    if (a == null)
        return 0;
 
    int result = 1;
 
    for (Object element : a)
        result = 31 * result + (element == null ? 0 : element.hashCode());
 
    return result;
}
 

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

  해시의 키로 사용되지 않는 경우면 hashCode가 처음 불릴 때 지연 초기화를 해도 된다. 하지만 지연 초기화의 경우 그 클래스를 thread-safe하게 만들어야 한다. 아래의 예시는 지연 초기화를 사용한 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 사용자에게 알리지 말라. 그래야 클라이언트가 이 값에 의지하지 않게 되고, 추후에 계산 방식을 바꿀 수 있다.

 

출처 - 이펙티브 자바