toString을 항상 재정의하라

Object의 기본 toString 메서드가 우리가 작성한 클래스에 적합한 문자열을 반환하는 경우는 거의 없다. toString의 일반 규약에 따르면 ‘간결하면서 사람이 읽기 쉬운 형태의 유익한 정보’를 반환해야 한다. 그리고 모든 하위 클래스에서 이 메서드를 재정의해야 한다.
toString을 잘 구현한 클래스는 사용하기에 좋고, 그 클래스를 사용한 시스템을 디버깅하기 쉽다. toString 메서드는 우리가 직접 호출하지 않더라도 println, printf, 문자열 연결 연산자(+), assert 구문에 넘길 때, 혹은 디버거가 객체를 출력할 때 자동으로 불린다. toString을 제대로 재정의하지 않는다면 쓸모없는 메시지만 남을 것이다.

주요 정보를 반환하자

실전에서 toString은 그 객체가 가진 주요 정보 모두를 반환하는게 좋다. 하지만 객체가 거대하거나 객체의 상태가 문자열로 표현하기에 적합하지 않다면 무리가 있다. 이런 경우 요약 정보를 담아야 한다.

의도를 명확히 밝히자

포맷을 명시하든 아니든 toString의 의도를 주석으로 명확히 밝혀야 한다.

포맷을 명시한 경우

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

반환 값에 접근할 수 있는 API를 제공하자

포맷 명시 여부와 상관없이 toString이 반환한 값에 표함된 정보를 얻어올 수 있는 API를 제공해야 한다. 그렇지 않으면 toString의 반환값을 파싱할 수밖에 없다. 성능이 나빠지고, 필요하지도 않은 작업이다.

정적 클래스의 toString

정적 유틸리티 클래스는 toString을 제공할 이유가 없다. 또한 대부분의 열거 타입도 자바가 이미 완벽한 toString을 제공하니 따로 재정의하지 않아도 된다. 하지만 하위 클래스들이 공유해야 할 문자열 표현이 있는 추상 클래스라면 toString을 재정의해줘야 한다. 예컨대 대다수의 컬렉션 구현체는 추상 컬렉션 클래스들의 toString 메서드를 상속해 쓴다.

구글의 AutoValue 프레임워크와 대부분의 IDE는 equals, hashCode 외에 toString도 생성해준다. AutoValue는 각 필드의 내용을 멋지게 나타내 주기는 하지만 클래스의 의미까지 파악하지는 못 한다. 그래도 Object의 toString보다는 자동 생성된 toString이 훨씬 유용하다.

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

Twitter Facebook LinkedIn