Effective Java - 아이템 12: toString을 항상 재정의하라

최대 1 분 소요

Object의 기본 toString은 PhoneNumber@adbbd 처럼 단순히 {클래스이름}@{16진수}로 표시한 해시코드를 반환할 뿐이다.
toString의 일반 규약에 따르면 간결하면서 사람이 읽기 쉬운 형태의 유익한 정보를 반환해야 한다.

toString의 규약

모든 하위 클래스에서 이 메서드를 재정의하라
toString을 잘 구현한 클래스와 시스템은 디버깅하기 쉽다.
toString을 제대로 재정의하지 않는다면 쓸모없는 메시지만 로그에 남을 것이다.
실전에서 toString은 그 객체가 가진 주요 정보를 모두 반환하는 게 좋다.

포맷

toString을 구현할 때면 반환값의 포맷을 문서화할지 정해야 한다.
포맷을 명시하면 그 객체는 표준적이고, 명확하고, 사람이 읽을 수 있게 된다.
포맷을 명시한다면, 명시한 포맷에 맞는 문자열과 객체를 상호 전환할 수 있는 정적 팩터리나 생성자를 함께 제공해주면 좋다.
포맷 사용시 단점은, 자주 사용되는 클래스의 경우 평생 그 포멧에 얽매이게 된다.
포맷을 명시하든 아니든 의도는 명확히 밝혀야 한다. 포맷 명시 여부와 상관 없이 toString이 반환한 값에 포함된 정보를 얻어올 수 있는 API를 제공하자.

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

핵심 정리

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

댓글남기기