[Effective-Java] Item 11. equals를 재정의하려거든 hashcode도 재정의하라

equals를 재정의한 클래스 모두에서 hashCode도 재정의해야 한다. 그렇지 않으면 hashCode 일반 규약을 어기게 되어 해당 클래스의 인스턴스를 HashMap, HashSet 같은 컬렉션의 원소를 사용할 때 문제가 생긴다.

 

 

Object에서 발췌한 hashCode() 명세 규약

---

1. equals 비교에 사용되는 정보가 변경되지 않았다면 항상 같은 값을 반환해야 한다.
2. equals(Object)가 두 객체를 같다고 판단했으면, 두 객체의 hashCode는 똑같은 값을 반환해야 한다.
3. equals(Object)가 두 객체를 다르다고 판단했더라도, 두 객체의 hashCode가 서로 다른 값을 반환할 필요는 없다. 하지만 다른 값을 반환해야 성능이 유리하다

 

아래와 같은 클래스가 있다고 했을 때,

 

public final class PhoneNumberA {
    private final short areaCode, prefix, lineNum;
    public PhoneNumberA(int areaCode, int prefix, int lineNum) {
        this.areaCode = rangeCheck(areaCode, 999, "area code");
        this.prefix   = rangeCheck(prefix,   999, "prefix");
        this.lineNum  = rangeCheck(lineNum, 9999, "line num");
    }
    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 PhoneNumberA))
            return false;
        PhoneNumberA pn = (PhoneNumberA)o;
        return pn.lineNum == lineNum && pn.prefix == prefix
                && pn.areaCode == areaCode;
    }
    public static void main(String[] args) {
        Map<PhoneNumberA, String> m = new HashMap<>();
        PhoneNumberA a = new PhoneNumberA(1, 1, 2);
        PhoneNumberA b = new PhoneNumberA(1, 1, 2);
        m.put(a,"b");
        m.put(b,"c");
        m.forEach((m1, m2)->{
            System.out.println("m1 = " + m1);
            System.out.println("m2 = " + m2);
        });
        System.out.println(m.get(new PhoneNumberA(1,1,2)));
        System.out.println("a.equals(b) = " + a.equals(b));
        System.out.println("a.hashCode() == b.hashCode() = " + (a.hashCode() == b.hashCode()));
    }
}

 

HashMap은 키 값이 중복이 되지 않는다. @HashCode를 재정의 하지 않았다면,

기존 Object.hashCode()를 사용하기 때문에 m.put()을 할 때,

새로운 phoneNumberA 인스턴스를 넣음으로 다른 인스턴스로 취급이돼서 forEach에서 실제 2개의 Entry가 있음을 알 수 있다.

그리고 get을 할 때도 새로운 인스턴스를 넣었음으로 찾을 수 없기에 null이 나온다.

 

// HashMap의 put 과정
public V put(K key, V value) {
	return putVal(hash(key), key, value, false, true);
}
 // HashMap의 get 과정
 public V get(Object key) {
 	Node<K,V> e;
 	return (e = getNode(hash(key), key)) == null ? null : e.value;
 }
  // HashMap의 정적 메소드
 static final int hash(Object key) {
 	int h;
 	return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
 }

 

저장하는 방법과 찾는 방법이 어떻게 됐든, 둘 다 키를 비교하면서 hash(key) 메소드를 이용함을 알 수 있다.

이 메소드에서는 파라미터로 들어온 key의 인스턴스로 hashCode를 호출함을 알 수 있다.

그리고 put 내부의 putVal 메소드나, get 내부의 getNode 메소드를 확인하면 key.equals()를 통해서 값을 확인한다.

즉, hashCode()가 잘못 정의되어 있다면, 엔트리의 동치성을 비교할 기회조차 없게 최적화 되어있다.

 

명세규약 2번째에 따라 equals(Object)가 두 객체를 같다고 판단했으면, 두 객체의 hashCode는 똑같은 값을 반환해야 한다.

하지만 a와 b를 equals 했을때는 true가 나오고 a와 b의 hashCode를 비교하면 false가 나온다.

PhoneNumberA 클래스는 hashCode를 재정의하지 않아 논리적 동치인 두 객체가 서로 다른 해시코드를 반환하는 것이다.

따라서 HashCode를 잘못 사용하면 문제가 발생할 수 있음을 알 수 있다. 사용자가 제대로 정의했다는 가정하에 액션이 행해지니까.

 

 

그렇다고 hashCode의 반환값을 모두 동일하게 한다면?

 

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

 

동치인 모든 객체에서 똑같은 해시코드를 반환하니 적법해 보이지만, 모든 객체에게 똑같은 값만 내어주니 모든 객체가 해시테이블의 버킷 하나에 담겨 마치 연결 리스트(linkedList)처럼 동작한다. 수행시간은 O(n)이 될거고, hash를 쓸 이유가 없다.

 

 

좋은 hashCode

---

