equals를 재정의하려거든 hashCode도 재정의하라(2) - [3장. 모든 객체의 공통 메서드(아이템11)]

  앞에서 살펴본 것처럼 좋은 해시 함수라면 서로 다른 인스턴스에 다른 해시 코드를 반환한다. 이상적인 해시 함수는 주어진 (서로 다른) 인스턴스들을 32비트 정수 범위에 균일하게 분배해야 한다. 이상을 완벽하게 실현하기는 어렵지만 비슷하게 만들기는 그다지 어렵지 않다. 해당 글을 통해 해시 코드를 구현하는 4가지 방법과 주의 사항을 알아보자.

 

1. 전형적인 hashCode 구현 🥑

1. 핵심 필드 중에 하나를 골라서 hashCode를 구한다.
     기본 타입(primitive type) 필드라면 해당 타입의 hashCode라는 메서드를 사용해서 구하면 된다. (Type.hashCode(f))
     참조 타입(reference tyep) 필드라면 해당 타입의 hashCode를 호출해서 구한다. (Point라는 타입을 사용한다면 point.hashCode()를 사용한다.)
2. 이전의 값에 31을 곱하고 다음 필드의 해시 코드 값을 더해준다.
3. 2번의 방법을 모든 필드에 적용한다.

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 aptjem
    @Override public int hashCode() {
        int result = Short.hashCode(areaCode); // 1
        result = 31 * result + Short.hashCode(prefix); // 2
        result = 31 * result + Short.hashCode(lineNum); // 3
        return result;
    }
    
}

 

곱하는 숫자가 31인 이유

1. 홀수를 써야 함
   짝수를 사용하면 뒤에 0이 채워지면서 숫자가 날아갈 수 있다. 
2. 해시 충돌 방지
   31이라는 숫자를 사용했을 때 해시 충돌이 가장 적었다고 한다. 

 

2. 자동 생성 🥝

  IntelliJ가 자동으로 만들어주는 hashCode()를 사용하면 아래와 같이 구현해 준다.

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

 

3. 구아바 (Guava) 🍏

  해시 충돌이 더욱 적은 방법을 꼭 써야 한다면 구아바의 com.google.common.hash.Hashing을 참고하자. 

@Override int hashCode() {
    return Hashing.goodFastHash(32)
            .hashObject(this, PhoneNumberFunnel.INSTANCE)
            .hashCode();
}

private static class PhoneNumberFunnel implements Funnel<PhoneNumber> {
    private static final PhoneNumberFunnel INSTANCE = new PhoneNumberFunnel();
    
    @Override
    public void funnel(PhoneNumber from, PrimitiveSink into) {
        into.putShort(from.areaCode).putShort(from.prefix).putShort(from.lineNum);
    }
}

 

 

4. 캐싱하는 방식 🍐

  클래스가 불변이고 해시 코드를 계산하는 비용이 크다면, 매번 새로 계산하기보다는 캐싱하는 방식을 고려해야 한다. 이 방식은 해시 코드를 지연 초기화 하는 것이다. 필드를 지연 초기화하려면 그 클래스를 스레드가 안전하게 만들도록 신경 써야 한다. 

private int hashCode; // 자동으로 0으로 초기화한다.

@Override public 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);
        hashCode = result;
    }
    return result;
}

 

 

주의 사항 🚩

1. 핵심 필드를 생략해서는 안 된다.
     성능을 높인답시고 해시코드를 계산할 때 핵심 필드를 생략해서는 안 된다. 속도야 빨라지겠지만, 해시 품질이 나빠져 해시테이블의 성능을 심각하게 떨어뜨릴 수도 있다.
2. 외부에 노출할 필요가 없다.
     hashCode가 반환하는 값의 생성 규칙을 API 사용자에게 자세히 공표하지 말자. 그래야 클라이언트가 이 값에 의지하지 않게 되고, 추후에 계산 방식을 바꿀 수도 있다.

 

해당 글은 백기선 님의 '이펙티브 자바 완벽 공략'을 수강하고 작성한 것입니다.