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

[Why]

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

 

[When]

• 모든 구체 클래스에서 Object의 toString을 재정의하자. 상위 클래스에서 이미 알맞게 재정의한 경우는 예외다.
• toString 메서드는 객체를 println, printf, 문자열 연결 연산자(+), assert 구문에 넘길 때, 혹은 디버거가 객체를 출력할 때 자동으로 불린다. toString을 제대로 정의하지 않는다면 쓸모없는 메시지(클래스_이름@16진수로_표시한_해시코드)만 로그에 남을 것이다.
• 정적 유틸리티 클래스는 toString을 제공할 이유가 없다.
• 대부분의 열거 타입아이템34도 자바가 이미 완벽한 toString을 제공하니 따로 재정의하지 않아도 된다.
• 하위 클래스들이 공유해야 할 문자열 표현이 있는 추상 클래스라면 toString을 재정의해줘야 한다.

 

[How]

• 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);
    }​

  • 포맷을 명시하면 그 객체는 표준적이고, 명확하고, 사람이 읽을 수 있게 된다.
  • 따라서 그 값 그대로 입출력에 사용하거나 CSV 파일처럼 사람이 읽을 수 있는 데이터 객체로 저장할 수도 있다.
  • 명시한 포맷에 맞는 문자열과 객체를 상호 전환할 수 있는 정적 팩터리나 생성자를 함께 제공해주면 좋다.
    BigInteger, BigDecimal과 대부분의 기본 타입 클래스가 따르는 방식이다.
  • (포맷을 명시하지 않기로 했을 때)

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

  • 포맷을 한번 명시하면 평생 그 포맷에 얽매이게 된다.
  • 이를 사용하는 프로그래머들이 그 포맷에 맞춰 작업해놓은 것들 때문에 향후 릴리스에서 포맷을 바꾸면 난리가 난다.
  • 포맷을 명시하지 않는다면 향후 릴리스에서 정보를 더 넣거나 포맷을 개선할 수 있는 유연성을 얻게 된다.
• 포맷 명시 여부와 상관없이 toString이 반환한 값에 포함된 정보를 얻어올 수 있는 API를 제공하자.
  그렇지 않으면 이 정보가 필요한 프로그래머는 toString의 반환값을 파싱할 수 밖에 없다. 성능이 나빠지고, 불필요한 작업이다.