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

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

🐳 Hashcode 구약: Object명세

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

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

3. equals(Object)가 구 객체를 다르다고 판단했더라도, 두 객체의 hashCode가 서로 다른 값을 반환할 필요는 없다. (단, 해시테이블 성능이 나빠진다)

-> hashCode재정의를 잘못했을 때 크게 문제가 되는 조항은 2번이다. 즉, 논리적으로 같은 객체는 같은 해시코드를 반환해야 한다.

잘못된 hashCode예시

PhoneNumber 클래스의 인스턴스를 HashMap의 원소로 사용한다고 해보자

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

m.get(new PhoneNumber(707, 867, 5309), "제니"); //null반환

PhoneNumber 클래스는 HashCode를 재정의하지 않았기 때문에 논리적으로 동치인 두 객체가 서로 다른 hashCode를 반환하여 두번째 규약을 지키지 않는다. 그 결과 get메서드는 엉뚱한 해시 버킷에서 객체를 찾으려 한 것이다.

최악의 hashCode구현 - 사용 금지!

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

이런식으로 hashCode를 구현하면 HashMap에서의 문제는 해결되지만 O(1)이였던 해시테이블의 성능이 O(N)까지 느려진다. 왜냐하면 hashCode가 같은 값을 반환하는 서로 다른 객체는 마치 linkedList처럼 동작하기 때문이다.
-> 좋은 hashCode함수는 서로 다른 인스턴스에 대해서 다른 hashCode를 반환한다.

🐳 좋은 Hashcode 구현방법

이상적인 해시 함수는 서로 다른 인스턴스들을 32비트 정수 범위에 균일하게 분배해야 한다. 이상을 완벽하게 실현하기는 어렵지만 비슷하게 만들기는 그다지 어렵지 않다.

hash함수 작성 요령

1. int변수 result를 선언한 후 값 c로 초기화한다. 이때 c는 해당 객체의 첫번째 핵심 필드(equals에 사용되는)를 단계 2.1 방식으로 계산한 해시코드다.
2. 해당 객체의 나머지 핵심 필드인 f 각각에 대해 다음 작업을 수행한다.
   1. 해당 필드의 해시코드 c 를 계산한다.
      • 기본 타입 필드라면, Type.hashCode(f)를 수행한다. 여기서 Type은 해당 기본타입의 박싱 클래스다.
      • 참조 타입 필드면서, 이 클래스의 equals 메소드가 이 필드의 equals를 재귀적으로 호출하여 비교한다면, 이 필드의 hashCode를 재귀적으로 호출한다.
      • 필드가 배열이라면, 핵심 원소 각각을 별도 필드처럼 다룬다.
        모든 원소가 핵심 원소라면 Arrays.hashCode를 사용한다.
   2. 단계 2.1에서 계산한 해시코드 c로 result를 갱신한다.
      • result = 31 * result + c;
3. result를 반환한다.

주의할 점

• equals비교에 사용되는 필드에 대해서만 해시코드를 계산한다.
• 성능을 높인답시고 해시코드를 계산할 때 핵심 필드를 생략해서는 안 된다.
• 31을 곱하는 이유는 비슷한 필드가 여러개일 때 해시효과를 크게 높여주기 위해서다.

전형적인 hashCode 메서드

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

한줄짜리 hashCode 메서드 - 성능이 살짝 아쉽다.

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

🐳 hashCode의 캐싱과 지연 초기화

• 클래스가 불변이고 해시코드를 계산하는 비용이 크다면, 매번 새로 계산하기 보다 캐싱을 고려해야 한다.
  • 이 타입의 객체가 주로 해시의 키로 사용될 것 같다면 인스턴스가 만들어질 때 해시코드를 계산해 둔다.
• 해시의 키로 사용되지 않는 경우라면 hashCode가 처음 불릴 때 계산하는 지연 초기화 전략이 좋다.
  • 필드를 지연 초기화 하려면 스레드 안정성도 고려해야 한다

해시코드를 지연 초기화하는 hashCode 메서드 - 스레드 안전성까지 고려해야 한다.

private int hashCode; // 초기값 0을 가진다.

@Override
public int hashCode() {
	int result = hashCode; 
    if(result == 0) {
        int result = Integer.hashCode(areaCode);
        result = 31 * result + Integer.hashCode(areaCode);
        result = 31 * result + Integer.hashCode(areaCode);
        hashCode = result;
    }
    return result;
}

동시에 여러 쓰레드가 hashCode를 호출하면 여러 쓰레드가 동시에 계산하여 우리의 처음 의도와는 다르게 여러번 계산하는 상황이 발생할 수 있다.

🐳 결론

equals를 재정의할 때는 hashCode도 반드시 재정의해야 한다. 그렇지 않으면 프로그램이 제대로 동작하지 않을 것이다.
재정의한 hashCode는 Object의 API 문서에 기술된 일반 규약을 따라야 하며, 서로 다른 인스턴스라면 되도록 해시코드도 서로 다르게 구현해야 한다.
웬만하면 AutoValue 프레임워크를 사용하는 것이 좋을 것 같다.

참고
이펙티브 자바