아이템[11]. equals를 재정의하려거든 hashCode도 재정의하라

equals를 재정의한 클래스 모두에서 hashCode도 재정의해야 합니다.

그렇지 않으면 hashCode 일반 규약을 어기게 되어 해당 클래스의 인스턴스를 HashMap이나 HashSet 같은 컬렉션의 원소로 사용할 때 문제를 일으킬 것입니다.

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

• equals 비교에 사용되는 정보가 변경되지 않았다면, 애플리케이션이 실행되는 동안 그 객체의 hashCode 메서드는 몇 번을 호출해도 일관되게 항상 같은 값을 반환해야 한다. 단, 애플리케이션을 다시 실행한다면 이 값이 달라져도 상관없다.
• equals(Object)가 두 객체를 같다고 판단했다면, 두 객체의 hashCode는 똑같은 값을 반환해야 한다.
• equals(Object)가 두 객체를 다르다고 판단했더라도, 두 객체의 hashCode가 서로 다른 값을 반환할 필요는 없다. 단, 다른 객체에 대해서는 다른 값을 반환해야 해시테이블의 성능이 좋아진다.

hashCode 재정의를 잘못했을 때 크게 문제가 되는 조항은 두 번째입니다.

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

아이템 10에서 보았듯이 equals는 물리적으로 다른 두 객체를 논리적으로는 같다고 할 수 있습니다.

하지만 Object의 기본 hashCode 메서드는 이 둘이 전혀 다르다고 판단하여, 규약과 달리 (무작위처럼 보이는) 서로 다른 값을 반환합니다.

예를 들어 아이템 10의 PhoneNumber 클래스의 인스턴스를 HashMap의 원소로 사용한다고 해봅시다.

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

