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

1. equals를 재정의 할 때 hashCode도 재정의해야 하는 이유

equals를 재정의하고 hashCode를 재정의하지 않으면 hashCode 일반 규약을 거기게 되어 해당 클래스의 인스턴스를 HashMap이나 HashSet과 같은 컬렉션의 원소로 사용할때 문제를 일으킵니다.

 

Object 명세 규약

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

위의 Object 명세 규약을 기반으로 봤을때 hashCode 재정의를 잘못했을 때 문제가 되는 부분은 두번째입니다. 즉, 논리적으로 같은 객체는 같은 해시코드를 반환해야 합니다.

 

예를 들어 PhoneNumber 클래스의 인스터스를 HashMap의 원소로 넣고 논리적으로 같은 값을 가진 물리적으로 다른 인스턴스로 get을 한다고 가정합니다.

		Map<PhoneNumber, String> m = new HashMap<PhoneNumber, String>();
		m.put(new PhoneNumber(707, 867, 123), "제니");
		System.out.println(m.get(new PhoneNumber(707, 867, 123)));

수행결과는 다음과 같습니다.

• hashCode를 재정의하지 않았을 경우 : 물리적으로 다른 인스턴스이므로 null을 반환
• hashCode를 재정의하는 경우 : "제니" 반환

 

2. hashCode를 재정의하는 3가지 방법

전형적인 hashCode 메서드 재정의

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

• result 변수에 핵심 필드의 해시코드 값을 초기화
• 그 이후에 result 변수에 31을 곱하고 각각의 필드의 해시코드 값을 더함
• 31을 곱하는 이유는 홀수이면서 소수여서 해시 테이블의 버킷에 골고루 분배되기 때문입니다.

 

Objects.hash 메서드를 이용한 hashCode 메서드 재정의

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

• Objects 클래스는 임의의 개수만큼 객체를 받아서 해시코드를 계산해주는 정적 메서드인 hash를 제공함
• 속도가 느림

 

지연 초기화를 이용한 hashCode 메서드 재정의

	// 코드 11-4 해시코드를 지연 초기화하는 hashCode 메서드 - 스레드 안정성까지 고려해야함 (71p)
	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);
			this.hashCode = result;
		}
		return result;
	}

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

 

3. hashCode를 재정의시 주의점

1. 성능을 높이기 위해 해시코드를 계산할 때 핵심 필드를 생략해서는 안됩니다.
2. hashCode가 반환하는 값의 생성규칙을 API 사용자에게 자세히 공표하면 안됩니다.

 

References

source code : https://github.com/yonghwankim-dev/effective_java/tree/master/src/role11
effective java 3/E