EFFECTIVE JAVA 3/E 책을 공부하고 정리한 글입니다.

📖 equals를 재정의하려거든, hashCode도 재정의하라

📌 hashCode 일반 규약

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

규약 1. equals 비교에 사용되는 정보가 변경되지 않았다면, 어플리케이션이 실행되는 동안 그 객체의 hashCode 메서드는 몇 번을 호출해도 일관되게 항상 같은 값을 반환해야 한다. 단, 어플리케이션을 다시 실행한다면 이 값이 달라져도 상관없다.

규약 2. equals(Object)가 두 객체를 같다고 판단했다면, 두 객체의 hashCode는 똑같은 값을 반환해야 한다.

규약 3. equals(Object)가 두 객체를 다르다고 판단했더라도, 두 객체의 hashCode가 서로 다른 값을 반환할 필요는 없다. 단, 다른 객체에 대해서는 다른 값을 반환해야 해시테이블의 성능이 좋아진다.

• hashCode 재정의를 잘못했을 때 크게 문제가 되는 조항은 두 번째다. 즉, 논리적으로 같은 객체는 같은 해시코드를 반환해야 한다.

• equals는 물리적으로 다른 두 객체를 논리적으로 같다고 할 수 있다.
  -- 그러나, Object의 기본 hashCode 메서드는 이 둘이 전혀 다르다고 판단하여 규약과 달리 서로 다른 값을 반환한다.

-- 지난 챕터때 사용했던 PhoneNumber 클래스를 예시로 사용해보자.

// [코드 10-6] 전형적인 equals 메서드의 예

public final class PhoneNumber {
	private final short areaCode, prefix, lineNum;
    
    public PhoneNumber(int areaCode, int prefix, int lineNum) {
    	this.areaCode = rangeCheck(areaCode, 999, "지역코드");
        this.prefix = rangeCheck(prefix, 999, "프리픽스");
        this.lineNum = rangeCheck(lineNum, 9999, "가입자 번호");
    }
    
    private static short rangeCheck(int val, int max, String arg) {
    	if(val < 0 || val > max)
        	throw new IllegalArgumentException(arg + ": " + val)
            
      	return (short)val;
    }
    
    @Override public boolean equals(Object o) {
    	if(o == this)
        	return true;
            
      	if(!(o instanceof PhoneNumber))
        	return false;
            
     	PhoneNumber pn = (PhoneNumber)o;
        
        return pn.lineNum == lineNum && pn.prefix == prefix && 
        pn.areaCode == areaCode;
    }
    
    ... // 나머지 코드는 생략
}

• 이 코드의 클래스의 인스턴스를 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를 재정의하지 않았기 때문에 논리적 동치인 두 객체가 서로 다른 해시코드를 반환하여 규약 2를 지키지 못함.
  --> 그 결과, get 메서드는 엉뚱한 해시 버킷에 가서 객체를 찾으려 한다.
  -- 같은 해시 버킷에 가서 객체를 찾아도 get 메서드는 여전히 null을 반환하는데, 그 이유는 HashMap은 해시코드가 다른 엔트리끼리는 동치성 비교를 시도조차 하지 않도록 최적화되어 있기 때문

• 해결법 : 클래스에 적절한 hashCode 메서드만 작성해주면 된다.

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

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

• 이 코드는 동치인 모든 객체에서 똑같은 해시코드를 반환하여 적법하지만 모든 객체에게 같은 값만 반환하므로 수행시간이 O(1)이었던 해시테이블이 O(n)으로 느려져서 객체수가 많아지면 성능이 너무 많이 떨어진다.

• 좋은 해시 함수는 서로 다른 인스턴스에 다른 해시코드를 반환한다.
  -- hashCode의 세 번째 규약

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

1. int 변수 result를 선언한 후 값 c로 초기화
   이 때, c는 해당 객체의 첫 번째 핵심 필드를 단계 2.a 방식으로 계산한 해시코드 (핵심 필드 : equals 비교에 사용되는 필드)
   
   
2. 해당 객체의 나머지 핵심 필드 f 각각에 대해 다음 작업을 수행

2-a. 해당 필드의 해시코드 c를 계산

• 2-a-i. 기본 타입 필드라면, Type.hashCode(f)를 수행한다.
  여기서 Type : 해당 기본 타입의 박싱 클래스
  
  
