DEV ℧ Developer Diary

[EffectiveJava] item11 - equals를 재정의하려거든 hashCode도 재정의하라.

27 Apr 2022

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

왜 해시코드를 재정의 해야할까?

대망의 equals시리즈 제 2탄 값을 동일하게 비교할 수 있도록 재정의를 한다면 hashCode를 재정의 함으로써 객체의 주소값 또한 재정의를 해야 한다.

왜냐? 주소값이 달라지기 때문에, HashMap이나 HashSet같은 컬렉션의 원소로 사용할 때 문제를 일으키게 된다.

다음은 Object 명세에서 발췌한 규약이다.

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

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

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

hashCode 재정의를 잘못 했을 때 크게 문제가 되는 조항은 두 번째다. 즉, 논리적으로 같은 객체는 같은 해시코드를 반환해야 한다.

hashCode를 재정의 하지 않을 경우 equals에서 물리적으로 다른 두 객체를 논리적으로 같다고 반환 할 수 있지만, Object의 기본 hashCode 메서드는 이 둘이 전혀 다르다고 판단하여, 서로 다른 값을 반환한다.

예를 들어 보자

Map<PhoneNumber, String> m = new hashMap<>();
m.put(new PhoneNumber(010, 0000, 0000), "MH");

해당 코드를 이용해 PhoneNumber객체가 key인 MH값을 넣어줬을 때 동일한 값을 넣은 PhoneNumber의 새 인스턴스로 HashMap에서 get을 해보자.

m.get(new PhoneNumber(010, 0000, 0000));

해당 코드는 “MH”를 반환 하는 것이 아닌 null을 반환한다.

PhoneNumber 클래스의 hashCode를 재정의하지 않았기 때문에 두 객체가 서로 다른 해시코드를 반환하여 두 번째 규약을 지키지 못한다. 그 결과 get 메서드는 엉뚱한 해시 버킷에 가서 객체를 찾다보니 null이 반환된 것이다.

해당 문제는 hashCode 메서드만 작성해주면 해걸된다.

먼저 같은 결과인 “MH”가 나오도록 극단적으로 변경해보자. 해당 방법은 절대 사용하면 안되는 방법이다.

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

이 코드는 동치인 모든 객체에서 똑같은 해시코드를 반환하지만 모든 객체에게 똑같은 값만 내어주므로, 모든 객체가 해시테이블의 버킷 하나에 담겨 연결리스트처럼 동작한다. 그 결과 평균 수행 시간이 O(1)인 해시테이블이 O(n)으로 느려져서, 객체가 많아지면 도저히 쓸 수 없게 된다.

어떤 해시코드가 좋은 해시코드일까?

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

비록 이상적으로 실현하기는 어렵지만 비슷하게 만들기는 그다지 어렵지 않다.

다음은 좋은 hashCode를 작성하는 간단한 요령이다.

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

파생 필드는 해시코드 계산에서 제외해도 된다. 즉, 다른 필드로부터 계산해 낼수 있는 필드는 모두 무시해도된다. 또한 equals 비교에 사용되지 않은 필드는 ‘반드시’ 제외해야 한다. 그렇지 않으면 hashCode규약 두 번째를 어기게 된다.

단계 2.iii의 곱셈 31 * result는 필드를 곱하는 순서에 따라 result값이 달라지게 한다. 그결과 클래스에 비슷한 필드가 여러 개일 때 해시 효과를 크게 높여 준다.

곱해주는 숫자가 31인 이유는 31이 홀수 이고 소수이기 때문이다.

이 요령을 PhoneNumber에 적용해보자.

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

위의 코드는 PhoneNumber의 핵심필드 areaCode, prefix, lineNum 세가지를 통해 간단한 계산후 해시코드를 반환한다.

Objects 클래스는 임의의 개수만큼 객체를 받아 해시코드를 계산해주는 정적 메서드인 hash를 제공한다. 해당 메서드는 간단하지만 입력 인수를 담기 위한 배열이 만들어지고, 입력 중 기본타입이 있다면 박싱 언박싱을 거치기 때문에 속도는 더느려진다. 해당 코드는 성능에 민감하지 않을때 사용하면 좋다.

hash메서드는 아래와 같이 쓸 수 있다.

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

불변클래스에서 hashCode를 재정의하는 방법

클래스가 불변이고 해시코드를 계산하는 비용이 크다면, 매번 새로 계산하기 보다는 캐싱하는 방식을 고려해야 한다. 해당 타입의 객체가 주로 해시의 키로 사용될 것 같다면 인스턴스가 만들어질 때 해시코드를 계산해둬야 한다. 하지만 해시의 키로 사용되지 않는 경우라면 hashCode가 처음 불릴 때 계산하는 지연 초기화(lazy initialization) 전략을 사용 할 수 있다.

PhoneNumber객체를 이용해 해당 예시를 들어보자.

/* 자동으로 0으로 초기화 한다. */
@Override
private int hashCode() {
    int result = hashCode;
    if (result ==0) {
        int result = Short.hashCode(areaCode);
        result = 31 * result + Short.hashCode(prefix);
        result = 31 * result + Short.hashCode(lineNum);
        return result;
    }
}

hashCode를 재정의 할 시 주의할 점

먼저 성능을 높인답시고 해시코드를 계산할 때 핵심 필드를 생략해서는 안 된다. 해시코드를 생성하는 속도는 빨라질 수 있어도, 해시 품질이 나빠져 Hash를 사용하는 컬렉션 객체들(HashMap, HashTable)의 성늘을 심각하게 떨어 뜨릴수도 있다.

또, hashCode가 반환하는 값의 생성 규칙을 API 사용자에게 자세히 공표하지 말자. 그래야 클라이언트가 이 값에 의지하지 않게 되고, 추후에 계산 방식을 바꿀 수 있다. 즉 규칙을 알려주지 않아야 결합도를 낮출 수 있다. 실제 String과 Integer를 포함해, 많은 라이브러리들이 이미 반환값을 알려버려, 수정의 여지를 없애버렸다.

만약 해당 주의를 지킨다면 해시기능에서 결함을 발견하거나 더 나은 해시 방식을 알아낸 경우 다음 릴리즈에서 수정할 수 있게 된다.

Related posts