[Effective Java] 아이템 11. equals를 재정의하려거든 hashCode도 재정의하라

EFFECTIVE JAVA(이펙티브 자바)

 

 

이 포스팅에서 작성하는 내용은 EFFECTIVE JAVA(이펙티브자바) 에서 발췌하였습니다.

 

---

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

 

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

만약 그렇지 않으면 hashCode 일반 규약을 어기게 되어 해당 클래스의 인스턴스를 HashMap이나 HashSet 같은 컬렉션의 원소로 사용할 때 문제를 야기함

 

 

* Object 명세에서 발췌한 규약

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

 

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

→ 논리적으로 같은 객체는 같은 해쉬코드를 반환해야 한다는 것

equals는 물리적으로 다른 두 객체를 논리적으로 같다고 할 수 있지만, Object의 기본 hashCode 메서드는 이 둘이 전혀 다르다고 판단하여 서로 다른 값을 반환함

 

EX1) 

2개의 PhoneNumber 인스턴스가 사용되었고, hashCode 메서드는 논리적 동치인 두 객체를 다르다고 판단하여 서로 다른 해시코드를 반환함.

Map<PhoneNumber, String> m = new HashMap<>();
m.put(new PhoneNumber(010, 1234, 5678), "김멍목");

m.get(new PhoneNumber(010, 1234, 5678));		// "김멍목"이 아닌 null 반환

 

 

 

 좋은 hashCode를 작성하는 팁

1. int 변수 result를 선언한 후 값 c로 초기화한다. 이 때 c는 해당 객체의 첫 번째 핵심 필드(equals 비교에 사용되는 필드)를 단계 2.1방식으로 계산한 해시코드다.
2. 해당 객체의 나머지 핵심 필드 f 각각에 대해 다음 작업을 수행
   
   1. 해당 필드의 해시코드 c를 계산
      1. 기본 타입 필드라면, Type,hashCode(f) 수행
      2. 참조 타입 필드면서 이 클래스의 equals 메서드가 이 필드의 equals를 재귀적으로 호출해 비교한다면, 이 필드의 hashCode를 재귀적으로 호출.
         계산이 복잡해질 것 같으면, 이 필드의 표준형을 만들어 그 표준형의 hashCode를 호출
         필드의 값이 null이면 0을 사용
      3. 필드가 배열이라면, 핵심 원소의 각각을 별도 필드처럼 다룸. 이상의 규칙을 재귀적으로 적용해 각 핵심 원소의 해시코드를 계산한 다음, 단계 2.2 방식으로 갱신함
         배열에 핵심 원소가 하나도 없다면 단순히 상수(0)를 사용. 모든 원소가 핵심 원소라면 Arrays.hashCode를 사용
   2. 단계 2.1에서 계산한 해시코드를 c로 result를 갱신
      코드 : result = 31 * result  + c;
      31을 곱하는 이유 : 31이 홀수이면서 소수이기 때문
3. result를 반환

+) equals 비교에 사용되지 않는 필드는 반드시 제외하며, 파생필드는 해시코드 계산에서 제외해도 된다.

 

 

 

 

위의 EX1) 에서 사용된 phoneNumber 클래스의 hashCode를 재정의한 코드

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

// 한 줄짜리 hashCode 메서드 (위의 코드보다 속도가 더 느림)
@Override
public int hashCode() {
    return Objects.hash(lineNum, prefix, areaCode);
}

 

 

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

private int hashCode;		// 자동으로 0으로 초기화 됨

@Override
public int hashCode() {
    int result = this.hashCode;
    
    // 기존에 계산된 해시코드가 없을 때 계산
    if(result == 0) {
        result = Short.hashCode(areaCode);
        result = 31 * result + Short.hashCode(prefix);
        result = 31 * result + Short.hashCode(lineNum);
    }
    
    return result;
}

 

 

 

 

정리

equals를 재정의할 때 hashCode도 반드시 재정의하자.

→ 논리적으로 같다면 같은 해시코드를, 다르다면 다른 해시코드를 반환해주자.

아이템 10에서 언급한 AutoValue 프레임워크가 equals와 hashCode를 자동으로 재정의해주니 참고하자.