toString을 항상 재정의하라

toString을 항상 재정의하라

이펙티브 자바에서 toString 메서드의 재정의에 관하여 알게된 점을 포스팅한다.

• Object의 기본 toString 메서드가 우리가 작성한 클래스에 적합한 문자열을 반환하는 경우는 거의 없다.
• 보통 PhoneNumber@abbbd처럼 단순히 클래스이름@16진수해시코드를 반환할 뿐이다.
• toString의 일반 규약에 따르면 ‘간결하면서 사람이 읽기 쉬운 형태의 유익한 정보’를 반환해야 한다. 따라서 모든 하위 클래스에서 이 메서드를 재정의해야한다. toString을 잘 구현한 클래스는 사용하기에 훨씬 좋고, 그 클래스를 사용한 시스템은 디버깅하기 쉽다.
• toString 메서드는 객체를 println, printf, 문자열 연결 연산자(+), assert 구문에 넘길 때, 혹은 디버거가 객체를 출력할 때 자동으로 불린다.

System.out.println(phoneNumber + "에 연결할 수 없습니다.");

• 실전에서 toString은 그 객체가 가진 주요 정보 모두를 반환하는 게 좋다. 하지만 객체가 거대하거나, 객체의 상태가 문자열로 표현하기에 적합하지 않다면 무리가 있다. 이런 상황이라면 “맨하튼 거주자 전화번호부(총 1000개)” 나 “Thread[main,5,main]” 같은 요약 정보를 담아야 한다.
• toString을 구현할 때면 반환값의 포맷을 문서화할지 정해야한다. 이것은 아주 중요한 선택이다. 포맷을 명시하기로 했다면, 명시한 포맷에 맞는 문자열과 객체를 상호 전환할 수 있는 정적 팩터리나 생성자를 함께 제공해주면 좋다. 좋은예로 BigInteger, BigDecimal과 대부분의 기본 타입 클래스가 여기 해당한다. 하지만 단점도 있다. 포맷을 한번 명시하면 평생 그 포맷에 얽매이게되고 향후 릴리즈에서 포맷을 바꾼다면 사용하던 코드들과 데이터들은 엉망이 될 것이다.
• 포맷을 명시하든 아니든 우리의 의도는 명확히 밝혀야 한다.

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

  // 포맷을 명시하지 않기로 한 경우
  /**
   * 상세형식은 정해지지 않았으며 향후 변경될 수 있다. 
   */
  @Override public String toString() {...}

• 포맷 명시 여부와 상관없이 toString이 반환한 값에 포함된 정보를 얻어올수 있는 API를 제공하자. 위 예제로 보면 PhoneNumber 클래스는 지역코드, 프리픽스, 가입자번호 접근자를 제공해야 한다.
• 정적 유틸리티 클래스나 대부분의 열거 타입도 자바가 이미 완벽한 toString을 제공하니 따로 재정의하지 않아도 된다. 하지만 하위 클래스들이 공유해야 할 문자열 표현이 있는 추상클래스라면 toString을 재정의해줘야 한다.

요약

• 모든 구체 클래스에서 Object의 toString을 재정의하자. 상위 클래스에서 이미 알맞게 정의한 경우는 예외이다.
• toString을 재정의한 클래스는 사용하기도 즐겁고, 클래스를 사용한 시스템을 디버깅하기 쉽게 해준다.
• toString은 해당 객체에 관한 명확하고 유용한 정보를 읽기 좋은 형태로 반환해야 한다.