[Effective-Java] Chapter3 #11. equals를 재정의하려거든 hashCode도 재정의하라

HashMap이나 HashSet 같은 컬렉션의 원소로 사용할 때 문제가 발생할 수 있다.

✒️ hashCode

hashCode는 알고리즘에 의해 생성된 정수 값이다.
객체 내용을 기반으로 생성하기도 하지만, 할당된 메모리 주소를 기반으로 생성되는 정수값일 수도 있다.
즉, 완전히 동일한 내용의 객체라 할 지라도 다른 hashCode 값을 반환한다는 보장을 할 수 없다.

📌 Object 명세에서 말하는 hashCode 규약

equals 비교에 사용되는 정보가 변경되지 않았다면, 애플리케이션이 실행되는 동안 그 객체의 hashCode도 변하면 안 된다. (단, 애플리케이션을 다시 실행한다면 값이 달라져도 상관 없다.)
equals가 두 객체를 같다고 판단했으면, 두 객체의 hashCode는 같은 값을 반환해야 한다.
equals가 두 객체를 다르다고 판단했더라도, hashCode는 꼭 다를 필요는 없다. (하지만, 다른 객체에 대해서는 다른 값을 반환해야 해시 테이블 성능이 좋아진다.)

📌 논리적 동치 관계의 객체는 같은 hashCode를 반환해야 한다.

한 가지 예시를 살펴보자.

public final class PhoneNumber {
    private final short areaCode, prefix, lineNum;
    ...
    @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;
    }
    ...
}

Map<PhoneNumber, String> m = new HashMap<>();
m.put(new PhoneNumber(707, 867, 5309), "제니");

동등성(==)은 다르지만 동일성(equals)은 같은 두 객체는 서로 다른 hashCode를 반환한다.

따라서, 이 코드에 m.get(new PhoneNumber(010, 1234, 5678))을 실행하면 "리치"가 아니라 null을 반환한다.

왜냐하면, HashMap은 hashCode가 다른 Entry는 동치성 비교조차 시도하지 않도록 최적화되어 있기 때문이다.

그 결과 get 메서드는 엉뚱한 해시 버킷에 가서 객체를 찾으려 하며, 설사 두 인스턴스를 같은 버킷에 담았더라도 get 메서드는 여전히 null을 반환한다.

이 문제는 PhoneNumber의 hashCode를 재정의 해주면 된다.

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

그렇다고 이렇게 작성하면 안 된다.

해당 스니펫은 논리적 동치 관계 뿐만 아니라 모든 객체에게 똑같은 해시값을 내어주므로 모든 객체가 해시테이블 버킷 하나에 담겨 연결 리스트처럼 동작한다.

그 결과 해시 코드 값으로 비교 수행하는 단계가 정상 작동하지 않아, HashTable 최적화 기능이 무용지물이 되기 때문에, 평균 수행 시간이 O(1)에서 O(N)으로 느려지게 된다.

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

이상적인 해시 함수는 서로 다른 인스턴스를 32bit 정수 범위에 균일하게 분배해야 한다.

이상이기 때문에 완벽하게 구현하는 것은 어려울 수 있으나, 비슷하게 만드는 간단한 요령은 다음과 같다.

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

hashCode를 구현하고 이 메서드가 논리적 동치이 인스턴스에 똑같은 해시 코드를 반환하는 것을 보장하는 것을 자문해봐야 한다.

AutoValue로 equals와 hashCode 메서드를 생성했다면 건너뛰어도 좋지만, 그게 아니라면 직관을 검증할 단위 테스트를 작성하고, 동치 관계인 인스턴스가 서로 다른 해시코드를 리턴한다면 원인을 해결해야 한다.

여기 주의해야 할 점들이 몇 가지 있다.

