아이템 11. equals를 재정의하려거든 hashCode도 재정의하라. - ksw6169/effective-java GitHub Wiki

개요

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

hashCode() 를 재정의할 때 따라야 하는 일반 규약

• 다음은 Object 명세에서 발췌한 HashCode의 일반 규약이다.

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

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

3. equals(Object) 가 두 객체를 다르다고 판단했더라도 두 객체의 hashCode가 서로 다른 값을 반환할 필요는 없다.

hashCode를 재정의하지 않을 때 발생하는 상황

• Map에 p1을 넣고 논리적 동치인 p2를 통해 Map에서 p1을 꺼내려고 한다면 null 이 반환된다.
• 이유는 PhoneNumber 클래스에서 hashCode를 재정의하지 않아 논리적 동치인 두 객체가 서로 다른 해시코드를 반환하여 두 번째 규약을 지키지 못했기 때문이다.

PhoneNumber p1 = new PhoneNumber(707, 867, 5309);
PhoneNumber p2 = new PhoneNumber(707, 867, 5309);

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

// m.get()은 null을 반환한다.
assertEquals(p1, m.get(p2));

• 이 문제는 PhoneNumber에 적절한 hashCode 메소드를 작성해주면 해결된다.

예제 : hashCode를 잘못 재정의하여 항상 같은 값을 반환한다.

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

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

좋은 hashCode를 작성하는 간단한 요령

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

1. int 변수 result를 선언한 후 값 c로 초기화한다.

• 이 때 c는 해당 객체의 첫 번째 핵심 필드를 단계 2.A 방식으로 계산한 해시코드다.
• 여기서 핵심 필드란 equals 비교에 사용되는 필드를 말한다.

@Override
public int hashCode() {
    int result = Short.hashCode(areaCode);
    ...
}

2. 해당 객체의 나머지 필드 f 각각에 대해 다음 작업을 수행한다.

• A. 해당 필드의 해시코드 c를 계산한다.

(1) 기본 타입 필드라면, Type.hashCode(f) 를 수행한다. 
    여기서 Type은 해당 기본 타입의 박싱 클래스다.

(2) 참조 타입 필드면서 이 클래스의 equals 메소드가 이 필드의 equals를 재귀적으로 호출해 비교한다면 
    이 필드의 hashCode를 재귀적으로 호출한다. 계산이 복잡해질 것 같으면 이 필드의 
    표준형(canonical representation)을 만들어 그 표준형의 hashCode를 호출한다.
    필드의 값이 null이면 0을 사용한다. (전통적인 관례)

(3) 필드가 배열이라면 핵심 원소 각각을 별도 필드처럼 다룬다. 
    위의 규칙을 재귀적으로 적용해 각 핵심 원소의 해시코드를 계산한 다음 단계 2.b 방식으로 갱신한다.
    배열에 핵심 원소가 하나도 없다면 단순히 상수(0을 추천한다.)를 사용한다. 
    모든 원소가 핵심 원소라면 Arrays.hashCode를 사용한다. 

• B. 단계 2.a에서 계산한 해시코드 c로 result를 갱신한다.

result = 31 * result + c;

3. result를 반환한다.

해시코드를 계산할 때 31을 곱하는 이유

• 31 * result를 수행하면 필드를 곱하는 순서에 따라 result 값이 달라진다. (이를 통해 해시 효과를 크게 높일 수 있다. 예를 들어 String의 hashCode를 곱셈 없이 구현한다면 모든 아나그램의 해시코드가 같아진다.)
• 31을 곱한 이유는 31이 홀수이면서 소수(prime)이기 때문이다. 만약 이 숫자가 짝수이고 오버플로우가 발생한다면 정보를 잃게 된다. 2를 곱하는 것은 시프트 연산과 같은 결과를 내기 때문이다. 소수를 곱하는 이유는 명확하지 않지만 전통적으로 그리 해왔다. 결과적으로 31을 이용하면 이 곱셈을 시프트 연산과 뺄셈으로 대체해 최적화할 수 있다. (31 * i는 (i << 5) - i와 같다.) 요즘 VM들은 이런 최적화를 자동으로 해준다.
• (관련 이슈 : https://github.com/team-tancheon/book-lounge/issues/31)

hashCode를 재정의할 때 주의할 사항

• hashCode를 다 구현했다면 동치인 인스턴스에 대해 똑같은 해시코드를 반환하는지 확인하자.
• 파생 필드(다른 필드로부터 계산해낼 수 있는 필드)는 해시코드 계산에서 모두 무시해도 된다.
• equals 비교에 사용되지 않는 필드는 반드시 제외해야 한다. (2번째 규약)

예제 : 전형적인 hashCode 메소드

• 다음 메소드는 PhoneNumber 인스턴스의 핵심 필드 3개만을 사용해 간단한 계산을 수행한다.

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

불변 클래스의 해시코드 계산 비용이 클 때는 캐싱을 사용하자.

• 클래스가 불변이고 해시코드를 계산하는 비용이 크다면 캐싱하는 방식을 고려해야 한다.
• 이 타입의 객체가 주로 해시의 키로 사용될 것 같다면 인스턴스가 만들어질 때 해시코드를 계산해둬야 한다.
• 반대로 해시의 키로 사용되지 않는 경우라면 hashCode가 처음 불릴 때 계산하는 지연 초기화 전략을 적용하는 것도 좋다. 필드를 지연 초기화하려면 그 클래스를 Thread-safe 하게 만들도록 신경써야 한다.

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

hashCode를 재정의할 때 주의사항

1. 해시 충돌이 더욱 적은 방법을 꼭 써야 한다면 Guava의 Hashing을 참고하자.

2. 성능에 민감하지 않다면 Objects.hash를 사용하는 것을 고려하라.

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

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

3. 해시코드를 계산할 때 핵심 필드를 생략하지 마라.

• 성능을 높인답시고 해시코드를 계산할 때 핵심 필드를 생략해서는 안된다. 속도야 빨라지겠지만 해시 품질이 나빠져 해시테이블의 성능을 심각하게 떨어뜨릴 수도 있다. 특히 어떤 필드는 특정 영역에 몰린 인스턴스들의 해시코드를 넓은 범위로 고르게 퍼트려주는 효과가 있을지도 모른다. 하필 이런 필드를 생략한다면 해당 영역의 수많은 인스턴스가 단 몇 개의 해시코드로 집중되어 해시테이블의 속도가 선형으로 느려질 것이다.
• 예컨대 Java 2 전의 String은 최대 16개의 문자만으로 해시코드를 계산했다. 문자열이 길면 균일하게 나눠 16문자만 뽑아내 사용한 것이다. URL처럼 계층적인 이름을 대량으로 사용한다면 이런 해시 함수는 앞서 이야기한 심각한 문제를 고스란히 드러낸다.

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

• 그래야 클라이언트가 이 값에 의지하지 않게 되고, 추후에 계산 방식을 바꿀 수도 있다. String과 Integer를 포함한 자바 라이브러리의 많은 클래스에서 hashCode가 반환하는 정확한 값을 알려주어 향후 릴리스에서 해시 기능을 개선할 여지도 없애버렸다.
• 자세한 규칙을 공표하지 않는다면, 해시 기능에서 결함을 발견했거나 더 나은 해시 방식을 알아낸 경우 다음 릴리즈에서 수정할 수 있다.

참고 자료

• Effective Java 3/E
• Java HashMap은 어떻게 동작하는가?ㅣNaver D2
• 해싱, 해시함수, 해시테이블ㅣratsgo's blog