Effective Java - Item 11
April 12, 2022
equals를 재정의하려거든 hashCode도 재정의하라
equals를 재정의한 클래스 모두에서 hashCode도 재정의해야한다. 그렇지 않으면 hashCode 일반 규약을 어기게 되어 해당 클래스의 인스턴스를 HashMap이나 HashSet 같은 컬렉션의 원소로 사용될 때 문제를 일으킬 것이다.
hashCode 일반 규약
- equals 비교에 사용되는 정보가 변경되지 않았다면, 애플리케이션이 실행되는 동안 그 객체의 hashCode 메서드는 몇 번을 호출해도 일관되게 항상 같은 값을 반환해야 한다. 단, 애플리케이션을 다시 실행한다면 이 값이 달라져도 상관없다.
- equals(Object)가 두 객체를 같다고 판단했다면, 두 객체의 hashCode는 똑같은 값을 반환해야 한다.
- equals(Object)가 두 객체를 다르다고 판단했더라도, 두 객체의 hashCode가 서로 다른 값을 반환할 필요는 없다. 단, 다른 객체에 대해서는 다른 값을 반환해야 해시테이블의 성능이 좋아진다.
hashCode 재정의를 잘못했을 때 크게 문제가 되는 조항은 두 번째다. 즉, 논리적으로 같은 객체는 같은 해시코드를 반환해야 한다.
최악의 (하지만 적법한) hashCode 구현 - 사용 금지
@Override
public int hashCode() {
return 42;
}동치인 모든 객체에서 똑같은 해시코드를 반환하니 적법하다. 하지만 끔찍하게도 모든 객체에게 똑같은 값만 내어주므로 모든 객체가 해시테이블의 버킷 하나에 담겨 마치 연결 리스트처럼 동작한다.
좋은 해시 함수라면 서로 다른 인스턴스에 다른 해시코드를 반환한다. - 세 번째 규약이 요구하는 속성
이상적인 해시 함수는 주어진 (서로 다른) 인스턴스들은 32비트 정수 범위에 균일하게 분배해야 한다.
좋은 hashCode를 작성하는 요령
- int 변수 result를 선언한 후 값 c로 초기화한다. 이때 c는 해당 객체의 첫 번째 핵심 필드를 단계 2.a 방식으로 계산한 해시코드다. (핵심 필드란 equals 비교에 사용되는 필드)
-
해당 객체의 나머지 핵심 필드 f 각각에 대해 다음 작업을 수행한다.
- a. 해당 필드의 해시코드 c를 계산한다.
- 기본 타입 필드라면, Type.hashCode(f)를 수행한다. Type은 해당 기본 타입의 박싱 클래스다.
- 참조 타입 필드면서 이 클래스의 equals 메서드가 이 필드의 equals를 재귀적으로 호출해 비교한다면, 이 필드의 hashCode를 재귀적으로 호출한다.
- 계산이 더 복잡해질 것 같으면, 이 필드의 표준형을 만들어 그 표준형의 hashCode를 호출한다.
- 필드의 값이 null이면 0을 사용한다. (전통적)
- 필드가 배열이라면, 핵심 원소 각각을 별도 필드처럼 다룬다.
- b. 단계 2.a에서 계산한 해시코드 c로 result를 갱신한다.
result = 31 * result + c;
- result를 반환한다.
파생 필드는 해시코드 계산에서 제외해도 된다. 즉, 다른 필드로부터 계산해낼 수 있는 필드는 모두 무시해도 된다.
equals 비교에 사용되지 않은 필드는 ‘반드시’ 제외해야 한다. 그렇지 않으면 hashCode 규약 두 번째를 어기게 될 위험이 있다.
단계 2.b의 곱셉 31 * result는 필드를 곱하는 순서에 따라 result 값이 달라지게 한다. -> 클래스에 비슷한 필드가 여러 개일 때 해시 효과를 크게 높여준다.
곱할 숫자를 31로 정한 이유는 31이 홀수면서 소수이기 때문이다. 만약 이 숫자가 짝수이고 오버플로가 발생한다면 정보를 잃게 된다. 소수를 곱하는 이유는 명확하지 않지만 전통적으로 그리 해왔기 때문.
해시 함수 제작 요령은 최첨단은 아니지만 충분히 훌륭하다. 단, 해시 충돌이 더욱 적은 방법을 꼭 써야 한다면 구아바의 com.google.common.hash.Hashing을 참고하자.
Objects 클래스는 임의의 개수만큼 객체를 받아 해시코드를 계산해주는 정적 메서드인 hash를 제공한다. 하지만 속도는 더 느리다. (입력 인수를 담기 위한 배열이 만들어지고, 박싱과 언박싱도 거쳐야 할 수도 있기 때문) - 성능에 민감하지 않은 상황에서만 사용
@Override
public int hashCode() {
return Objects.hash(lineNum, prefix, areaCode);
}클래스가 불변이고 해시코드를 계산하는 비용이 크다면, 매번 새로 계산하기보다는 캐싱하는 방식을 고려해야 한다. 이 타입의 객체가 주로 해시의 키로 사용될 것 같다면 인스턴스가 만들어질 때 해시코드를 계산해둬야 한다.
해시의 키로 사용되지 않은 경우라면 hashCode가 처음 불릴 때 계산하는 지연 초기화 전략 - 필드를 지연 초기화하려면 그 클래스를 스레드 안전하게 만들도록 신경 써야 한다.
private int hashCode;
@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개 문자만으로 해시코드를 계산했다. URL처럼 계층적인 이름을 대량으로 사용한다면 이런 해시 함수는 심각한 문제를 고스란히 드러낸다.
hashCode가 반환하는 값의 생성 규칙을 API 사용자에게 자세히 공표하지 말자. 그래야 클라이언트가 이 값에 의지하지 않게 되고, 추후에 계산 방식을 바꿀 수도 있다.
