[이펙티브자바 - 아이템12] toString을 항상 재정의하라

3장. 모든 객체의 공통 메서드 - GOAL

Object를 상속하는 클래스는 일반 규약에 맞게 재정의해야 하는데, 언제 어떻게 재정의해야 하는지 알아보자

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

toString 의 규약은 '모든 하위 클래스에서 이 메서드를 재정의하라' 이다.
toString을 잘 구현한 클래스는 사용하기에 훨씬 즐겁고, 그 클래스를 사용한 시스템은 디버깅하기 쉽다.
toString메서드는 객체를 println, printf, 문자열 연결 연산자(+), assert 구문에 넘길 때, 혹은 디버거가 객체를 출력할 때 자동으로 불린다. 이를 제대로 재정의하지 않는다면 쓸모없는 메시지만 로그에 남을 것이다.

실전에서의 toString

1. 객체가 가진 주요 정보 모두를 반환하는게 좋다.

하지만 객체가 거대하거나, 문자열로 표현하기에 적합하지 않다면 무리가 있다. 이런 상황일 때는 스스로를 완벽히 설명하는 요약정보를 담아야한다. (ex.거주자 전화번호 총 14939393개)

2. toString을 구현할 때면, 반환값의 포맷을 문서화할지 정해야 한다.

포맷을 명시하면 그 객체는 표준적이고, 명확하고, 사람이 읽을 수 있게 된다.
단점은 그 포맷이 자주 쓰인다면, 포맷에 얽매이게 된다는 것이다.

3.포맷을 명시하든 아니든, 의도는 명확히 밝혀야 한다. 포맷을 명시하려면 아주 정확하게 해야한다.

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

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

예를 들어 PhoneNumber클래스는 지역코드, 프리픽스, 가입자 번호용 접근자를 제공해야한다. 그렇지 않으면 toString값을 파싱하는 수밖에 없다.

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

열거타입도 자바가 toString을 제공하니 따로 재정의하지 않아도 된다.

결론

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