• 2-a-ii. 참조 타입 필드면서 이 클래스의 equals 메서드가 이 필드의 equals를 재귀적으로 호출하여 비교한다면, 이 필드의 hashCode를 재귀적으로 호출한다.
  계산이 더 복잡해 질 것 같으면, 이 필드의 표준형(canonical representation)을 만들어 그 표준형의 hashCode를 호출한다.
  필드의 값이 null이면 전통적으로 0을 사용한다.
  
  
• 2-a-iii. 필드가 배열이라면, 핵심 원소 각각을 별도 필드처럼 다룬다.
  배열에 핵심 원소가 하나도 없다면 단순히 상수(0 추천)를 사용한다.
  모든 원소가 핵심 원소라면 Arrays.hashCode를 사용
  2-b. 단계 2-a에서 계산한 해시코드 c로 result 갱신
  result = 31 * result + c;
  
  

3. result 반환

• hashCode를 위의 요령에 맞게 구현했다면, 이 메서드가 동치인 인스턴스에 대해 똑같은 해시코드를 반환할 지 자문해보고 단위 테스트를 작성해보자.
  -- 프레임워크 AutoValue를 활용하여 생성했다면, 건너뛰어도 좋다.

• 파생 필드는 해시코드 계산에서 제외해도 된다.
  -- 즉, 다른 필드로부터 계산해 낼 수 있는 필드는 모두 무새히도 된다.
  -- 또한, equals 비교에 사용되지 않은 필드는 '반드시' 제외해야 한다.
  -- 그렇지 않으면, hashCode 규약 두 번째를 어기게 될 위험이 있다.

• 단계 2.b의 곱셉 31*result는 필드를 곱하는 순서에 따라 result 값이 달라지게 한다.
  -- 그에 따라 클래스에 비슷한 필드가 여러 개 일 때 해시 효과를 크게 높여준다.
  -- String의 hashCode를 곱셈 없이 구현한다면 모든 아나그램(anagram, 구성하는 철자가 같고 그 순서만 다른 문자열)의 해시코드가 같아진다.
  -- 31 : 홀수이면서 소수(prime number)이기 때문에 통상적으로 사용됨.

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

@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개만 사용하여 간단한 계산만 수행한다.
  -- 그 과정 속에서 비결정적(undeterministic) 요소는 전혀 없으므로 동치인 PhoneNumber 인스턴스들은 같은 해시코드를 가질 것이 확실하다.
  -- 이는, 자바 플랫폼 라이브러리의 클래스들이 제공하는 hashCode 메서드와 비교해도 모자람이 없다.
  -- 단, 해시 충돌이 더욱 적은 방법을 꼭 사용해야 한다면, 구아바를 사용할 것.

• Objects 클래스는 임의의 개수만큼 객체를 받아 해시코드를 계산해주는 정적 메서드인 hash를 제공한다.
  -- 이를 활용하면 속도는 다소 느리지만 간단한 코드를 작성할 수 있다.
  -- 따라서 hash 메서드는 성능에 민감하지 않은 상황에서만 사용하자.

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

@Override public int hashCode() {
	return Objects.hash(lineNum, prefix, areaCode);
}

• 클래스가 불변이고 해시코드를 계산하는 비용이 크다면, 매번 새로 계산하기 보다는 캐싱하는 방식을 고려하자.
  -- 이 타입의 객체가 주로 해시의 키로 사용될 것 같다면 인스턴스 생성 시, 해시코드를 계산해둬야 한다.
  -- 해시의 키로 사용되지 않는 경우는 지연 초기화(lazy initialization)을 고려해볼만 하다. 대신, 스레드 안전성을 신경 써야한다.
  -- hashCode 필드의 초깃값은 흔히 생성되는 객체의 해시코드와는 달라야 함에 유념해야 한다.

// [코드 11-4] 해시 코드를 지연 초기화하는 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도 반드시 재정의해야 한다.

재정의한 hashCode는 일반 규약을 따라야 하며, 서로 다른 인스턴스라면 되도록 해시코드도 서로 다르게 구현해야 한다.

AutoValue 프레임워크나 다른 IDE 등을 활용하면 자동으로 equals와 hashCode를 만들어 준다.