Object의 기본 toString 메소드는 PhoneNumber@adbbd처럼 단순히 클래스_이름@16진수로_표시한_해시코드를 반환한다. PhoneNumber 클래스의 경우 707-867-5309처럼 전화번호를 직접 알려주는 형태가 훨씬 유익한 정보를 담고 있다. toString의 규약은 "모든 하위 클래스에서 이 메소드를 재정의하라"고 하는데, '간결하면서 사람이 읽기 쉬운 형태의 유익한 정보'를 반환하기 위해서이다.
toString을 잘 구현한 클래스는 사용하기에 훨씬 즐겁고, 그 클래스를 사용한 시스템은 디버깅하기 쉽다. toString 메소드는 객체를 println, printf, 문자열 연결 연산자(+), assert 구문에 넘길 때, 혹은 디버거가 객체를 출력할 때 자동으로 불린다. 따라서 toString을 제대로 재정의했다면 다음 코드만으로 문제를 진단하기에 충분한 메시지를 남길 수 있다.
|
1
|
System.out.println(phoneNumber + "에 연결할 수 없습니다.");
|
cs |
실전에서 toString은 그 객체가 가진 주요 정보 모두를 반환하는 게 좋다. 하지만 객체가 거대하거나 객체의 상태가 문자열로 표현하기에 적합하지 않다면, "맨허튼 거주자 전화번호부(총 1487536개)"나 "Thread[main,5,main]" 같은 요약 정보를 담아야 한다. 이상적으로는 스스로를 완벽히 설명하는 문자열이어야 한다.
toString을 구현할 때면 반환값의 포맷을 문서화할지 정해야 한다. 포맷을 명시하면 그 객체는 표준적이고, 명확하고, 사람이 읽을 수 있는 데이터 객체로 저장할 수도 있다. 포맷을 명시하기로 했다면, 명시한 포맷에 맞는 문자열과 객체를 상호 전환할 수 있는 정적 팩토리나 생성자를 함께 제공해주면 좋다. BigInteger, BigDecimal 등 자바 플랫폼의 대부분의 기본 타입 클래스가 따르는 방식이기도 하다.
포맷을 명시하든 아니든 여러분의 의도는 명확히 밝혀야 한다. 포맷을 명시하려면 아주 정확하게 해야 하고, 명시하지 않기로 했어도 마찬기지이다. 이는 toString 메소드에 주석의 형태로 나타낼 수 있다.
포맷 명시 여부와 상관없이 toString이 반환한 값에 포함된 정보를 얻어올 수 있는 API를 제공하자. 예컨대 PhoneNumber 클래스는 지역 코드, 프리픽스, 가입자 번호용 접근자를 제공해야 한다. 그렇지 않으면 toString의 반환값을 파싱할 수 밖에 없으므로, 성능은 나빠지고, 필요하지도 않은 작업이다.
정적 유틸리티 클래스와 대부분의 열거 타입은 자바가 이미 완벽한 toString을 제공하니 따로 재정의할 이유가 없다. 하지만 하위 클래스들이 공유해야 할 문자열 표현이 있는 추상 클래스라면 toString을 재정의해줘야 한다. 예컨대 대다수의 컬렉션 구현체는 추상 컬렉션 클래스들의 toString 메소드를 상속해 쓴다.
모든 구체 클래스에서 Object의 toString을 재정의하자. 상위 클래스에서 이미 알맞게 재정의한 경우는 예외다. toString을 재정의한 클래스는 사용하기도 즐겁고 그 클래스를 사용한 시스템을 디버깅하기 쉽게 해준다. toString은 해당 객체에 관한 명확하고 유용한 정보를 읽기 좋은 형태로 반환해야 한다.