기본 Object의 기본 toString 메서드는, 클래스_이름@16진수로_표시한_해시코드 만을 반환한다. 따라서 객체의 필드를 유용하게 알려주려면 모든 하위 클래스에서 toString 메서드를 재정의하자.
toString을 재정의하면 어떤 장점이 있을까?
바로 디버깅이 쉬워진다. toString 메서드는 객체를 println, printf, 문자열 연결 연산자 혹은 assert 구문 으로 넘길때, 그리고 디버거가 객체를 출력할 때 자동으로 불리게 되기 때문이다. 예를 들어, 작성한 객체를 참조하는 컴포넌트가 오류 메시지를 로깅할 때 자동으로 호출 할 수 있다.
System.out.println(phoneNumber + "에 연결할 수 없습니다.");
// 좋은 예 : {Jenny=707-1341-145351}
// 나쁜 예 : {Jenny=PhoneNumber@abbbd} ☁️ 좋은 toString 재정의하기
1. 객체가 가진 주요 정보 모두를 반환하라.
만약 객체가 거대하거나 객체의 상태가 문자열로 표현하기에 적합하지 않다면, 맨해튼 거주자 전화번호부(총 123개) 혹은 Thread[main,5,main] 같은 요약 정보를 담아야 한다.
다음의 테스트 실패 메시지는, toString에 주요 정보가 담기지 않았을 때 문제가 되는 대표적인 예다.
Assertion failure : expected {abc, 123}, but was {abc, 123}
2. 반환값의 포맷을 문서화 할지 정해라.
포맷을 명시하면 그 객체는 표준적이고, 명확하고, 사람이 읽을 수 있기 때문에 값 클래스라면 문서화하는 것이 좋다. 또한 포맷을 명시하기로 했다면, 명시한 포맷에 맞는 문자열과 객체를 상호 전환할 수 있는 정적 팩터리나 생성자를 함께 제공해주면 좋다.
하지만 한번 명시하면 평생 그 포맷에 얽매이게 되며, 반면 명시 하지 않았다면 향후 릴리스에서 정보를 더 넣거나 포맷을 개선할 수 있는 유연성을 얻을 수 있다.
/**
* 이 전화번호의 문자열 표현을 반환한다.
* 이 문자열은 "XXX-YYY-ZZZZ" 형태의 12글자로 구성된다.
* XXX는 지역 코드, YYY는 프리픽스, ZZZZ는 가입자 번호다.
* 각각의 대문자는 10진수 숫자 하나를 나타낸다.
*
* 전화번호의 각 부분의 값이 너무 작아서 자릿수를 채울 수 없다면,
* 앞에서부터 0으로 채워나간다. 예컨대 가입자 번호가 123이라면
* 전화번호의 마지막 네 문자는 "0123"이 된다.
*/
@Override public String toString() {
return String.format("%03d-%03d-%04d",
areaCode, prefix, lineNum);
}3. 정적 유틸리티 클래스, 열거 타입은 따로 재정의 하지 않아도 된다.
자바가 이미 완벽한 toString 을 제공하고 있기 때문이다.
단 주의할 점은, 하위 클래스들이 공유해야 할 문자열 표현이 있는 추상 클래스라면 toString 을 재정의 해야 한다. 실제로도 이미 대다수의 컬렉션 구현체는 추상 컬렉션 클래스들의 toString 메서드를 상속해서 쓰고 있다.
🔖 핵심 정리
모든 구체 클래스에서 Object의 toString을 재정의하자. 상위 클래스에서 이미 알맞게 재정의한 경우는 예외이다. toString을 재정의한 클래스는 사용하기도 즐겁고 그 클래스를 사용한 시스템을 디버깅하기 쉽게 해준다. toString은 해당 객체에 관한 명확하고 유용한 정보를 읽기 좋은 형태로 반환해야 한다.