🤔
이 코드 다음에 m.get(new PhoneNumber(707, 867, 5309)를 실행하면 "제니"가 나올까?

실제로는 null을 반환합니다.

여기에는 2개의 PhoneNumber 인스턴스가 사용되었습니다.

하나는 HashMap에 "제니"를 넣을 때 사용됐고, (논리적 동치인) 두 번째는 이를 꺼내려할 때 사용됐습니다.

PhoneNumber 클래스는 hashCode를 재정의하지 않았기 때문에 논리적 동치인 두 객체가 서로 다른 해시코드를 반환하여 두 번째 규약을 지키지 못합니다.

그 결과 get 메서드는 엉뚱한 해시 버킷에 가서 객체를 찾으려 한 것이죠.

설사 두 인스턴스를 같은 버킷에 담았더라도 get 메서드는 여전히 null을 반환하는데, HashMap은 해시코드가 다른 엔트리끼리는 동치성 비교를 시도조차 하지 않도록 최적화되어 있기 때문입니다.

이 문제는 PhoneNumber에 적절한 hashCode 메서드만 작성해주면 해결됩니다.

올바른 hashCode 메서드는 어떤 모습이어야 할까요?

안 좋게 작성하려면 아주 간단합니다.

예를 들어 다음 코드는 적법하게 구현했지만, 절대 사용해서는 안 됩니다.

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

이 코드는 동치인 모든 객체에서 똑같은 해시코드를 반환하니 적법합니다.

하지만 끔찍하게도 모든 객체에게 똑같은 값만 내어주므로 모든 객체가 해시테이블의 버킷 하나에 담겨 마치 연결 리스트처럼 동작합니다.

그 결과 평균 수행 시간이 O(1)인 해시테이블이 O(n)으로 느려져서, 객체가 많아지면 도저히 쓸 수 없게 됩니다.

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

이것이 바로 hashCode의 세 번째 규약이 요구하는 속성입니다.

이상적인 해시 함수는 주어진 (서로 다른) 인스턴스들을 32비트 정수 범위에 균일하게 분배해야 합니다.

이상을 완벽히 실현하기는 어렵지만 비슷하게 만들기는 그다지 어렵지 않습니다.

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

[1]. int 변수 result를 선언한 후 c로 초기화합니다. 이 때 c는 해당 객체의 첫 번째 핵심 필드를 단계 2.a 방식으로 계산한 해시코드다. (여기서 핵심 필드란 equals 비교에 사용되는 필드를 말한다. 아이템 10 참조)

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

1. 해당 필드의 해시코드 c를 계산한다.
   1. 기본 타입 필드라면, Type.hashCode(f)를 수행한다. 여기서 Type은 해당 기본 타입의 박싱 클래스다.
   2. 참조 타입 필드면서 이 클래스의 equals 메서드가 이 필드의 equals를 재귀적으로 호출해 비교한다면, 이 필드의 hashCode를 재귀적으로 호출한다. 계산이 더 복잡해질 것 같으면, 이 필드의 표준형을 만들어 그 표준형의 hashCode를 호출한다. 필드의 값이 null이면 0을 사용한다. (다른 상수도 괜찮지만 전통적으로 0을 사용한다.)
   3. 필드가 배열이라면, 핵심 원소 각각을 별도 필드처럼 다룬다. 이상의 규칙을 재귀적으로 적용해 각 핵심 원소의 해시코드를 계산한 다음, 단계 2.b 방식으로 갱신한다. 배열에 핵심 원소가 하나도 없다면 단순히 상수(0)을 사용한다. 모든 원소가 핵심 원소라면 Arrays.hashCode를 사용한다.
2. 단계 2.a에서 계산한 해시코드 c로 result를 갱신한다. 코드로는 다음과 같다. result = 31 * result + c;

[3]. result를 반환한다.

hashCode를 다 구현했다면 이 메서드가 동치인 인스턴스에 대해 똑같은 해시코드를 반환할지 자문해봅시다.

그리고 여러분의 직관을 검증할 단위 테스트를 작성합시다.

동치인 인스턴스가 서로 다른 해시코드를 반환한다면 원인을 찾아 해결합시다.

파생 필드는 해시코드 계산에서 제외해도 됩니다.

즉, 다른 필드로부터 계산해낼 수 있는 필드는 모두 무시해도 됩니다.

또한 equals 비교에 사용되지 않은 필드는 '반드시' 제외해야 합니다.

그렇지 않으면 hashCode 규약 두 번째를 어기게 될 위험이 있습니다.

단계 2.b의 곱셈 31 * result는 필드를 곱하는 순서에 따라 result 값이 달라지게 합니다.

그 결과 클래스에 비슷한 필드가 여러 개일 때 해시 효과를 크게 높여줍니다.

예컨대 String의 hashCode를 곱셈 없이 구현한다면 모든 아나그램의 해시코드가 같아집니다.

곱할 숫자를 31로 정한 이유는 31이 홀수이면서 소수이기 때문입니다.

만약 이 숫자가 짝수이고 오버플로가 발생한다면 정보를 잃게 됩니다.

2를 곱하는 것은 시프트 연산과 같은 결과를 내기 때문입니다.

소수를 곱하는 이유는 명확하지 않지만 전통적으로 그리 해왔다고 합니다.

결과적으로 31을 이용하면, 이 곱셈을 시프트 연산과 뺄셈으로 대체해 최적화할 수 있습니다.

(31 * i는 (i << 5) - i 와 같습니다.)

요즘 VM들은 이런 최적화를 자동으로 해줍니다.

이 요령을 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 인스턴스의 핵심 필드 3개만을 사용해 간단한 계산만 수행합니다.

그 과정에 비결정적 요소는 전혀 없으므로 동치인 PhoneNumber 인스턴스들은 같은 해시코드를 가질 것이 확실합니다.

사실 위 코드는 PhoneNumber에 딱 맞게 구현한 hashCode입니다.

자바 플랫폼 라이브러리의 클래스들이 제공하는 hashCode 메서드와 비교해도 손색이 없습니다.

단순하고, 충분히 빠르고, 서로 다른 전화번호들은 다른 해시 버킷들로 제법 훌륭히 분배해줍니다.

이번 아이템에서 소개한 해시 함수 제작 요령은 최첨단은 아니지만 충분히 훌륭합니다.

품질 면에서나 해싱 기능 면에서나 자바 플랫폼 라이브러리가 사용한 방식과 견줄만하며 대부분의 쓰임에도 문제가 없습니다.

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

Objects 클래스의 hash 정적 메서드

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

이 메서드를 활용하면 앞서의 요령대로 구현한 코드와 빗스한 수준의 hashCode 함수를 단 한 줄로 작성할 수 있습니다.

하지만 아쉽게도 속도는 더 느립니다.

입력 인수를 담기 위한 배열이 만들어지고, 입력 중 기본 타입이 있다면 박싱과 언방식도 거쳐야 하기 때문입니다.

그러니 hash 메서드는 성능에 민감하지 않은 상황에서만 사용합시다.

다음 코드는 PhoneNumber의 hashCode를 이 방식으로 구현한 예입니다.

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

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

이 타입의 객체가 주로 해시의 키로 사용될 것 같다면 인스턴스가 만들어질 때 해시코드를 계산해둬야 합니다.

🤔
해시의 키로 사용되지 않는 경우라면 hashCode가 처음 불릴 때 계산하는 지연 초기화 전략을 어떨까?

필드를 지연 초기화하려면 그 클래스를 스레드 안전하게 만들도록 신경 써야 합니다.(아이템 83)

PhoneNumber 클래스는 굳이 이렇게까지 할 이유는 없지만, 예시를 위해 한번 해봅시다.

한 가지, hashCode 필드의 초깃값은 흔히 생성되는 객체의 해시코드와는 달라야 함에 주의합시다.

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

성능을 높인답시고 해시코드를 계산할 때 핵심 필드를 생략하면 안 됩니다.

속도야 빨라지겠지만, 해시 품질이 나빠져 해시테이블의 성능을 심각하게 떨어뜨릴 수도 있습니다.

특히 어떤 필드는 특정 영역에 몰린 인스턴스들의 해시코드를 넓은 범위로 고르게 퍼트려주는 효과가 있을지도 모릅니다.

하필 이런 필드를 생략한다면 해당 영역의 수많은 인스턴스가 단 몇 개의 해시코드로 집중되어 해시테이블의 속도가 선형으로 느려질 것입니다.

이 문제는 단지 이론에 그치지 않습니다.

실제로 자바 2 전의 String은 최대 16개의 문자만으로 해시코드를 계산했습니다.

문자열이 길면 균일하게 나눠 16문자만 뽑아내 사용한 것입니다.

URL처럼 계층적인 이름을 대량으로 사용한다면 이런 해시 함수는 앞서 이야기한 심각한 문제를 고스란히 드러냅니다.

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

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

String과 Integer를 포함해, 자바 라이브러리의 많은 클래스에서 hashCode 메서드가 반환하는 정확한 값을 알려줍니다.

바람직하지 않은 실수지만 바로잡기에는 이미 늦었습니다.

향후 릴리스에서 해시 기능을 개선할 여지도 없애버렸습니다.

자세한 규칙을 공표하지 않는다면, 해시 기능에서 결함을 발견하거나 더 나은 해시 방식을 알아낸 경우 다음 릴리스에서 수정할 수 있습니다.

정리

• equals를 재정의할 때는 hashCode도 반드시 재정의해야 한다.
• 그렇지 않으면 프로그램이 제대로 동작하지 않을 것이다.
• 재정의한 hashCode는 Object의 API 문서에 기술된 일반 규약을 따라야 하며, 서로 다른 인스턴스라면 되도록 해시코드도 서로 다르게 구현해야 한다.
• 이렇게 구현하기가 어렵지는 않지만 조금 따분한 일이긴 하다.
• 하지만 걱정말라. 아이템 10에서 이야기한 AutoValue 프레임워크를 사용하면 멋진 equals와 hashCode를 자동으로 만들어준다.
• IDE들도 이런 기능을 일부 제공한다.