파생 필드는 해시코드 계산에서 제외해도 된다. 다른 필드로부터 계산해낼 수 있는 필드는 모두 무시해도 된다.
equals 비교에 사용되지 않은 필드는 반드시 제거해야 한다. (hashCode 2번 째 규약을 어기게 될 수 있다.)
31을 곱하는 이유는 비슷한 필드가 여러 개일 때 해시 효과를 크게 높여준다. 그냥 더하기만 하면 같은 값이 나올 확률을 배제할 수 없다. 31은 홀수이면서 소수이기 때문에 곱하였을 때, 큰수로 만들어 해시효과를 증가시킨다. 시프트 연산과 뺄셈으로 최적화가 가능하다. (i << 5) - i

위의 방법론을 이용해 PhoneNumber 클래스에 적용해보자.

// 전형적인 hashCode method
@Override public int hashCode() {
    int result = Integer.hashCode(areaCode);
    result = 31 * result + Integer.hashCode(prefix);
    result = 31 * result + Integer.hashCode(lineNum);
    return result;
}

PhoneNumber 인스턴스 핵심 필드 3개를 사용해 계산을 수행하고, 이 과정에 비결정적 요소는 존재하지 않는다.

따라서, 동치 관계의 PhoneNumber 인스턴스들은 같은 해시코드를 가질 것이 명백하다.

이 방법대로 작성한다면 품질이나 해싱 기능 면에서 여타 다른 자바 플랫폼 라이브러리가 사용한 방식과 견줄만하며, 대부분의 쓰임에도 문제가 없다.

(단, 그럼에도 해시 충돌을 더욱 적은 방법을 사용해야만 한다면 com.google.common.hash.Hashing을 참고하라)

Object 클래스는 임의의 개수만큼 객체를 받아 해시코드를 계산해주는 정적 메서드 hash를 제공하고 있다.

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

비록 코드는 훨씬 간결해지지만, 입력 인수를 담기 위한 배열을 생성하고, 기본 타입이 있다면 캐스팅 과정도 거치기 때문에 성능이 다소 저하된다는 단점이 있다.

만약, hash 메서드를 사용할 것이라면 성능이 민감하지 않은 환경에서 사용하자.

📌 hashCode의 캐싱(Caching)과 지연 초기화(lazy initialization)

클래스가 불변이고 해시코드를 계산하는 비용이 크다면, 굳이 바뀌지 않을 값이 매번 새로 계산되는 것은 불필요한 작업이다.

따라서, 해당 타입의 객체가 주로 Hash의 키로 사용될 것 같다면 인스턴스가 만들어질 때 해시코드를 계산해두어야 한다.

필드를 지연 초기화 하려면, 해당 클래스가 Thread-safe가 되도록 동기화에 신경 써라. (Item 83)

private int hashCode;

@Override
public int hashCode() {
    int result = hashCode; // 초기값 0을 가진다.
    if(result == 0) {
        int result = Integer.hashCode(areaCode);
        result = 31 * result + Integer.hashCode(areaCode);
        result = 31 * result + Integer.hashCode(areaCode);
        hashCode = result;
    }
    return result;
}

📌 결론

equals를 재정의하여 논리적 동치성 비교 로직으로 바꾸었다면, hashCode도 반드시 재정의해야 한다.
성능을 높인답시고 hashCode를 계산할 때 핵심 필드를 생략하지 마라.
- 어떤 필드는 특정 영역에 몰린 인스턴스들의 해시코드를 넓은 범위로 고르게 퍼트려주는 효과가 있을지도 모른다. 하필 이런 필드를 생략한다면 해당 영역의 수많은 인스턴스가 단 몇 개의 해시코드로 집중되어, 해시테이블 속도가 선형으로 느려질 것이다.
- 실제로 Java2 이전의 String은 최대 16개 문자만으로 해시코드만을 계산했다. URL처럼 계층적인 이름이 들어오면 심각한 문제를 껴안게 된다.
hashCode는 Object API Document에 기술된 일반 규약을 따라야 하며, 서로 다른 인스턴스라면 되도록 해시코드도 서로 다르게 구현하라.
hashCode가 반환하는 값의 생성 규칙을 API 사용자에게 자세히 공표하지 말자. 그래야 클라이언트가 이 값에 의지하지 ㅇ낳게 되고, 추후에 계산 방식을 바꿀 수도 있다.

저작자표시 비영리

티스토리툴바