[이펙티브자바 3판] ITEM11. equals를 재정의하려거든 hashCode도 재정의하라

이번장의 핵심은...

equals()를 재정의할 때는 hashCode()도 반드시 재정의해야 한다

그렇지 않으면 프로그램이 제대로 동작하지 않을 것이다

재정의한 hashCode는 Object의 API 문서에 기술된 일반 규약을 따라야 하며,

서로 다른 인스턴스라면 되도록 해시코드도 서로 다르게 구현해야 한다

AutoValue 프레임워크를 사용하면 멋진 equals와 hashCode를 자동으로 만들어준다

---

equals()를 재정의했다면 hashCode도 재정의하자

만약 equals()를 재정의했는데, hashCode를 재정의하지 않았다면,

해당 클래스의 인스턴스를 HashMap이나 HashSet 같은 컬렉션의 원소로 사용할 때 문제를 일으킬 수 있다

 

Object 명세에서 발췌한 규약은 아래와 같다

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

(단, 애플리케이션을 다시 실행한다면 이 값이 달라져도 상관없다)

 

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

 

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

(단, 다른 객체에 대해서는 다른 값을 반환해야 해시 테이블의 성능이 좋아진다)

 

hashCode 재정의를 잘못했을 때, 2번째 규약이 크게 문제가 될 수 있다

논리적으로 같은 객체는 같은 haschCode를 반환해야 한다

equals()는 물리적으로 다른 두 객체를 논리적으로 같다고 할 수 있지만,

Object의 default hashCode 메서드는 이 둘이 전혀 다르다고 판단하여 서로 다른 값을 반환한다

예를 들면,

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

생성자에 같은 값을 주어 생성한 PhoneNumber는 서로 다르다고 판단한다

PhoneNumber 클래스는 hashCode를 재정의하지 않았기 때문에 논리적으로 같지만, 서로 다른 해쉬코드를 반환한다

(2번째 규약을 지키지 못했다)

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

 

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

// 최악의 hashCode 구현 - 사용 금지
@Override
public int hashCode() { return 42; }

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

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

그 결과 기존 해시테이블을 쓰면 평균 수행시간이 O(1)인데, 그 안에 연결 리스트를 다 돌아야하니 O(N)으로 느려진다

객체가 많아지면 도저히 쓸 수 없고, 해시테이블이 쓰는 의미조차 사라진다

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

이상적인 해시 함수는 서로 다른 인스턴스들을 32비트 정수 범위에 균일하게 분배해야 한다

 

좋은 HashCode를 작성하는 법

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

이때 c는 해당 객체의 첫번째 핵심 필드를 계산한다 - 방식은 2-1)번에서 설명한다

(핵심 필드란 equals 비교에 사용되는 필드)

 

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

 

2-1) 해당 필드의 해시코드 c를 계산한다

a) 기본 타입 필드라면, Type.hashCode(f)를 수행한다

여기서 Type은 해당 기본 타입의 박싱 클래스이다 

 

b) 참조 타입 필드면서 이 클래스의 equals 메서드가 이 필드의 equals를 재귀적으로 호출해 비교한다면, 이 필드의 hashCode를 재귀적으로 호출한다

계산이 복잡해질 것 같으면, 이 필드의 표준형을 만들어 그 표준형의 hashCode를 호출한다

필드의 값이 null이면 0을 사용한다

 

c) 필드가 배열이라면, 핵심 원소 각각을 별도 필드처럼 다룬다

이상의 규칙을 재귀적으로 적용해 각 핵심 원소의 해시코드를 계산한 다음 갱신한다

배열에 핵심 원소가 하나도 없다면 단순히 상수 0을 사용한다 

모든 원소가 핵심 원소라면 Arrays.hashCode를 사용한다

 

2-2) 위에서 계산한 해시코드 c로 result를 갱신한다 

result = 31 * result + C;

3. result를 반환한다

 

이제 같은 인스턴스는 같은 해시코드인가?

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

단위 테스틀 작성하자 (equals, hashCode 메서드를 AutoValue로 생성했다면 건너뛰어도 좋다)

 

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

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

또한, equals 비교에 사용되지 않는 필드는 반드시 제외한다

 

위 단계 2-2)에서 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 인스턴스들은 같은 해시코드를 가질 것이 확실하다

충분히 훌륭하지만, 해시 충돌이 더욱 적은 방법을 꼭 써야 한다면,

구아바의 com.google.common.hash.Hashing을 참고하자

 

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

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

단 한줄로 작성할 수 있지만, 속도가 더 느리다

그 이유는 입력 인수를 담기 위한 배열이 만들어지고, 입력 중 기본 타입이 있다면 박싱과 언박싱도 거친다

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

 

해시코드를 캐싱하는 방식

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

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

// 해시코드를 지연 초기화하는 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;
}

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

해시 품질이 나빠져 해시테이블 성능을 심각하게 떨어뜨릴 수도 있다

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

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