11. equals를 재정의하려거든 hashCode도 재정의하라

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

Object 명세에서 발췌한 규약

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

- hashCode 재정의를 잘못했을때 크게 문제가 되는 조항은 두 번째다

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

 

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

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

- m.get(new PhoneNumber(707, 867, 5309)) 결과 값은 null 이 반환 

- 하나는 HashMap에 "제니"를 넣을 때 사용

- 두 번째 꺼내려할 때 PhoneNumber 클래스는 hashCode를 재정의하지 않음

- 논리적 동치인 두 객체가 서로 다른 해시 코드를 반환하여 두 번째 규약을 지키지 못한다

- get 메서드는 엉뚱한 해시 버킷에 가서 객체를 찾으려 한다

- 이 문제는 PhoneNuber에 적절한 hashCode 메서드만 작성해주면 해결

 

코드 11-1 최악의(하지만 적법한) hashCode 구현 - 사용금지!

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

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

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

- 그 결과 O(1) -> O(n) 느려져서, 객체가 많아지면 도저히 쓸 수가 없다

 

좋은 hashCode를 작성하는 간단한 요령

1. int 변수 result를 선언한 후 값 c로 초기화한다
   이때 c는 객체의 첫 번째 핵심 필드를 단계 2.a 방식으로 계산한 해시 코드다
   핵심 필드란 equals 비교에 사용되는 필드

2. 해당 객체의 나머지 핵심필드 f 가각에 대해 다음 작업 수행
  a. 해당 필드의 해시 코드 c를 계산
     i. 기본 타입 필드라면, Type.hashCode(f)를 수행한다 (Type = 기본 타입의 박싱 클래스)
    ii. 참조 타입 필드면서 이클래스의 equals 메서드가 이 필드의 equals를 재귀적으로 호출해 비교한다면
       이 필드의 hashCode를 재귀적으로 호출
   iii. 필드가 배열이라면, 핵심 원소 각각을 별도 필드처럼 다룬다

  b. 단계 2.a에서 계산한 해시 코드 c로 result를 갱신한다 (result = 31 * result + c)

3. result를 반환한다

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

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

- 또한 equals 비교에 사용되지 않은 필드는 '반드시' 제외해야 한다

- 그렇지 않으면 hashCode 규약 두 번째를 어기게 된다

 

단계 2.b의 곱셉 31 * result는 필드를 곱하는 순서에 따라 result 값이 달라지게 한다

- 그 결과 클래스에 비슷한 필드가 여러 개 일 때 해시 효과를 크게 높여준다

- 31로 정한 이유는 31이 홀수이면서 소수 이기 때문이다

- 만약 숫자가 짝수이면 오버플로가 발생하면서 정보를 잃게 된다

 

코드 11-2 전형적인 hashCode 메서드

// 코드 11-2 전형적인 hashCode 메서드 (70쪽)
    @Override public int hashCode() {
        int result = Short.hashCode(areaCode);
        result = 31 * result + Short.hashCode(prefix);
        result = 31 * result + Short.hashCode(lineNum);
        return result;
    }

- PhoneNumber 인스턴스의 핵심 필드 3개만 사용해 간단한 계산만 수행한다

- 그 과정에 비결정적 요소는 전혀 없으므로 동치인 PhoneNumber 인스턴스들은 같은 해시 코드를 가질것이 확실하다

 

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

// 코드 11-3 한 줄짜리 hashCode 메서드 - 성능이 살짝 아쉽다. (71쪽)
    @Override public int hashCode() {
        return Objects.hash(lineNum, prefix, areaCode);
    }

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

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

 

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

// 해시코드를 지연 초기화하는 hashCode 메서드 - 스레드 안정성까지 고려해야 한다. (71쪽)
    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도 반드시 재정의해야 한다
그렇지 않으면 프로그램이 제대로 동작하지 않을 것이다
재정의한 hashCode는 Object의 API문서에 기술된 일반 규약을 따라야 하며
서로 다른 인스턴스라면 되도록 해시 코드도 서로 다르게 구현해야 한다.