[이펙티브 자바 3판] 3장. 모든 객체의 공통 메서드

[Effective Java 3th Edition] Chapter3: Methods Common to All Objects

#java #effectivejava


목록


아이템 10. equals는 일반 규약을 지켜 재정의하라

Obey the general contract when overriding equals

먼저, 결론은 재정의하지 않고 아래의 기본 equals 메서드를 사용한다.

public boolean equals(Object obj) {
    return (this == obj);
}

특히 아래와 같은 상황에서는 재정의하지 않는 것이 최선일 수 있다.

첫 번째로, 값을 표현하는 것이 아니라 동작하는 개체를 표현하는 클래스인 경우를 생각할 수 있다. Object의 equals 메서드로도 충분한 경우인데 예를 들어 Thread 클래스가 있다. 인스턴스가 가지는 값보다 동작하는 개체임을 나타내는 것이 더 중요하다.

두 번째로 논리적 동치성(logical equality)을 검사할 필요가 없는 경우에도 재정의하지 않는 것이 좋다. 예를 들어서 두 개의 랜덤(Random) 객체가 같은 난수열을 만드는지 확인하는 것은 의미가 없다. 마지막으로 private이나 패키지 전용 클래스라서 클래스의 equals 메서드가 절대 호출되지 않아야하는 경우에 해당한다. 이런 경우에는 equals 메서드를 반드시 오버라이드(override)해서 호출되지 않도록 막아야 한다.

꼭 필요한 경우가 아니면 equals를 재정의하지 말자.


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

Always override hashCode when you override equals

equals 메서드를 재정의한 클래스 모두에서 hashCode도 재정의해야 한다. 그렇지 않은 경우에는 hashCode의 일반 규약을 어기게 되므로 해당 클래스의 인스턴스를 HashMap이나 HashSet 같은 컬렉션의 원소로 사용할 때 문제를 일으키게 된다.

아래는 Object 클래스의 명세에서 발췌한 hashCode 관련 규약이다.

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

여기서 hashCode 재정의를 잘못했을 때, 크게 문제가 되는 것은 두 번째 규약이다. 즉, 논리적으로 같은 객체는 같은 해시값을 반환해야 한다. equals(Object) 메서드의 호출 결과가 false인 두 객체들의 hashCode 값이 최대한 다르게 나오도록 hashCode 메서드를 오버라이드 해야 한다. 구현 후에는 동치인 인스턴스에 대해 똑같은 해시코드를 반환하는지 단위 테스트가 필요하다.

좋은 hashCode 메서드를 작성하는 방법

좋은 해시 함수라면 서로 다른 인스턴스에 대해서 다른 해시코드를 반환한다. 이상적인 해시 함수는 주어진 인스턴스들을 32비트 정수 범위에 균일하게 분배해야 한다.

  1. int 변수 result를 선언한 후 아래 2의 방법으로 계산한 해시코드 값으로 초기화한다.
  2. Type.hashCode, Arrays.hashCode 등을 사용하여 각 필드에 대한 해시코드 값을 구한다.
  3. 1에서 선언한 result 값을 result = 31 * result * c; 처럼 갱신한다. 그리고 반환한다.
    • 31인 이유는 홀수이면서 소수이다. 숫자가 짝수이고 오버플로우가 발생한다면 정보를 잃게 된다.
  4. 추가적으로 equals 비교에 사용되지 않는 필드는 해시코드 계산 로직에서 반드시 제외해야 한다.

간단한 한 줄짜리 hashCode 메서드

Objects 클래스의 정적 메서드 hash를 이용하는 방법이다. 임의의 개수만큼 객체를 받아 해시코드를 계산해준다. 이 메서드를 활용하면 앞에서 구현한 코드와 비슷한 수준의 hashCode 함수를 단 한 줄로 작성할 수 있다.

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

하지만 속도가 상대적으로 더 느리다. 입력 인수를 담기 위한 배열이 필요하고 입력 값 중에 기본 타입(Primitive Type)이 있다면 박싱(Boxing)과 언박싱(UnBoxing)도 필요하다.

해시코드를 지연 초기화(lazy initialization)하는 방법

클래스가 불변이고 해시코드를 계산하는 비용이 너무 크다면 매번 새로 계산하는 것보다는 캐쉬 처리하는 방식을 고려하면 좋다. 지연 초기화를 통해 캐쉬 처리하면 유용한데 필드를 지연 초기화하려면 스레드 안전성까지 고려해야 한다. 아래는 해시코드를 지연 초기화하는 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;
}

