Item 12. toString을 항상 재정의하라

  toString의 일반 규약에 따르면 '간결하면서 사람이 읽기 쉬운 형태의 유익한 정보'를 반환해야 합니다. 또한 toString의 규약은 "모든 하위 클래스에서 이 메서드를 재정의하라"고 합니다.

 

  실전에서 toString은 그 객체가 가진 주요 정보 모두를 반환하는 게 좋습니다. 하지만 객체가 거대하거나 객체의 상태가 문자열로 표현하기에 적합하지 않다면 요약 정보를 담아야 합니다.

 

  toString을 구현할 때면 반환값의 포맷을 문서화할지 정해야 합니다. 전화번호나 행렬 같은 값 클래스라면 문서화하기를 권합니다. 포맷을 명시하면 그 객체는 표준적이고, 명확하고, 사람이 읽을 수 있게 됩니다. 포맷을 명시하기로 했다면, 명시한 포맷에 맞는 문자열과 객체를 상호 전환할 수 있는 정적 팩터리나 생성자를 함께 제공해주면 좋습니다. 자바 플랫폼의 많은 값 클래스가 따르는 방식이기도 합니다. BigInteger, BigDecimal과 대부분의 기본 타입 클래스가 여기 해당합니다.

  단점도 있습니다. 포맷을 한번 명시하면 평생 그 포맷에 얽매이게 됩니다.

 

  포맷을 명시하든 아니든 의도는 명확히 밝혀야 합니다. 다음은 PhoneNumber 클래스에 toString 메서드를 추가한 코드입니다.

package effectivejava.chapter3.item12;

// PhoneNumber에 toString 메서드 추가
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, "가입자 번호");
    }

    ... 생략 ...

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

    public static void main(String[] args) {
        PhoneNumber jenny = new PhoneNumber(707, 867, 5309);
        System.out.println("제니의 번호: " + jenny);
    }
}

  포맷을 명시하지 않기로 했다면 다음처럼 작성할 수 있을 것입니다.

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

 

  정적 유틸리티 클래스(Item 4)는 toString을 제공할 이유가 없습니다. 또한, 대부분의 열거 타입(Item 34)도 자바가 이미 완벽한 toString을 제공하니 따로 재정의하지 않아도 됩니다. 하지만 하위 클래스들이 공유해야 할 문자열 표현이 있는 추상 클래스라면 toString을 재정의해줘야 합니다. 예컨대 대다수의 컬렉션 구현체는 추상 컬렉션 클래스들의 toString 메서드를 상속해 씁니다.

 

모든 구체 클래스에서 Object의 toString을 재정의하자.

상위 클래스에서 이미 알맞게 재정의한 경우는 예외다.

toString을 재정의한 클래스는 사용하기도 즐겁고 그 클래스를 사용한 시스템을 디버깅하기 쉽게 해준다.

toString은 해당 객체에 관한 명확하고 유용한 정보를 읽기 좋은 형태로 반환해야 한다.

 

[참고 정보]

이펙티브 자바 Effective Java 3/E 도서 [조슈아 블로크 저]

이펙티브 자바 깃허브 저장소

<이펙티브 자바, 3판> 번역 용어 해설