11. equals를 재정의하려거든 hashCode도 재정의하라
안녕하세요, 이번 포스팅은 직전 포스팅과 이어지는 hashCode입니다.
요새 자주 느끼는 것이 있는데요, 본인이 중요하다 혹은 포기하지 않겠다라는 생각이, 나중에 바라보면 그렇게 굉장한 일이 아닐 수 있다고 생각이 듭니다.
이것은, 평소 자신의 선택 뿐만아니라 사람 관계에서도 중요하다고 느끼는데요.
내가 상대방을 이렇게 생각한다고 해서, 상대방은 나를 그렇게 생각하는 것이 아닙니다.
상대방이 덜 생각할수도, 더 생각할수도 있고.. 이건 상대적입니다.
이런것에 감정소비를 하지않고, 그저 자신 그대로의 모습을 보여주면 좋겠습니다.
equals를 재정의한 클래스 모두에서는, hashCode도 재정의해야 합니다.
그렇지 않으면, hashCode 규약을 어기게 되어 HashMap이나, HashSet 같은 컬렉션의 원소로 사용될 때, 문제를 일으킬 수 있습니다.
equals와 마찬가지로, 다음은 Object 명세에서 발췌한 규약입니다.
equals 비교에 사용되는 정보가 변경되지 않았다면, 애플리케이션이 실행되는 동안
그 객체의 hashCode 메서드는 몇 번을 호출해도 일관되게 항상 같은 값은 반환해야 한다.
단, 애플리케이션을 다시 실행했다면 이 값이 달라져도 상관없다.
equals(Object)가 두 객체를 같다고 판단했다면, 두 객체의 hashCode는 똑같은 값을 반환해야 한다.
equals(Object)가 두 객체를 다르다고 판단했더라도, 두 객체의 hashCode가 서로 다른 값을 반환할 필요는 없다. 단, 다른 객체에 대해서는 다른 값을 반환해야 해시테이블의 성능이 좋아진다.
hashCode 재정의를 잘못했을 때, 가장 큰 문제가 되는 것은 두 번째 조항입니다.
즉, 논리적으로 같은 객체는 같은 해시코드를 반환해야 합니다.
Item. 10처럼, equals는 물리적으로 다른 두 객체를 논리적으로 같다고 할 수 있습니다. 하지만, Object의 기본 hashCode 메서드는 이 둘이 전혀 다르다고 판단하여, 규약과 달리 서로 다른 값을 반환합니다.
아이템 10의 PhoneNumBer 클래스의 인스턴스를 HashMap의 원소로 사용한다고 가정하겠습니다.
package item11;
import item10.PhoneNumber;
import java.util.HashMap;
import java.util.Map;
public class Item11Main {
public static void main(String[] args) {
Map<PhoneNumber, String> m = new HashMap<>();
m.put(new PhoneNumber(123, 456, 789), "동영");
String value = m.get(new PhoneNumber(123, 456, 789));
System.out.println("value = " + value);
}
}value = null
Process finished with exit code 0여기서 반환값을 "동영"으로 기대했지만, null을 반환합니다. 여기에는 2개의 PhoneNumber 인스턴스가 사용되었다고 할 수 있는데, 하나는 put으로 "동영"을 넣을 때, 그리고 하나는 꺼낼 때 사용했습니다. PhoneNumber 클래스는 hashCode를 재정의하지 않았기 때문에, 논리적 동치인 두 객체가 서로 다른 해시코드를 반환하여 두 번째 규약을 지키지 못하게 합니다.
그 결과, get 메서드는 엉뚱한 해시 버킷에 가서 객체를 찾으려 한 것입니다.
HashMap 클래스의 get 구현
public V get(Object key) {
Node<K,V> e;
return (e = getNode(hash(key), key)) == null ? null : e.value;
}이 문제는 적절한 hashCode 메서드만 작성해주면 해결되는데요, 올바는 hashCode 메서드는 어떤 모습일까요? 예를 들어 다음 코드는 적절하게 구현했지만, 절대 사용해서는 안됩니다.
@Override
public int hashCode() {
return 1;
}value = 동영
Process finished with exit code 0이 코드는, 동치인 모든 객체에서 똑같은 해시코드를 반환하니 아주 적절해보입니다.
하지만, 예상처럼 모든 객체에게 똑같은 값(1)만 내어주므로, 모든 객체가 해시테이블의 버킷 하나에 담겨 마치 연결 리스트(linked list)처럼 동작합니다.
그 결과, 평균 수행시간이 O(1)인 해시테이블이 O(n)으로 느려져서, 객체가 많아지면 도저히 쓸 수 없다고 합니다.
좋은 해시 함수라면, 서로 다른 인스턴스에 다른 해시코드를 반환합니다. 이것이 바로 hashCode의 세 번째 규약이 요구하는 속성입니다. 이상적인 해시 함수는, 주어신 (서로 다른) 인스턴스들을 32비트 정수 범위에 균일하게 분배하는 것입니다.
완벽히 실현하기는 어렵지만 비슷하게 만들기는 그다지 어렵지 않습니다.
다음은, 좋은 hashCode를 작성하는 간단한 요령입니다.
- int 변수 result를 선언한 후, 값 c로 초기화한다. 이때 c는 ㄹ해당 객체의 첫 번째 핵심 필드를 단게 2.a 방식으로 계산한 해시코드다.(여기서 핵심 필드란, equals 비교에 사용되는 필드를 말함)
- 해당 객체의 나머지 핵심 필드 f 각각에 대해 다음 작업을 수행한다.
a. 해당 필드의 해시코드 c를 계산한다.
- 기본 타입 필드라면, Type.hashCode(f)를 수행한다. 여기서 Type은 해당 기본 타입의 박싱클래스
- 참조 타입 필드면서 이 클래스의 equals 메서드가 이 필드의 equals를 재귀적으로 호출해 비교한다면, 이 필드의 hashCode를 재귀적으로 호출한다. 계산이 더 복잡해질 것 같은 경우, 이 필드의 표준형을 만들어, 그 표준형의 hashCode를 호출한다. 필드의 값이 null이면, 0을 사용한다.
- 필드가 배열이라면, 핵심 원소 각각을 별도 필드처럼 다룬다. 이상의 규칙을 재귀적으로 적용해 각 핵심 원소의 해시코드를 계산한 다음, 단계 2.b 방식으로 갱싱한다. 배열에 핵심 원소가 하나도 없다면 단순히 상수(0을 추천)를 사용한다. 모든 원소가 핵심 원소라면 Arrays.hashCode를 사용한다.
b. 단계 2.a에서 계산한 해시코드 c로 result를 갱신한다. 코드로는 다음과 같다.
result = 31 * result + c;
- result를 반환한다.
hashCode를 다 구현했다면, 이 메서드가 동치인 인스턴스에 대해 똑같은 해시코드를 반환할지 봅시다. 그리고 본인 직관을 검증할 단위 테스트로 작성합니다. (equals와 마찬가지로, AutoValue로 생성했다면 건너뛰어도 좋습니다.)
파생 필드, 즉 다른 필드로부터 주어진 필드는 해시코드 계산에서 제외해도 됩니다. 또한, equals 비교에 사용되지 않은 필드는 '반드시' 제외해야 합니다. 그렇지 않으면 hashCode 규약 두 번째를 어기게 될 수 있습니다.
단계 2.b의 곱셈 31 * result는, 필드를 곱하는 순서에 따라 result 값이 달라지게 합니다. 그 결과, 클래스에 비슷한 필드가 여러 개일 때 해시 효과를 크게 높여줍니다.
예를 들어, String의 hashCode를 곰셈 없이 구현한다면, 모든 anagram(구성하는 철자가 같고, 그 순서만 다른 문자열)의 해시코드가 같아집니다.
31을 사용하는 이유는, 전통적으로 전해져 오는데 바로 홀수이면서 소수이기 때문입니다. 만약 31이 아니라 짝수고, 오버플로가 발생한다면 정보를 잃을 수 있습니다. 시프트 연산과 같은 결과를 내기 때문입니다. 아무튼... 전통적으로 그래왔다고 합니다.
결과적으로 31을 이용하면 이 곱셈을 시프트 연산과 뺄셈으로 대체해 최적화할 수 있습니다.
이 요령을 PhoneNumber 클래스에 적용해보겠습니다.
@Override
public int hashCode() {
int result = Short.hashCode(areaCode);
result = 31 * result + Short.hashCode(prefix);
result = 31 * result + Short.hashCode(lineNum);
return result;
}좋은 hashCode를 만드는 요령처럼, 핵심 필드 3개만을 사용하여 간단한 계산만 수행합니다. 그 과정에 비결정적 요소는 전혀 없으므로, 동치인 PhoneNumber 인스턴스들은 같은 해시코드를 가질 것이 확실합니다. 자바 플랫폼 라이브러리의 클래스들이 제공하는 hashCode 메서드와 비교해도 손색이 없습니다. 단순하고, 빠르고, 서로 다른 전화번호들은 다른 해시 버킷들로 제법 훌륭히 분배합니다.
단, 해시 충돌이 더욱 적은 방법을 사용해야 한다면, 구아바의 com.google.common.hash.Hashing을 참고합니다.
Guava
Objects 클래스는 임의의 개수만큼 객체를 받아 해시코드를 계산해주는 정적 메서드인 hash를 제공합니다. 당장 드는 생각은, 이 메서드로 위의 예시를 한 줄로 구현할 수 있을 것 같습니다. 하지만 아쉽게도 속도는 더 느립니다. 입력 인수를 담기 위한 배열이 만들어지고, 기본 타입이 있다면 언박싱도 거쳐야하기 때문입니다.
성능에 민감하지 않다면, hash 메서드를 사용해도 좋을 수 있습니다.
아래는 PhoneNumber 클래스의 hashCode를 위와 같은 방식으로 구현한 예시입니다.
@Override
public int hashCode() {
return Objects.hash(lintNum, prefix, areaCode);
}클래스가 불변이고, 해시코드를 계산하는 비용이 크다면, 매번 새로 계산하기 보다는 캐싱을 고려해야 합니다. 이 타입의 객체가 주로 해시의 키로 사용될 것 같다면 인스턴스가 만들어질 때 해시코드를 계산해둬야 합니다. 해시의 키로 사용되지 않는 경우라면 hashCode가 처음 호출될 때 계산하는 지연 초기화 전략은 어떨까요?
필드를 지연 초기화하려면 그 클래스를 스레드 안전하게 만들도록 신경 써야합니다.(item. 83) PhoneNumber 클래스의 예시로 들어보겠습니다. 다만, hashCode 필드의 초기값은 생성되는 객체의 해시코드와는 달라야함에 유의해주세요.
@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);
}
return result;
}성능을 높인다고 해시코드를 계산할 때, 핵심 필드를 생략해서는 안됩니다.
속도는 빨라질 수 있지만, 해시 품질이 나빠져 해디테이블의 성능을 심각하게 떨어뜨릴 수 있습니다. 특히 어던 필드는 특정 영역에 몰린 인스턴스들의 해시코드를 넒은 범위로 고르게 퍼트려주는 효과가 있을지도 모릅니다. 하필 이런 필드를 생략한다면, 해당 영역의 수많은 인스턴스가 단 몇개의 해시코드로 집중되어 속도가 느려질 수 있습니다.
결론적으로, 이 따분한 일을 해결하기 위해서는 Item 10에서 소개한 AutoValue나, IDE의 기능을 이용하자는데, 원리를 정확히 알아 존재 이유를 알아야 합니다. 제목과 마찬가지로, equals을 재정의할 때, 어떤 이유로 hashCode로 재정의하는지 알아야 하는 이유처럼 말입니다.
회고
조금 부끄러운 말이지만, hashCode를 정확히 언제 어떻게 쓰는지 몰랐습니다.
간단히 command + n -> equals and hashCode -> 엔터 -> 엔터...
이러면 지금까지의 모든 문제는 해결되었으나, 정확히 어떤 방식으로 쓰이는지는 몰랐습니다. 무엇이든지 본질을 파고들고 원리를 이해하니, 더욱 더 쓰기에 자신감이 생기는 것 같달까요? 그런 포스팅이 된 것 같습니다 ㅎ
