item 11 hyowon - JAVA-JIKIMI/EFFECTIVE-JAVA3 GitHub Wiki

equals를 재정의한 클래스 모두에서 hashCode도 재정의해야 한다.

그렇지 않으면 hashCode 일반 규약을 어기게 되어 HashMap, HashSet 같은 컬렉션의 원소로 사용할 때 문제를 일으킬 것이다.

Object 명세의 규약 (Object.hashCode())

1. equals 비교에 사용되는 정보가 변경되지 않았다면, 애플리케이션이 실행되는 동안 그 객체의 hashCode 메서드는 항상 같은 값을 반환해야 한다. 단 애플리케이션을 재실행한다면 이 값이 달라져도 된다.
2. equals(Object)가 두 객체를 같다고 판단했다면, 두 객체의 hashCode 반환값은 같아야 한다.
3. equals(Object)가 두 객체를 다르다고 판단해도, 두 객체의 hashCode 반환값이 다를 필요는 없다.

hashCode 재정의를 잘못했을 때 크게 문제가 되는 조항은 두 번째로, 논리적으로 같은 객체는 같은 해시코드를 반환해야 한다. 필요에 따라 equals는 물리적(동일성)으로 다르지만 논리적(동등성)으로 같은 객체를 같다고 재정의할 수 있다.

하지만 Object의 기본 hashCode 메서드는 이 둘이 전혀 다르다고 판단하여, 규약과 달리 다른 값을 반환한다.

Map<PhoneNumber, String> m = new HashMap<>();
m.put(new PhoneNumber(031,707,1234), "제니");
m.get(new PhoneNumber(031,707,1234));           // null

좋은 hashCode를 작성하는 요령

1. int 변수 result를 선언한 후 값 c로 초기화. (이 때 c는 해당 객체의 핵심 필드를 2.1 방식으로 계산한 hashCode이다)
2. 해당 객체의 나머지 핵심 필드 f 각각에 대해 다음 작업을 수행한다.

   1. 해당 필드의 해시코드 c를 계산한다.

      1. (기본타입인 경우) ${Type}.hashCode(f) 를 수행한다. Type은 해당 기본 타입의 박싱 클래스이다
      2. (참조타입인 경우) 이 클래스의 equals 메서드가 이 필드의 equals를 재귀적으로 호출해 비교한다면 그렇게 한다. 단, 계산이 복잡하다면 이 필드의 표준형(canonical representation)을 만들어 그 표준형의 hashCode를 호출한다. 필드의 값이 null이면 0을 사용한다.
      3. (배열인 경우) 핵심 원소 각각을 별도 필드처럼 다룬다. 배열에 핵심 원소가 하나도 없다면 상수 0을 사용하고, 모든 원소가 핵심 원소라면 Arrays.hashCode를 사용한다.

   2. 단계 2.1에서 계산한 해시코드 c로 result를 갱신한다.

      result = 31 * result + c;
      

   3. result를 반환한다.

class PhoneNumber {
		private int areaCode;
    private String exchangeNumber;
    private int[] number;

    PhoneNumber(int areaCode, String exchangeNumber, int[] number) {
        this.areaCode = areaCode;
        this.exchangeNumber = exchangeNumber;
        this.number = number;
    }

    @Override
    public int hashCode() {
        int result = Objects.hash(areaCode, exchangeNumber);
        result = 31 * result + Arrays.hashCode(number);
        return result;
    }
		
		@Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        PhoneNumber that = (PhoneNumber) o;
        return areaCode == that.areaCode &&
                Objects.equals(exchangeNumber, that.exchangeNumber) &&
                Arrays.equals(number, that.number);
    }
}

public class ItemEleven {
    public static void main(String[] args) {
        Map<PhoneNumber, String> m = new HashMap<>();

        PhoneNumber pn = new PhoneNumber(031,707,1234);
        m.put(pn, "제니");
        m.get(new PhoneNumber(031,707,1234));

        // hashcode test
        System.out.println(m.get(new PhoneNumber(031,707,1234))); // 제니
        System.out.println(m.get(pn)); // 제니

        System.out.println(new PhoneNumber(031,707,1234).hashCode()); // 1247369920
        System.out.println(new PhoneNumber(031,707,1234).hashCode()); // 1247369920

    }
}

• 해시 충돌이 더욱 적은 방법을 원한다면 구아바의 com.google.common.hash.Hashing을 참고하자.

• Object 클래스는 임의 개수의 객체를 받아 해시코드를 계산하는 hash 매서드를 제공한다. 단, 속도는 느려지는데 입력 인수를 담기 위한 배열이 만들어지고, 입력 중 기본 타입이 있다면 박싱, 언박싱이 이뤄지기 때문이다.

• 클래스가 불변이고 해시코드를 계산하는 비용이 크다면, 캐싱하는 방식을 고려하자

  • 이 타입의 객체가 주로 해시의 키로 사용될 것 같다면 → 인스턴스 생성시 해시코드를 계산
  • 잘 사용되지 않을 것 같다면 → 지연 초기화 전략

  // 지연 초기화 전략
  private int hashCode; // 자동으로 0으로 초기화
  @Override public int hashCode() {
  	int result = hashCode;
  	if (result == 0) {
  		result = Integer.hashCode(areaCode);
  		result = 31 * result + exchangeNumber.hashCode();
  		result = 31 * result + Arrays.hashCode();
  		hashCode = result;
  	}
  	return result;
  }
  

• 성능을 높인다고 핵심 필드를 생략한다면 해시 품질이 나빠져 같은 값이 대량으로 생성될 수 있다.

• hash 생성규칙을 api 사용자에게 공개하지 말자. 그래야 클라이언트가 이 값에 의지하지 않고 추후 계산 방식을 바꿀 수 있다.