공부 기록

Object의 기본 toString 메서드는 단순히 클래스이름@16진수해시코드를 반환한다.

toString의 일반 규약에 따르면 `간결하면서 사람이 읽기 쉬운 형태의 유익한 정보`를 반환해야 한다.

또한 toString의 규약에서는 `모든 하위 클래스에서 이 메서드를 재정의하라`고 한다.

toString을 잘 구현한 클래스는 디버깅하기 쉽다.

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

오류 메시지 등을 로깅할 때도 자동으로 호출될 수 있다.

따라서 실전에서 toString은 그 객체가 가진 주요 정보 모두를 반환하는 게 좋다. 

하지만 객체가 거대하거나 객체의 상태가 문자열 로 표현하기에 적합하지 않다면 요약 정보를 담아야 한다. (사이즈나 id 등)

toString을 구현할 때면 반환값의 포맷을 문서화할지 정해야 한다. (값 클래스라면 문서화하는 것이 좋다)

포맷을 명시하기로 했다면, 명시한 포맷에 맞는 문자열과 객체를 상호 전환할 수 있는 정적 팩터리나 생성자를 함께 제공해주면 좋다.

자바 플랫폼의 많은 값 클래스가 따르는 방식이기도 하다. BigInteger, BigDecimal과 대부분의 기본 타입 클래스가 여기 해당한다.

toString을 제공할 때에는 포맷 명시를 해 두는 것이 좋고, toString이 반환한 값에 포함된 정보를 얻어올 수 있는 API를 제공하도록 하자.

그렇지 않으면 이 정보가 필요한 프로그래머는 toString의 반환값을 파싱할 수밖에 없다. 이 경우 성능이 나빠지고, 작업량이 늘어나며, 향후 포맷을 바꾸면 시스템이 망가질 수 있다.

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