아이템 11. equals를 재정의하려거든 hashCode도 재정의하라

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

• equals 비교에 사용되는 정보가 변경되지 않았다면, 애플리케이션이 실행되는 동안 그 객체의 hashCode 메서드는 몇 번을 호출해도 일관되게 항상 같은 값을 반환해야 한다. 단, 애플리케이션을 다시 실행한다면 이 값이 달라져도 상관없다.
• equals(Object)가 두 객체를 같다고 판단했다면, 두 객체의 hashCode는 똑같은 값을 반환해야 한다.
• equals(Object)가 두 객체를 다르다고 판단했더라도, 두 객체의 hashCode가 서로 다른 값을 반환할 필요는 없다. 단, 다른 객체에 대해서는 다른 값을 반환해야 해시테이블의 성능이 좋아진다.
  hashCode 재정의를 잘못했을 때 크게 문제가 되는 조항은 두 번째다. 즉, 논리적으로 같은 객체는 같은 해시코드를 반환해야 한다. equals는 물리적으로다른 두 객체를 논리적으로 같다고 할 수 있다. 하지만 Object의 기본 hashCode 메서드는 이 둘이 전혀 다르다고 판단하여, 규약과 달리 서로 다른 값을 반환한다.

코드

public final class PhoneNumber {
    private final short areaCode, prefix, lineNum;

    public PhoneNumber(int areaCode, int prefix, int lineNum) {
        this.areaCode = rangeCheck(areaCode, 999, "지역코드");
        this.prefix   = rangeCheck(prefix,   999, "프리픽스");
        this.lineNum  = rangeCheck(lineNum, 9999, "가입자 번호");
    }

    private static short rangeCheck(int val, int max, String arg) {
        if (val < 0 || val > max)
            throw new IllegalArgumentException(arg + ": " + val);
        return (short) val;
    }

    @Override public boolean equals(Object o) {
        if (o == this)
            return true;
        if (!(o instanceof PhoneNumber))
            return false;
        PhoneNumber pn = (PhoneNumber)o;
        return pn.lineNum == lineNum && pn.prefix == prefix
                && pn.areaCode == areaCode;
    }

    // 나머지 코드는 생략 - hashCode 메서드는 꼭 필요하다(아이템 11)!
}

public class Main {
    public static void main(String[] args) {
        Map<PhoneNumber, String> m=new HashMap<>();
        m.put(new PhoneNumber(707, 867, 5309), "제니");
        System.out.println(m.get(new PhoneNumber(707, 867, 5309)));
    }
}

출력 결과

null

위 코드는 2개의 PhoneNumber 인스턴스를 사용했다. 두 인스턴스는 동치이지만 PhoneNumber 크래스에서 hashCode를 재정의하지 않았기 때문에 논리적 동치인 두 객체가 서로 다른 해시코드를 반환하여 두 번째 규약을 지키지 못한다. 설사 두 인스턴스를 같은 버킷에 담았더라도 get 메서드는 여전히 null을 반환하는데 HashMap은 해시코드가 다른 엔트리끼리는 동치성 비교를 시도조차 하지 않도록 최적화되어 있기 때문이다.

올바른 hashCode 메서드

올바르지 않은 경우부터 먼저 보겠다.

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

이 코드는 동치인 모든 객체에서 똑같은 해시코드를 반환하니 적법하다. 하지만 모든 객체에게 똑같은 값을 내어주므로 해시테이블 버킷 하나에 모든 객체가 담겨 마치 연결리스트처럼 동작한다. 그 결과 시간복잡도가 O(1)인 해시테이블이 O(n)이 되어버리는 대참사가 난다.

좋은 해시 함수는 서로 다른 인스턴스에 다른 해시코드를 반환한다. 이것이 바로 hashCode 의 세번째 규약이 요구하는 속성이다. 다음은 좋은 hashCode를 작성하는 법이다.

1. int 변수 result 선언한 후 값 c로 초기화한다. 이때 c는 해당 객체의 첫 번재 핵심 필드를 단계 2.a 방식으로 계산한 해시코드다.

2. 해당 객체의 나머지 핵심 필드 f 각각에 대해서 다음 작업을 수행한다.
   a. 해당 필드의 해시코드 c를 계산한다.

   i. 기본 타입 필드라면, `Type.hashCode(f)`를 수행한다. 여기서 `Type`은 해당 기본 타입의 박싱 클래스다.
    ii. 참조 타입 필드면서 이 클래스의 `equals` 메서드가 이 필드의 `equals` 메서드를 재귀적으로 호출해 비교한다면, 이 필드의 `hashCode`를 재귀적으로 호출한다. 계산이 더 복잡해질 것 것 같으면, 이 필드의 표준형을 만들어 그 표준형의 `hashCode`를 호출한다. 필드의 값이 `null`이면 0을 사용한다.
    iii. 필드가 배열이라면, 핵심 원소 각각을 별도 필드처럼 다룬다. 이상의 규칙을 재귀적으로 적용해 각 핵심 원소의 해시코드를 계산한 다음, 단계 `2.b`방식으로 갱신한다. 배열에 핵심 원소가 하나도 없다면 단순히 상수(0을 추천한다)를 사용한다. 모든 원소가 핵심 원소라면 `Arrays.hashCode`를 사용한다.
       

   b. 단계 2.a에서 계산한 해시코드 c로 result를 갱신한다. 코드로는 다음과 같다.

   result=31*result+c;

3. result를 반환한다.

테스트 코드로 제대로 구현했는지 검사하는데 AutoValue를 썼다면 건너뛰어도 된다.
파생 필드(핵심 필드로 계산해낼 수 있는 필드)는 해시코드 계산에서 제외해도 된다. 또한 equals 비교에 사용되지 않은 필드는 반드시 제외해야 한다. 그렇지 않으면 hashCode 규약 두 번재를 어기게 될 위험이 있다.
위 코드에서 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;
    }

위 코드를 PhoneNumber 클래스에 추가해주고 다시 아래의 코드를 실행해본다.

public class Main {
    public static void main(String[] args) {
        Map<PhoneNumber, String> m=new HashMap<>();
        m.put(new PhoneNumber(707, 867, 5309), "제니");
        System.out.println(m.get(new PhoneNumber(707, 867, 5309)));
    }
}

출력 결과

제니

출력 결과를 통해 동치인 PhoneNumber 인스턴스들이 같은 해시코드를 가진 것을 알 수 있다.

Objects 클래스는 임의이 개수만큼 객체를 받아 해시코드를 계산해주는 정적 메서드인 hash를 제공한다. 이 메서드를 활용하면 앞서의 요령대로 구현한 코드와 비슷한 수준의 hashCode메서드를 단 한 줄로 작성할 수 있다. 하지만 아쉽게도 속도는 더 느리다.

Objects hashCode 활용 코드

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

위 코드로 변경하고 Main클래스의 main메서드를 실행한 결과이다.

출력 결과

제니

출력 결과를 보면 Objects 클래스의 hash 메서드를 활용한 hashCode메서드도 잘 작동하는 것을 알 수 있다.

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