[이펙티브자바]equals를 재정의하려거든 hashCode도 재정의하라_아이템11

equals를 재정의한 클래스 모두에서 hashCode도 재정의해야 한다. 클래스의 인스턴스를 HashMap이나 HashSet 같은 컬렉션의 원소로 사용할 때 문제를 일으킬 것이다.

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

=> 논리적으로 같은 객체는 같은 해시코드를 반환해야한다.

Map<PhoneNumber, String> m = new HashMap<>();
m.put(new PhoneNumber(707, 867, 5309), "제니“);
// new PhoneNumber(707, 867, 5309)를 실행하면 null이 반환된다.

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

[좋은 hashCode 작성 요령]
1. int변수 result를 선언한 후 값 c로 초기화한다. 이때 c는 해당 객체의 첫 번째 핵심 필드를 단계 2-1방식으로 계산한 해시코드다.(핵심필드 = equals 비교에 사용되는 필드를 말한다.)

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

파생필드는 해시코드 계산에서 제외해도 된다. => 다른 필드로부터 계산해 낼 수 있는 필드는 모두 무시해도된다. equals비교에서 사용되지 않은 필드는 ‘반드시’ 제외해야한다.

2-2에서 곱셈 31 * result는 필드를 곱하는 순서에 따라 result 값이 달라진다. String의 hashCode를 곱셈 없이 구현한다면 모든 아나그램의 해시코드가 같아진다. 곱하는 숫자가 31인 이유는 홀수이면서 소수이기 때문이다. => 만약 숫자가 짝수이고 오버플로가 발생하면 정보를 잃게 된다. => 소수를 곱하는 이유는 전통적인 방법이며 31을 이용하면 이 곱셈을 시프트 연산과 뺄셈으로 대체해 최적화할 수 있다.

[전형적인 hashCode메서드]

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

품질 면에서나 해싱 기능 면에서나 자바 플랫폼 라이브러리가 사용한 방식과 견줄만하며 대부분이 쓰임에도 문제가 없다. (해시 충돌이 더욱 적은 방법을 써야 한다면 구아바의 com.google.common.hash.Hashing을 참고)

Object클래스는 임의의 개수만큼 객체를 받아 해시코드를 계산해주는 정적 메서드인 hash를 제공한다.
(한줄로 작성 가능 하지만 속도가 느리고 입력 중 기본타입이 있다면 박싱과 언박싱도 거쳐야한다. => hash메서드는 성능에 민감하지 않은 상황에 사용하자.)

[한 줄짜리 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) {
        result = Short.hashCode(areaCode);
        result = 31 * result + Short.hashCode(prefix);
        result = 31 * result + Short.hashCode(lineNum);
        hashCode = result;
    }
    return result;
}

성능을 높인다고 해시코드를 계산할 때 핵심 필드를 생략해서는 안된다. 만약 생략한다면 해당 영역의 수많은 인스턴스가 단 몇 개의 해시코드로 집중되어 해시테이블의 속도가 선형으로 느려질 것이다. hashCode가 반환하는 값의 생성 규칙을 API사용자에게 자세히 공표하지 말자. 그래야 클라이언트가 이 값에 의지하지 않게 되고, 추후에 계산 방식을 바꿀 수 있다.

마무리로 equals를 재정의할 때는 hashCode도 반드시 재정의하라. AutoValue프레임워크를 사용하면 멋집 equals와 hashCode를 자동으로 만들어준다. IDE들도 이런 기능을 일부 제공한다.