[Effective Java] 모든 객체의 공통 메서드 上

10. equals는 일반 규약을 지켜 재정의

equals를 재정의하는 경우는 ...
👉 두 객체가 물리적으로 같은지(객체 식별성)가 아니라 논리적 동치성을 확인해야 하는데, 상위 클래스의 equals가 논리적 동치성을 비교하도록 재정의되지 않을 때 

 

✳️ 일반 규약 

• 대칭성 : x.equals(y)가 true이면, y.equals(x)도 true
• 추이성 : x.equals(y)가 true이고, y.equals(z)도 true이면, x.equals(z)도 true
• 일관성 : x.equals(y)를 반복해서 호출하면 항상 true 또는 false 반환

---

✳️ equals 메서드 구현 방법

• == 연산자 사용해 입력이 자기 자신의 참조인지 확인 👉 자기 자신이면 true 반환
• instanceof 연산자로 입력이 올바른 타입인지 확인
• 입력을 올바른 타입으로 형변환
• 입력 객체와 자기 자신의 대응되는 핵심 필드들이 모두 일치하는지 하나씩 검사
• Object 외의 타입을 매개변수로 받는 equals 메서드 선언 X 👉@Override 어노테이션을 사용해 실수 예방

public 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)) { // instanceof로 타입 확인 
        	return false;
        }

        PhoneNumber pn = (PhoneNumber) o; // 형변환
        // 핵심 필드 일치하는지 확인
        return pn.lineNum == lineNum && pn.prefix == prefix
                && pn.areaCode == areaCode;
    }
}

✨ 꼭 필요한 경우가 아니면 equals 재정의 X
✨ AutoValue 프레임워크를 사용해 클래스에 어노테이션 하나만 추가하여 equals 작성하고 테스트하는 일 ↓

 

 

11. equals를 재정의할 때, 반드시 hashCode도 함께 재정의

HashMap, HashSet과 같은 컬렉션에서 올바르게 동작하도록 하기 위함

 

✨ HashCode란 ? 

👉 객체를 식별하는 하나의 정수값으로, Object의 hashCode() 메서드는 객체의 메모리 주소를 이용해서 해시 코드를 만들어 반환하므로 객체마다 고유의 값을 가지고 있음 

 

✳️ Object에서의 HashCode 관련 규약

• equals 비교에 사용되는 정보가 변경되지 않았다면, 그 객체의 hashCode 메서드는 일관되게 항상 같은 값 반환
• equals(Object)가 두 객체를 같다고 판단했다면, 두 객체의 hashCode는 똑같은 값 반환
• equals(Object)가 두 객체를 다르다로 판단했다면, 두 객체의 hashCode가 서로 다른 값을 반환할 필요 X 👉 단, 다른 값을 반환해야 해시테이블 성능이 좋아짐 

 

✳️ 좋은 hashCode 작성하기

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

// 한 줄짜리 메서드 -> 성능 👎
@Override
public int hashCode() {
    return Objects.hash(lineNum,prefix,areaCode);
}

👆 입력 인수를 담기 위한 배열이 만들어지고, 입력 중 기본 타입이 있다면 박싱과 언박싱을 거쳐야하므로 속도 느림 

// 해시코드를 지연 초기화하는 메서드 - 스레드 안정성까지 고려해야 함
private int hashCode; //자동으로 0으로 초기화

@Override
public int hashCode() {
    int result = hashCode; 
    if(result == 0) {
        int result = Integer.hashCode(areaCode);
        result = 31 * result + Integer.hashCode(areaCode);
        result = 31 * result + Integer.hashCode(areaCode);
        hashCode = result;
    }
    return result;
}

 

✨ 지연 초기화란 ? 

👉 필요할 때까지 객체나 값의 초기화를 미룸으로써 성능 최적화 및 자원 절약 

// 지연 초기화 X 객체 생성
public class DataLoader {
    private HeavyResource resource = new HeavyResource(); // 객체 생성 시 즉시 초기화

    public void loadData() {
        // 무거운 작업을 수행하는 객체를 사용
        resource.doSomething();
    }
}

// 지연 초기화 적용
public class DataLoader {
    private HeavyResource resource; // 아직 초기화하지 않음

    public void loadData() {
        if (resource == null) { // 처음으로 사용될 때만 초기화
            resource = new HeavyResource();
        }
        resource.doSomething();
    }
}

 

 

12. toString 항상 재정의 필요 

간결하면서 사람이 읽기 쉬운 형태의 유익한 정보 반환
👉 모든 하위 클래스에서 재정의 ! (상위 클래스에서 이미 재정의한 경우는 예외)

 

• 컬렉션처럼 인스턴스를 포함하는 객체에서 유용하게 사용됨
• 객체가 가진 주요 정보 모두를 반환하는 것이 좋음 (거대하거나 문자열로 표현하기 적합하지 않다면 요약정보 담기)
• 하위 클래스들이 공유해야할 문자열 표현이 있는 추상 클래스라면 재정의 필요 !
• 반환값의 포맷을 문서화할지 결정 (전화번호나 행렬 값은 값)

 

✴️ 포맷 명시한 경우

/**
* 이 전화번호의 문자열 표현을 반환한다.
* 이 문자열은 "XXX-YYY-ZZZZ" 형태의 12글자로 구성된다.
* XXX는 지역코드, YYY는 프리픽스, ZZZZ는 가입자 번호다.
* 각각의 대문자는 10진수 숫자 하나를 나타낸다.
* 
* 전화번호의 각 부분의 값이 너무 작아서 자릿수를 채울 수 없다면,
* 앞에서부터 0으로 채워나간다. 예컨데 가입자 번호가 123이라면
* 전화번호의 마지막 네 문자는 "0123"이 된다.
*/
@Override 
public String toString() {
    return String.format("%03d-%03d-%04d", areaCode, prefix, lineNum);
}

 

✴️ 포맷 명시하지 않은 경우

/**
* 이 약물에 관한 대략적인 설명을 반환한다.
* 다음은 이 설명의 일반적인 형태이나,
* 상세 형식은 정해지지 않았으며 향후 변경될 수 있다.
* 
* "[약물 #9: 유형-사랑, 냄새=테러빈유, 겉모습=먹물]"
*/
@Override
public String toString() { ... }