좋은 해시 함수라면 서로 다른 인스턴스에 다른 해시코드를 반환한다. hashCode()의 세 번째 규약이 요구하는 속성이다. 이상적인 해시 함수들은 주어진 인스턴스들을 32비트 정수 범위에 균일하게 분배해야한다. 완벽한 이상 구현은 힘들지만 비슷하게 만드는 방법이 있다.

 

• 1. int 변수 result를 선언한 후 값 c로 초기화 한다. 이때 c는 해당 객체의 첫 번째 핵심 필드를 단계 2.a 방식으로 계산한 해시코드다(핵심필드: Equals 비교에 사용되는 필드)
• 2. 해당 객체의 나머지 핵심 필드 f 각각에 대해 다음 작업을 수행한다.
  • a. 해당 필드의 해시 코드 c를 계산한다.
    • i. 기본 타입 필드: Type.hashCode(f)
    • ii. 참조 타입 필드 + equals()의 재귀적 호출: 이 필드의 hashCode도 재귀적 호출 / 이 필드의 표준형을 만들어 그 표준형의 hashCode 호출 / null이라면 단순 상수 
    • iii. 배열 필드: 핵심 원소 각각을 별도 필드처럼 다뤄 해시코드를 계산한 후 2.b 방식으로 갱신 / 배열이 비었다면 단순 상수 / 모든 원소가 핵심 원소라면 Arrays.hashCode()
  • b. 단계 2.a에서 계산한 해시코드 c로 result 갱신 ex) result = 31 * result + c;
• 3. result 반환

파생 필드는 계산에서 제외해도 되고, 다른 필드로부터 계산해낼 수 있는 필드는 모두 무시해도 된다.

하지만 equals 비교에 사용되지 않는 필드는 반드시 제외해야한다. 그렇지 않으면 hashCode 두번째 규약을 위반할 위험이 있다.

 

그리고 2.b의 31 * result는 비슷한 클래스가 여러 개일 때 해시 효과를 크게 높여준다.

곱할 숫자를 31로 정한 이유는

1. 31이 홀수면서 소수이기 때문이다. 짝수고 오버플로가 발생하면 정보를 잃게 된다
2. 소수를 곱하는 것은 전통적이다?
3. 시프트 연산과 뺼셈으로 최적화 가능하다( 31* i == (i<<5) - i )

근데 오버플로는 뺄셈하기 전에 쉬프트 과정에서 이미 발생할텐데 어떤 의미가 있는지 싶다.

 

위의 단계들을 PhoneNumberA 클래스에 적용한다면 아래와 같다.

 

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

 

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

 

 

Objects 클래스의 hash

---

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

위 코드와 비슷한 수준의 hashCode 함수를 한 줄로 작성할 수 있지만, 아쉽게도 속도는 더 느리다.

입력 인수를 담기 위한 배열이 만들어지고, 입력 인수에 기본 타입이 있다면 박싱과 언박싱도 거치기 때문이다.

성능에 민감하지 않은 상황에서만 사용하자

 

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

 

 

 

캐싱 방식

---

클래스가 불변이고 해시코드를 계산하는 비용이 크다면, 매번 새로 계산하기 보다 캐싱 방식을 고려해야한다.

 

• 주로 해시의 키로 사용될 것 같다면: 인스턴스가 만들어질 때 해시코드를 계산해두기
• 해시의 키로 사용되지 않는 경우라면: hashCode가 처음 불릴 때 계산하는 지연 초기화(Lazy Initialization) 전략

 

아래는 지연 초기화 전략이다.

하지만 여기서 스레드 안전하게 만들려면 수정이 필요하다.

 

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

 

 

주의

---

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

속도야 빨라지겠지만 해시 품질이 나빠져 해시테이블 성능이 떨어질 수 있다.  특히나 생략한 필드가 해시코드를 넓고 고르게 퍼트려 주고 있었다면 해시테이블의 속도가 선형으로 느려질 것이다. 실제 자바 2 전의 String은 최대 16개의 문자만으로 해시코드를 계산했다.

문자열이 길면 균일하게 나눠 첫 문자를 포함해 16문자만 뽑아내 사용한 것이다. URL처럼 계층적인 이름을 대량으로 사용한다면 

이런 해시 함수는 심각한 문제를 고스란히 드러낸다.

 

2. hashCode가 반환하는 값의 생성 규칙을 API 사용자에게 자세히 공표하지 말자.

그래야 클라이언트가 이 값에 의지하지 않게 되고, 추후에 계산 방식을 바꿀 수도 있다.

 

 

 

정리

---

equals를 재정의할 떄는 hashCode도 반드시 재정의하자. Object의 API 문서에 기술된 일반 규약을 따르고

서로 다른 인스턴스는 되도록 해시코드도 서로 다르게 구현하자. 이 또한 귀찮으면 AutoValue 프레임워크를 사용하면 된다.

 

 

 

 

* 위 글은 EffectiveJava 3/E 책 내용을 정리한 글로, 저작권 관련 문제가 있다면 댓글로 남겨주시면 즉각 삭제조치 하겠습니다.