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

📍상황

• Object의 기본 toString 메서드가 우리가 작성한 클래스에 적합한 문자열을 반환하는 경우는 거의 없음
  • 단순히 클래스_이름@16진수로_표시한_해시코드 를 반환함
• toString의 일반 규약
  • '간결하면서 사람이 읽기 쉬운 형태의 유익한 정보'를 반환해야 함
  • 모든 하위 클래스에서 이 메서드를 재정의해야 함
• 장점 - toString을 잘 구현한 클래스는 디버깅하기 쉬움
  • toString 메서드는 객체를 println, printf, assert 구문에 넘길 때, 혹은 디버거가 객체를 출력할 때 자동으로 호출됨
    • 즉, 직접 호출하지 않더라도 다른 어딘가에서 쓰일 것임
  • toString을 제대로 재정의하지 않는다면 쓸모없는 메시지만 로그에 남을 것임

 

📍방법

1. toString은 그 객체가 가진 주요 정보 모두를 반환하는게 좋음

2. 포맷을 명시하든 아니든 의도를 명확히 밝혀야 함

/**
 * 이 전화번호의 문자열 표현을 반환한다.
 * 이 문자열은 "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() { ... }

3. toString이 반환한 값에 포함된 정보를 얻어올 수 있는 API를 제공하자 - getter

 

📍핵심 정리

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