[Effective Java 3E] equals를 재작성하려거든 hashcode도 재정의하라

💥 개요

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

그렇지 않으면 해당 클래스의 인스턴스를 HashMap이나 HashSet 같은 컬렉션의 원소로 사용할 때 문제를 일으키게 됩니다. 다음은 Object 명세에서 발췌한 규약입니다.

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

- equals가 두 객체를 다르다고 판단했다면, 두 객체의 hashcode는 똑같은 값을 반환해야 한다.

- equals가 두 객체를 다르다고 판단했더라도, 두 객체의 hashcode가 서로 다른 값을 반환할 필요는 없다. 단, 다른 객체에 대해서는 다른 값을 반환해야 해시테이블의 성능이 좋아진다.

 

🩻 문제

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개의 인스턴스가 생성됐는데, 하나는 new 생성자를 이용해 HashMap에 "제니"를 넣을 때, 하나는 이를 꺼내려 할 때 생성 됐습니다.

PhoneNumber 클래스는 hashcode를 정의하지 않았기 때문에 논리적 동치인 두 객체가 서로 다른 해시코드를 반환하여 두 번째 규약을 지키지 못했기 때문 입니다.

두 인스턴스가 HashMap에 같은 버킷에 담았더라도 여전히 null을 반환하는데, HashMap은 최적화되어 다른 엔트리 끼리 동치성 비교를 시도조차 하지않기 때문 입니다.

이 문제는 올바른 hashCode 메서드만 작성하면 해결됩니다. 그럼 옳바른 hashCode는 어떤 모습일까요?

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

위와 같이 작성하면 모든 객체에서 똑같은 해시코드를 반환하니 적법하지만, 절대 사용해서는 안됩니다.

그 이유는 해시테이블 버킷에 담겨 마치 연결 리스트처럼 동작하여, 평균 수행시간이 O(1)인 해시테이블이 O(n)으로 느려져서 성능에 아주 큰 악영향을 끼칩니다.

 

🎆 좋은 해시 함수라면 서로 다른 인스턴스에 다른 해시코드를 반환한다.

좋은 hashCode를 작성하는 요령

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

 

주의할 점

• equals비교에 사용되는 필드에 대해서만 해시코드를 계산한다.
• 해시를 계산하는 과정의 성능을 높인답시고 해시코드를 계산할 때 핵심 필드를 생략해서는 안 된다.
• 만약 hash로 바꾸려는 필드가 기본 타입이 아니면 해당 필드의 hashCode를 불러 구현한다.
  계산이 복잡한 경우는 표준형을 만들어 구현한다.
• 참조 타입 필드가 null일 경우 0을 사용.
• 31을 곱하는 이유는 비슷한 필드가 여러개일 때 해시효과를 크게 높여주기 위해서다.
  비슷한 값들이 여러개 있을때 그냥 더하면 같은 값이 나올 확률이 높다.
  그래서 31을 곱해 큰수로 만들어 해시효과를 증가시킨다.
• hashCode가 반환하는 값의 생성 규칙을 API 사용자에게 자세히 공표하지 말자. 그래야 클라이언트가 이 값에 의지하지 않고, 추후에 계산 방식을 바꿀 수 있다.

 

💡해시 정의 예시

전형적인 해시코드

    // 코드 11-2 전형적인 hashCode 메서드 (70쪽)
    @Override public int hashCode() {
        int result = Short.hashCode(areaCode);
        result = 31 * result + Short.hashCode(prefix);
        result = 31 * result + Short.hashCode(lineNum);
        return result;
    }

위의 메서드는 3개의 필드만을 사용해 간단한 계산을 수행합니다. 위의 코드는 PhoneNumber 필드에 딱 맞게 구현한 hashCode고 충분히 빠르고 라이브러리들과 비교해도 손색이 없습니다.

 

Objects 클래스를 활용한 해시코드

    // 코드 11-3 한 줄짜리 hashCode 메서드 - 성능이 살짝 아쉽다. (71쪽)
    @Override public int hashCode() {
        return Objects.hash(lineNum, prefix, areaCode);
    }

이 Object.hash를 통해 앞서 요령대로 구현한 코드와 비슷한 수준의 hashcode 함수를 단 한줄로 작성할 수 있습니다.

하지만 속도는 더 느린 편인데 입력 인수를 담기 위한 배열이 만들어지고, 기본 타입이 있으면 박싱과 언박싱을 거치게 됩니다. 속도에 민감하지 않은 경우에 사용하면 좋습니다.

 

지연초기화 하는 해시코드

    // 해시코드를 지연 초기화하는 hashCode 메서드 - 스레드 안정성까지 고려해야 한다. (71쪽)
    private int hashCode; // 자동으로 0으로 초기화된다.

    @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;
    }

클래스가 불변이고, 해시코드를 계산하는 비용이 크다면, 매번 새로 계산하는 방법 보다 캐싱하는 방식을 고려해야 합니다. 하지만 hash의 키로 잘 사용되지 않는 경우에는 지연 초기화(lazy initialization) 전략을 이용할 수 있습니다. 하지만 hashCode 필드의 초깃값은 흔히 생성되는 객체의 해시코드와는 달라야합니다.

 

equals를 재정의할 때는 hashCode도 반드시 재정의해야 한다. 그렇지 않으면 프로그램이 제대로 동작하지 않을 것이다. 재정의한 hashCode는 Object의 API 문서에 기술된 일반 규약을 따라야 하며, 서로 다른 인스턴스라면 되도록 해시코드도 서로 다르게 구현해야 한다. 이렇게 구현하기가 어렵지는 않지만 조금 따분한 일이긴 하다. 하지만 AutoValue 프레임워크를 사용하면 멋진 equals와 hashCode를 자동으로 만들어준다. IDE도 이런 기능을 제공한다.