[도서] Effective Java - Item 12. toString을 항상 재정의하라.

이펙티브 자바 3판을 읽으면서 내용을 정리하는 포스트입니다. 혹시 틀린 부분이나 잘 못 설명한 부분이 있으면 댓글로 남겨주시면 수정하도록 하겠습니다.

Item 12. toString을 항상 재정의하라.

toString 메소드의 일반 규약은 간결하면서 사람이 읽기 쉬운 형태의 유익한 정보를 반환해야 한다. 하지만 우리가 확인 가능한 것은 클래스이름과 16진수로 표현된 해시코드 뿐이다.

우리는 toString을 재정의하여 디버깅 및 정보 가시성을 높여야 한다.

toString을 재정의 할 때는 객체 스스로를 완벽히 설명하는 문자열이어야 하고, 객체가 가진 주요 정보를 모두 반환하는 것이 좋다.

포맷이 정해져 있는 경우, 재정의하고 주석을 달아서 문서화를 해주면 더욱 정보를 보기 쉽다.

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

포맷이 정해지지 않더라도 대략적인 설명을 주석으로 명시하면 좋다.

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

toString 반환값 문서화을 문서화할 때는 의도를 명확히 밝혀야 한다. 또한 포맷 명시 여부와 상관없이 toString이 반환값에 포함된 정보를 얻어올 수 있는 API를 제공해야 하는데 포맷을 문서화 했을 경우 그 값을 그대로 입출력에 사용하거나 사람이 읽을 수 있는 데이터 객체로 저장할 수 있다.

toString을 항상 재정의해야 하는 것은 아니다. 정적 유틸리티 클래스는 toString을 제공할 이유가 없고, 대부분의 열거 타입도 자바가 이미 완벽한 toString을 제공하니 따로 재정의 할 필요가 없다. 하지만 하위 클래스들이 공유해야 할 문자열 표현이 있는 추상 클래스라면 toString을 재정의해줘야 한다.

각 클래스가 가진 데이터에 따라 자동 생성 toString이 적합할 수도 있고 그렇지 않을 수도 있지만 객체의 값에 관해 알려주지 않는 Object의 toString 보다는 자동 생성된 toString이 훨씬 유용하기 때문에 재정의 하는 편이 좋다.