실무에서 권장하는 방법

실무에서는 HashCodeBuilder@EqualsAndHashCode를 사용하는 것을 추천한다.

// HashCodeBuilder
public int hashCode() {
    return HashCodeBuilder.reflectionHashCode(this);
}

@EqualsAndHashCode 어노테이션은 클래스에 추가해주면 된다. equals 메서드와 hashCode 메서드를 생성해주는데, static과 transient가 아닌 모든 필드들이 대상이 된다.

@EqualsAndHashCode
public class Example {
    private transient int transientVal = 10;
    private String name;
    private int id;
}

주의사항

성능을 높이기 위해 해시코드를 계산할 때 핵심 필드를 생략해서는 안된다. 속도는 빨라지겠지만 해시테이블의 성능을 심각하게 떨어뜨릴 수 있다. 그리고 equals 비교에 사용되지 않은 필드는 hashCode 에서도 반드시 제외해야 한다. 끝으로 hashCode가 반환하는 값의 생성 규칙을 API 사용자에게 공개해서는 안된다. 이를 사용하는 개발자가 이 값에 의지하지 않고 추후에 계산 방식을 바꿀 수도 있다. 그렇게 되면 차후에 계산 방식을 바꾸려고 할 때 문제가 될 수 있다.

equals를 재정의할 때는 hashCode도 반드시 재정의해야 한다.


아이템 12. toString을 항상 재정의하라

Always override toString

toString 메서드는 간결하고 읽기 쉬운 형태의 유익한 정보를 반환해야 한다. 이를 잘 구현한 클래스는 사용하기 좋고 디버깅을 쉽게 해준다.

좋은 toString 재정의 방법

  • 객체가 가진 주요 정보 모두를 반환해야 한다.
  • 주석으로 toString이 반환하는 포맷을 명시하든 아니든 의도를 명확하게 해야 한다.
  • toString이 반환한 값에 포함된 정보를 얻어올 수 있는 API를 제공하자.
    • 없다면 이 정보가 필요한 개발자는 toString의 반환값을 파싱할 수 밖에 없다.

toString 재정의가 필요 없는 경우

  • 대부분의 정적 유틸리티 클래스
  • 대부분의 열거(enum) 타입
  • 수퍼 클래스에서 이미 적절하게 재정의한 경우

실무에서는 ToStringBuilder을 추천

apache-commons-lang3 라이브러리를 사용하면 간편하게 toString 포맷을 이용할 수 있습니다.

public String toString() {
    /*
     * 두 번째 인자를 변경하여 포맷을 바꿀 수 있다.
     * ToStringStyle.JSON_STYLE 등
     */
    return ToStringBuilder.reflectionToString(this, ToStringStyle.MULTI_LINE_STYLE);
}
toString은 해당 객체에 관해 명확하고 유용한 정보를 반환해야 한다.


아이템 13. clone 재정의는 주의해서 진행하라

Override clone judiciously

Cloneable은 복제해도 되는 클래스임을 명시하는 용도의 믹스인 인터페이스(mixin interface)이다. 하지만 의도한 목적에 조금 어긋난다. clone 메서드가 선언된 곳이 Cloneable이 아닌 Object 클래스이고 그마저도 protected 접근 지정자이다. Cloneable 인터페이스는 메서드도 하나 없지만, Object 클래스의 clone의 동작 방식을 결정한다.

package java.lang;

public interface Cloneable {
    // 아무 것도 없음
}

Cloneable을 구현한 클래의 인스턴스에서 clone 메서드를 호출하면, 객체의 필드들을 모두 복사한 객체를 반환하고 구현하지 않은 클래스의 인스턴스에서 호출하면 예외를 던진다.

‘복사’의 일반적인 의도

  • x.clone() != x 필수로 참이어야 한다.
  • x.clone().getClass() == x.getClass() 필수는 아니다.
  • x.clonde().equals(x) 필수는 아니다.

clone 메서드를 조작하는 경우 하위 클래스에서 의도하지 않은 결과를 받을 수 있음으로 주의해야 한다. 클래스 B가 클래스 A를 상속한다고 할 때, 하위 클래스인 B의 clone 메서드는 B 타입 객체를 반환해야 한다. 그런데 클래스 A의 clone이 자신의 생성자로 생성한 객체를 반환한다면, 클래스 B의 clone도 A 타입 객체를 반환할 수 밖에 없다. 그렇기 때문에 super.clone을 연쇄적으로 호출하도록 구현하면, 의도와 알맞는 객체를 만들 수 있다.

