Effective Java item 12

toString을 항상 재정의하라

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

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

toString 메서드는 객체를 println, printf, 문자열 연결 연산자(+), assert 구문에 넘길 때, 혹은 디버거가 객체를 출력할 때 자동으로 불린다.

• 실전에서 toString은 그 객체가 가진 주요 정보 모두를 반환하는 게 좋다. 하지만 객체가 거대하거나 객체의 상태가 문자열로 표현하기에 적합하지 않다면 무리가 있다.
• toString을 구현할 때면 반환 값의 포맷을 문서화할지 정해야 한다. 이는 아주 중요한 선택이다. 전화번호나 행렬 같은 값 클래스라면 문서화하기를 권한다. 포맷을 명시하면 그 객체는 표준적이고, 명확하고, 사람이 읽을 수 있게 된다.
• 단점도 있다. 포맷을 한번 명시하면 평생 그 포맷에 얽매이게 된다. 이를 사용하는 프로그래머들이 그 포맷에 맞춰 파싱 하고, 새로운 객체를 만들고, 영속 데이터로 저장하는 코드를 만들 것이다. 만약 향후 릴리즈에서 포맷을 바꾼다면 이를 사용하던 코드는 엉망이 될 것이다. 만약 포맷을 명시하지 않는다면 유연성을 얻게 된다.

포맷을 명시하든 아니든 여러분의 의도는 명확히 밝혀야 한다.

 

/**
* 이 전화번호의 문자열 표현을 반환한다.
* 이 문자열은 "XXX-YYY-ZZZZ" 형태의 12글자로 구성된다.
*/
@Override
public String toString() {
    return String.format("%03d-%3d-%04d", areaCode, prefix, lineNum);
}

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

 

 

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

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

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

핵심정리

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