item 11. equals를 재정의하려거든 hashCode도 재정의하라
hashCode란?
간단히 말해, hashCode() 는 해싱 알고리즘에 의해 생성된 정수 값을 반환합니다.
( equals() 에 따라) 동일한 객체는 동일한 해시 코드를 반환해야 합니다. 다른 객체는 다른 해시 코드를 반환할 필요가 없습니다.
As much as is reasonably practical,
the hashCode() method defined by class Object
does return distinct integers
for distinct objects.
hashCode의 일반 규약
- equals 비교에 사용되는 정보가 변경되지 않았다면 애플리케이션이 실행되는 동안 그 객체의 hashCode는 항상 같은 값을 반환해야한다. 단, 애플리케이션이 재실행하는 경우 값이 달라질 수는 있다.
- equals가 두 객체를 같다고 판단했다면, 두 객체의 hashCode는 똑같은 값을 반환해야한다.
- equals가 두 객체를 다르다고 판단하더라도 두 객체의 hashCode가 서로 다른 값을 반환할 필요는 없다. 단, 다른 객체에 대해서는 다른 값을 반환해야 해시 테이블의 성능이 좋아진다.
잘못된 해시코드 재정의로 크게 문제가 발생할 수 있는 규약은 2번 규약이다.
특히 해시를 기반으로 하는 HashMap, HashSet과 같은 컬렉션의 원소로 사용하는 경우 문제를 일으킬 수 있다.
해시코드를 재정의하지 않아 논리적 동치인 두 객체가 서로 다른 해시코드를 반환해 두 번째 규약을 지키지 못한 경우,
get 메서드가 엉뚱한 해시 버킷에 가서 객체를 찾고있을 가능성이 있다.
* 절대 하지 말아야 하는 해시 코드 구현 방법
//잘못된 그러나 적법한 hashCode 구현
@Override
public int hashCode() {
return 42;
}
모든 객체가 같은 해시코드를 가진다면 어떻게 될까?
-> 모든 객체가 하나의 해시버킷에 담겨 마치 연결리스트와 같은 역할을 한다. -> 해시 수행 시간을 O(1)에서 O(n)으로 느려지게 하는 방법.
[좋은 해시 코드를 작성하는 요령]
- int 변수 result를 선언한 후 값 c로 초기화한다.
- 이때 c는 해당 객체의 첫번째 핵심 필드를 다음 소개하는 2.a 방식으로 계산한 해시코드이다. -> 핵심 필드란, equals 비교에 사용되는 필드이다. equals 비교에 사용되지 않는 필드는 반드시 hashCode에서 제외해야한다. 이를 어기면 hashCode의 두번째 규약을 어기기 때문이다.
- 해당 객체의 나머지 핵심 필드 f에 대해 각각 다음 작업을 수행한다.
- 해당 필드의 해시코드 c를 계산하기
- 기본 필드라면 Type.hashCode(f)를 수행한다. 이때 Type -> 해당 기본 타입의 boxing class
- 참조 필드이면서 클래스의 equals가 이 필드의 equals를 재귀적으로 호출해 비교한다면, 이 필드의 표준형을 만들어 표준형의 해시코드를 호출한다. 만약 필드의 값이 null이면 0을 사용한다.
- 배열이라면 핵심 원소 각각을 별도의 필드로 나눈다. 별도로 나눈 필드를 위 규칙을 적용하여 해시코드를 계산한 후 다음 소개되는 2.b 방식으로 갱신한다. 모든 원소가 핵심이라면 Arrays.hashCode를 이용한다.
- 단계 2.1에서 계산한 해시코드 c로 result 갱신하기
- 31을 곱하는 이유? : 31은 홀수, 소수이기 때문.
- 곱한 숫자가 짝수라면 shift연산과 같은 결과를 주기 때문에 오버플로 발생 시 정보를 잃을 수 있음.
- 소수를 곱하는 것은 나머지 연산에서 충돌을 줄이기 위한 전통적 방식.
- 해당 필드의 해시코드 c를 계산하기
result = 31 * result + c
3. result 를 반환한다.
[그 외 방법]
- 해시 충돌이 적은 방법을 사용해야 하는 경우
- Object class의 hash
- Arrays.java 안의 hashcode를 통해 계산됨.
- 한 줄로 해시코드를 구현할 수 있다.
//item10.java
@Override
public int hashCode() {
return Objects.hash(time, member, Teamname);
}
//Object.java
public static int hash(Object... values) {
return Arrays.hashCode(values);
}
// Arrays.java
public static int hashCode(Object a[]) {
if (a == null)
return 0;
int result = 1;
for (Object element : a)
result = 31 * result + (element == null ? 0 : element.hashCode());
return result;
}
//위와 같이 구현되어 있다.
- 한줄로 해시코드를 구현할 수 있지만, 속도는 더 느리다. 입력 인수를 받기 위한 배열이 만들어지고, 기본 타입이 있다면 박싱, 언박싱을 거치기 때문이다.
- 성능이 민감하지 않은 상황에서 사용하는 것이 좋다.
- 불변 클래스이고, hashCode 계산 비용이 큰 경우
- => 캐싱하는 방식이 좋다.
- 클래스 객체가 해시의 키로 사용되는 경우 : 인스턴스를 생성할 때 해시코드 계산
- 해시 키로 사용되지 않는 경우 : 해시코드가 처음 불릴 때 계산하는 lazy initialization (지연 초기화)
/*lazy initialization Example*/
private int hashCode; // Automatically initialized to 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;
}
- 해시코드 필드의 초기값은 흔이 생성되는 객체의 해시코드와는 달라야 한다.
[주의 사항]
성능을 높이는 것을 목적으로 해시코드를 계산할 시 핵심 필드를 생략해서는 안된다.
item10의 AutoValue를 사용하면 자동으로 생성해주기도 한다.