clone 보다는 복사 생성자와 복자 팩터리를 사용하자.

Cloneable을 복잡하게 사용할 필요가 없으니 다른 방식으로 하는 것도 좋다. 복사 생성자와 복사 팩터리를 사용하면 clone 방식의 단점에서 자유롭다.

// 복사 생성자
public MadPlay(MadPlay madPlay) { 
    // ...
};

// 복사 팩터리
public static MadPlay newInstance(MadPlay madPlay) {
    // ...
};

배열을 제외하고 복제 기능은 생성자와 팩터리를 이용하는 게 최고다


아이템 14. Comparable을 구현할지 고려하라

Consider implementing Comparable

Comparable 인터페이스의 메서드는 CompareTo 뿐이다. Comparable 인터페이스를 구현(implements)했다는 것은 그 클래스의 인스턴들에는 자연적인 순서가 있음을 뜻한다. Object 클래스의 equals와 비슷하지만 단순 동치성 비교와 순서도 비교할 수 있으며 제네릭하다.

compareTo 메서드의 일반 규약

  • 이 객체와 주어진 객체의 순서 비교
    • 이 객체가 주어진 객체보다 작으면 음의 정수를 반환한다.
    • 이 객체가 주어진 객체와 같으면 0을 반환한다.
    • 이 객체가 주어진 객체보다 크면 양의 정수를 반환한다.
    • 이 객체와 비교할 수 없는 타입의 객체면 ClassCastException 예외를 던진다.

아래 설명에서의 sgn(표현식) 표기는 수학에서 말하는 부호 함수(signum function)이며, 표현식의 값이 음수, 0, 양수일때 -1, 0, 1을 반환하도록 정의했다.

  • 대칭성: Comparable을 구현한 클래스는 모든 x, y에 대해 sng(x.compareTo(y)) == -sgn(y.compareTo(x)) 이다.
  • 추이성: Comparable을 구현한 클래스는 x.compareTo(y) > 0 && y.compareTo(z)이면, x.compareTo(z) > 0 이다.
  • 반사성: Comparable을 구현한 클래스는 모든 z에 대해 x.compareTo(y) == 0이면, sgn(x.compareTo(z)) == sgn(y.compareTo(z)) 이다.
  • 동치성: 필수는 아니지만 좋기면 좋다. (x.compareTo(y) == 0) == (x.equals(y)) 여야 한다.
    • Comparable을 구현했지만 이 사항을 지키지 않은 모든 클래스는 그 내용을 명시하면 좋다.

compareTo 메서드 작성법

equals와 비슷하지만 몇 가지 차이점이 있다.

  • 인자의 타입을 확인한다거나 형변환할 필요가 없다. 제네릭 인터페이스이기 때문이다.
    • 타입이 잘못됐다면 컴파일 시점에 오류가 발생한다. null을 입력한 경우 NullPointerException 예외를 던져야 한다.
  • 각 필드가 동치인지를 비교하는 게 아니라 그 순서를 비교한다.
  • 객체 참조 필드를 비교하려면 compareTo 메서드를 재귀적으로 호출한다.
  • Comparable을 구현하지 않은 필나 표준이 아닌 순서로 비교해야 한다면 비교자(Comparator)를 대신 사용한다.
    • 직접 만들거나 자바에서 제공하는 것을 골라서 사용한다.
  • 자바 7부터는 기본 정수 타입을 비교할 때 관계 연산자 <와> 을 사용하지 않고 compare를 사용하라.
  • 핵심적인 피륻부터 비교한다. 비교 결과가 바로 나온다면, 즉 순서가 바로 결정되면 거기서 결과를 곧바로 반환하자.

Comparator 인터페이스

자바 8부터는 Comparator 인터페이스가 많은 비교자 생성 메서드를 갖게 되었다. 간결하게 사용할 수 있지만 약간의 성능 저하도 있다.

private static final Comparator<User> COMPARATOR =
    comparingInt((User user) -> user.age)
        .thenComparingInt(user -> user.id);

public int compareTo(User user) {
    return COMPARATOR.compare(this, user);
}
순서를 고려해야 하는 값 클래스를 작성한다면 Comparable 인터페이스를 구현하자.