아이템 12. toString 항상 재정의하라

문법식·2022년 3월 16일
0

Effective Java 3/E

목록 보기
12/52

Object의 기본 toString 메서드가 우리가 작성한 클래스에 적합한 문자열을 반환하는 경우는 거의 없다. toString의 일반 규약에 따르면 간결하면서 사람이 읽기 쉬운 형태의 유익한 정보를 반환해야 한다. 또한 toString의 규약에는 모든 하위 클래스에서 이 메서드를 재정의하라라는 규약도 있다.

toString을 잘 구현한 클래스는 사용과 디버깅을 쉽게 해준다. toString메서드는 객체를 println, printf, 문자열 연결 연산자(+), assert 구문에 넘길 때, 혹은 디버거가 객체를 출력할 때 자동으로 호출된다. 우리가 호출하지 않아도 여러 곳에서 자동으로 쓰이는 곳이 많다. 특히 구현한 클래스의 오류 메세지를 출력할 때 toString메서드를 사용하는데 toString메서드를 잘 구현했으면 오류의 원인을 파악하기 쉬워진다.

실전에서 toString은 그 객체가 가진 주요 정보를 모두 반환하는게 좋다. 하지만 객체가 거대하거나 객체의 상태가 문자열로 표현하게 적합하지 않다면 무리가 있다. 이런 상황이라면 멘헤튼 거주자 전화번호부(총 1487536개)Thread[main, 5, main]같은 요약정보를 담아야 한다. 이상적으로는 스스로를 완벽히 설명하는 문자열이어야 한다.

toString을 구현할 때 반환값의 포맷을 문서화할지 정해야 한다. 전화번호나 행렬 같은 값 클래스라면 문서화하기를 권한다. 포맷을 명시하면 그 객체는 표준적이고 명확하고 사람이 읽을 수 있게 된다. 따라서 그 값 그대로 입출력에 사용하거나 CSV 파일처럼 사람이 읽을 수 있는 데이터 객체로 저장할 수도 있다. 포맷을 명시하기로 했다면, 명시한 포맷에 맞는 문자열과 객체를 상호 전환 할 수 있는 정적 팩터리나 생성자를 함께 제공해주면 좋다. 자바 플랫폼의 많은 값 클래스들이 따르는 방식이고 BigInteger, BigDecimal과 대부분의 기본 타입 클래스가 해당된다.

단점도 있다. 포맷을 한번 명시하면 평생 그 포맷에 얽매이게 된다. 반대로 포맷을 명시하지 않으면 향후 릴리스에서 정보를 더 넣거나 포맷을 개선할 수 있는 유연성을 얻게 된다.

포맷을 명시하든 아니든 의도는 명확히 밝혀야 한다. 포맷을 명시하려면 아주 정확하게 해야 한다. 포맷을 명시하지 않아서 발생하는 책임은 우리한테 있다.

포맷 명시 여부와 상관없이 toString이 반환한 값에 포함된 정보를 얻어올 수 있는 API를 제공하자 예를 들면 클래스의 접근자(Getter)가 있다.

정적 유틸리티 클래스는 toString을 제공할 이유가 없다. 또한 대부분의 열거 타입도 자바가 이미 완벽한 toString을 제공하니 따로 재정의하지 않아도 된다. 하지만 하위 클래스들이 공유해야 할 문자열 표현이 있는 추상 클래스라면 toString을 재정의해줘야 한다. IDE 등에서 toString을 자동 생성해주는데 아무것도 알려주지 못하는 ObjecttoString보다는 훨씬 유용하므로 사용하면 좋다.

profile
백엔드

0개의 댓글