toString을_항상_재정의하라_폰드.md

toString을 항상 재정의하라

toString의 규약

• 간결하면서 사람이 읽기 쉬운 형태의 유익한 정보 반환
• 모든 하위 클래스에서 이 메서드를 재정의하라

당위성

• toString을 잘 구현한 클래스는 디버깅하기 쉽다
  • 객체를 println,printf,문자열 연결 연산자, assert구문에 넘길 때, 디버거가 객체를 출력할 때 자동으로 불린다.
  • 직접 호출하진 않더라도 다른 어딘가에서 쓰일 테니 재정의 하라.

사용 방법

• 객체가 가진 주요 정보 모두를 반환하는 게 좋다.
• 객체가 너무 거대하거나, 객체의 상태가 문자열로 표현하기 적합하지 않다면 요약 정보를 담는다.

문서화

• 반환값의 포맷을 문서화 할지 정한다.
  • 포맷에 맞는 문자열과 객체를 상호 전환 할 수 있는 정적 팩터리나 생성자를 함께 제공해주면 좋다.
  • 포맷을 한번 명시하면, 포맷 평생 얽매이게 된다는 단점도 있다.
  • 포맷을 명시하든 아니든 의도는 명확히 밝혀야 한다.

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

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

• 포맷 명시 여부와 상관없이 toString이 반환한 값에 포함된 정보를 얻어올 수 있는 API를 제공하자.
  • 제공되지 않는다면, 반환값을 파싱해서 얻어야 하므로, 성능도 나빠지고 불필요한 작업을 하게 된다.

기타

• 정적 유틸리티 클래스는 toString을 제공할 이유가 없다.
• 열거 타입은 이미 완벽한 toString을 제공.