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

아이템 12

toString을 항상 재정의하라

Object의 기본 toString 메서드는 클래스이름@16진수로표시한_해시코드를 반환한다. PhoneNumber로 예를 들자면 PhoneNumber@adbbd와 같이 해시코드로 반환하는데, 간결하지만 707-867-5309와 같이 전화번호를 직접 알려주는 형태가 훨씬 유익한 정보를 담고 있다. 또한toString의 규약은 '모든 하위 클래스에서 이 메서드를 재정의하라'고 한다.

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() { ... }

주의사항

• 포맷 명시 여부와 상관없이 toString이 반환한 값에 포함된 정보를 얻어올 수 있는 API를 제공하자.
  예를 들어, PhoneNumber 클래스는 지역 코드, 프리픽스, 가입자 번호용 접근자를 제공해야 한다. 그렇지 않으면 이 정보가 필요한 프로그래머는 toString 반환값을 파싱할 수 밖에 없다.

• 정적 유틸리티 클래스는 toString을 제공할 이유가 없다.
  객체 상태 정보가 없고, 정적 함수만을 제공하는 클래스이기 때문이다.

• 열거 타입 클래스 또한 따로 재정의할 필요가 없다.
  자바가 완벽한 toString을 제공한다.

• 하위 클래스들이 공유해야 할 문자열 표현이 있는 추상 클래스라면 toString을 재정의해야 한다.

• AutoValue 프레임워크는 각 필드의 내용을 나타내주지만 클래스의 의미를 파악하지는 못한다.

• 자동 생성에 적합하지는 않더라도 객체의 값에 관해 아무것도 알려주지 않는 Object의 toString보다는 자동 생성된 toString이 훨씬 유용하다.

핵심 정리

모든 구체 클래스에서 Object의 toString을 재정의하자. toString을 재정의한 클래스는 디버깅하기 쉽게 해준다.