모든 객체의 공통 메서드 - 아이템 11. equals를 재정의하려거든 hashCode도 재정의하라

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

equals() 메서드를 재정의한 클래스는 hashCode() 메서드고 재정의해야 한다. 그렇지 않으면, hashCode 일반 규약을 어기게 되어 해당 클래스의 인스턴스를 HashMap이나 HashSet 같은 컬렉션의 원소로 사용할 때 문제를 일으킬 것이다.

 

hashCode 일반 규약

Object 명세에서 발췌한 내용에 따르면 hashCode의 규약은 아래와 같다.

 

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

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

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

 

논리적으로 같은 객체는 같은 해시 코드를 반환해야 한다.

equals() 메서드는 물리적으로 다른 두 객체를 논리적으로 같다고 할 수 있다. 하지만 Object의 기본 hashCode() 메서드는 이 둘이 전혀 다르다고 판단하여, 규약과 달리 서로 다른 값을 반환한다.

 

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

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

    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.lineNum == lineNum;
    }
}

위와 같은 PhoneNumber 클래스를 정의한다.

 

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

        System.out.println(map.get(new PhoneNumber(707, 867, 5309)));   // null 출력
    }
}

위에서 정의한 PhoneNumber 클래스의 인스턴스를 HashMap의 원소로 사용한다고 해보자. 위 코드에서 map.get(new PhoneNumber(707, 867, 5309))를 실행하면 "리치"가 아닌 null을 반환한다.

PhoneNumber 클래스는 hashCode() 메서드를 재정의하지 않았기 때문에, 논리적 동치인 두 객체가 서로 다른 해시 코드를 반환해서 get() 메서드는 엉뚱한 해시 버킷에 가서 객체를 찾으려 한 것이다.

HashMap은 해시 코드가 서로 다른 엔트리끼리는 동치성 비교를 시도조차 않도록 최적화되어있다.

 

동치인 모든 객체에서 똑같은 hashCode를 반환하는 코드

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

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

 

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

좋은 hashCode를 작성하는 요령

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

 

주의할 점

1. equals 비교에 사용되는 필드에 대해서만 해시 코드를 계산한다.

2. 성능을 높인답시고 해시 코드를 계산할 때 핵심 필드를 생략해서는 안 된다.

3. 만약 해시로 바꾸려는 필드가 기본 타입이 아니라면, 해당 필드의 hashCode()  메서드를 불러 구현한다. 계산이 복잡한 경우는 표준형을 만들어 구현한다.

4. 참조 타입 필드가 null일 경우 0을 사용한다.

5. 31을 곱하는 이유는 비슷한 필드가 여러 개일 때, 해시 효과를 크게 높여주기 위해서이다. 비슷한 값들이 여러 개 있을 때, 그냥 더하면 같은 값이 나올 확률이 높다. 따라서, 31을 곱해 큰 수로 만들어 해시 효과를 증가시킨다.

 

전형적인 hashCode() 메서드

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

위 hashCode() 메서드는 PhoneNumber 인스턴스의 핵심 필드 3개 만을 사용해 간단한 계산만 수행한다. 그 과정에 비결정적 요소는 전혀 없으므로 동치인 PhoneNumber 인스턴스들은 같은 해시 코드를 가질 것이 확실하다.

 

잘못된 hashCode() 메서드

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

Objects 클래스는 임의의 개수만큼 객체를 받아 해시 코드를 계산해주는 정적 메서드를 제공한다. 이 메서드를 활용하면 앞서의 요령대로 구현한 코드와 비슷한 수준의 hashCode() 메서드를 단 한 줄로 작성할 수 있다. 하지만 아쉽게도 속도는 더 느리다. 입력 인수를 담기 위한 배열이 만들어지고, 입력 중 기본 타입이 있다면 박싱과 언박싱도 거쳐야 하기 때문이다. 따라서, Objects의 hashCode() 메서드는 성능에 민감하지 않은 상황에서만 사용하자.

 

hashCode의 캐싱과 지연 초기화

클래스가 불변이고 해시 코드를 계산하는 비용이 크다면, 매번 새로 계산하기보다는 캐싱하는 방식을 고려해야 한다. 이 타입의 객체가 주로 해시의 키로 사용될 것 같다면 인스턴스가 만들어질 때 해시 코드를 계산해 두어야 한다.

해시의 키로 사용되지 않는 경우라면 hashCode() 메서드가 처음 불릴 때 계산하는 지연 초기화 전략을 사용하는 것이 좋다. 또한, 필드를 지연 초기화하려면 그 클래스를 스레드 안전하게 만들도록 신경 써야 한다.

 

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

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

동시에 여러 스레드가 hashCode() 메서드를 호출하면 여러 스레드가 동시에 계산하여 우리의 처음 의도와는 다르게 여러 번 계산하는 상황이 발생할 수 있다. 그래서 지연 초기화를 하려면 동기화를 신경 써주는 것이 좋다.

 

최종 정리

equals() 메서드를 재정의할 때는 hashCode() 메서드도 반드시 재정의해야 한다. 재정의한 hashCode() 메서드는 Object의 API 문서에 기술된 일반 규약을 따라야 하며, 서로 다른 인스턴스라면 되도록 해시 코드도 서로 다르게 구현해야 한다. 

---

출처

ㆍ 이펙티브 자바 Effective Java 3/E. 조슈아 블로크 저자(글) · 개앞맵시(이복연) 번역

ㆍ https://github.com/2021BookChallenge/Effective-Java/blob/main/03%EC%9E%A5/item11.md