12. toString을 항상 재정의하라

Object의 기본 toString 메서드가 우리가 작성한 클래스에 적합한 문자열을 반환하는 경우는 거의 없다

- 단순히 클래스_이름@16진수로 표시한_해시 코드를 반환

- toString의 일반 규약에 따르면 '간결하면서 사람이 읽기 쉬운 형태의 유익한정보' 를 반환한다

- toString의 규약은 "모든 하위 클래스에서 이 메서드를 재정의 한다"

 

toString을 잘 구현한 클래스는 사용하기에 훨씬 즐겁고, 그 클래스를 사용한 시스템은 디버깅이 쉽다

- toString 메서드는 객체를 println, printf 문자열 연결 연산자(+)

- assert 구문에 넘길 때 혹은 디버거가 객체를 출력할 때 자동으로 불린다

- toString을 재정의하지 않는다면 쓸모없는 메시지만 로그에 남는다

 

실전에서 toString은 그 객체가 가진 주요 정보 모두를 반환하는 게 좋다

- 하지만 객체가 거대하거나 객체의 상태가 문자열로 표현하기 적합하지 않다면 무리가 있다

- 이런 상황이라면 "맨해튼 거주자 전화번호부 (총 1487536개)" , "Thread [main,5, main]" 같은 요약 정보를 담는다

 

테스트 실패 메시지는 toString에 주요 정보가 담기지 않았을 때 문제가 되는 대표적인 예

Assertion failure: expected {abc, 123}, but was {abc, 123}.
// 단언 실패 : 예상 값 {abc, 123}, 실제값 {abc, 123}.

- toString을 구현할 때는 반환 값의 포맷을 문서화할지 정해야 한다

- 전화번호나 행렬 같은 값 클래스라면 문서화하기를 권한다

- 그 값을 그대로 입출력에 사용하거나 CSV 파일처럼 사람이 읽을 수 있는 데이터 객체로 저장할 수 있다

- 포맷을 명시했다면, 명시한 포맷에 맞는 문자열과 객체를 상호 전환할 수 있는 정적 팩토리나 생성자와 함께 제공

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

 

포맷을 명시하지 않기로 했다면 다음처럼 작성할 수 있다

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

 

포맷 명시 여부와 상관없이 toString이 반환한 값에 포함된 정보를 얻어올 수 있는 API를 제공하자

- PhoneNumber 클래스는 지역코드, 프리픽스, 가입자 번호용 접근자를 제공해야 한다

- 그렇지 않으면 이정보가 필요한 프로그래머는 toString의 반환 값을 파싱 할 수밖에 없다.

- 게다가 향후 포맷을 바꾸면 시스템이 망가지는 결과를 초래할 수 있다

- 접근자를 제공하지 않으면 그 포맷이 사실상 준-표준 API나 다름없다

 

정적 유틸리티 클래스는 toString을 제공할 이유가 없다

- 대부분의 열거 타입도 자바가 이미 완벽한 toString 제공하니 따로 재정의하지 않아도 된다

- 하지만 하위 클래스들이 공유해야 할 문자열 표현이 있는 추상 클래스라면 totring을 재정의해줘야 한다

- 예컨대 대다수의 컬렉션 구현체는 추상 컬렉션 클래스들의 toString 메서드를 상속해 쓴다

 

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