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

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

 

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

 

hashCode란? 

 

hashCode()는 자바의 Object 클래스에 정의된 메서드로, 객체의 해시 코드를 반환하는 역할을 한다.

 

해시 코드는 객체를 해시 테이블과 같은 자료구조에 저장하거나 검색하기 위해 사용된다.

 

hashCode() 메서드는 객체의 내부 상태를 기반으로 해시 코드를 생성한다.

 

서로 다른 객체는 다른 해시 코드를 가지지만, 같은 내부 상태를 가진 객체는 동일한 해시 코드를 갖는다.

 

따라서 hashCode()는 객체의 동등성 비교를 위해 사용되는 메서드인 equals()와 함께 사용된다.

 

해시 코드는 int 타입의 값을 반환하며, 동일한 객체에 대해서는 항상 같은 해시 코드를 반환해야 한다.

 

그러나 다른 객체에 대해서는 같은 해시 코드가 반환될 수 있다.

 

이러한 상황을 해시 충돌이라고 하며, 이를 최소화하기 위해 hashCode() 메서드는 객체의 내부 상태를 고려하여 고유한 해시 코드를 생성해야 한다.

 

일반적으로 자바에서는 hashCode()를 오버라이딩하여 객체의 내부 상태를 기반으로 한 적절한 해시 코드를 생성한다.

 

이는 객체를 해시 기반의 자료구조에 사용하거나, 컬렉션에서 객체를 검색하는 데에 도움을 준다.

 

 

아래는 해시코드 규약이다.

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

 

해시알고리즘이란?

https://kimfk567.tistory.com/147

[Java] 해시 알고리즘이란?

 

 

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

 

equals는 물리적으로 다른 두 객체를 논리적으로는 같다고 할 수 있다.

 

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

 

 

Map<PhoneNumver, String> m = new hashMap<>();

m.put(new PhoneNumber(707, 867, 5309), "제니");

 

 

이 다음 m.get( new PhoneNumber(707, 867, 5309) ) 를 실행하면 "제니"가 나와야 할 것 같지만, 실제로는 null을 반환한다.

 

여기에 2개의 PhoneNumber 인스턴스가 사용되었다.

 

하나는 HashMap에 "제니" 를 넣을 때 사용됐고, 두번째는 이를 꺼내려할 때 사용됐다.

 

Phonenumber 클래스는 hashCode를 재정의하지 않았기 때문에 논리적 동치인 두 객체가 서로 다른 해시코드를 반환하여 두 번째 규약을 지키지 못한다.

 

그 결과 get 메서드는 엉뚱한 해시 버킷에 가서 객체를 찾으려 한 것이다.

 

설사 두 인스턴스를 같은 버킷에 담았더라도 get 메서드는 여전히 null을 반환하는데,

 

HashMap은 해시코드가 다른 엔트리끼리는 동치성 비교를 시도조차 하지 않도록 최적화되어 있기 때문이다.

 

이 문제는 PhoneNumber에 적절한 hashCode 메서드를 작성해주면 해결된다.

 

 

 

 

public final class PhoneNumber {
    private final short areaCode, prefix, lineNum;

    public PhoneNumber(int areaCode, int prefix, int lineNum) {
        this.areaCode = rangeCheck(areaCode, 999, "area code");
        this.prefix   = rangeCheck(prefix,   999, "prefix");
        this.lineNum  = rangeCheck(lineNum, 9999, "line num");
    }

    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;
    }

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

    // hashCode 없이는 제대로 동작하지 않는다. 다음 셋 중 하나를 활성화하자.

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

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

    // 해시코드를 지연 초기화하는 hashCode 메서드 - 스레드 안정성까지 고려해야 한다. (71쪽)
    private volatile int hashCode; // 자동으로 0으로 초기화된다.

    @Override public int hashCode() {
        if (this.hashCode != 0) {
            return hashCode;
        }

        synchronized (this) {
            int result = 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;
        }
    }

    public static void main(String[] args) {
        Map<PhoneNumber, String> m = new HashMap<>();
        m.put(new PhoneNumber(707, 867, 5309), "제니");
        System.out.println(m.get(new PhoneNumber(707, 867, 5309)));
    }

 

적절한 hashCode를 만드는 방식이다.

 

31을 곱하는 이유는 31이 홀수이면서 소수이기 때문에, 가장 적은 해시충돌이 발생한다는 연구 결과가 있어서, 전통적으로 31을 사용한다고 한다.

 

!해시코드를 계산할 때는 스레드 안정성을 생각해야 한다.

!해시코드를 계산할 때 핵심 필드를 생략해서는 안된다.