- Object의 기본 toString 메서드가 우리가 작성한 클래스에 적합한 문자열을 반환하는 경우는 거의 없다.
< toString의 일반 규약 발췌 >
- 간결하면서 사람이 읽기 쉬운 형태의 유익한 정보를 반환해야 한다.
- 모든 하위 클래스에서 이 메서드를 재정의해야 한다.
- 실전에서 toString은 그 객체가 가진 주요 정보 모두를 반환하는 게 좋다.
- 객체가 거대하거나 객체의 상태가 문자열로 표현하기에 적합하지 않다면 요약 정보를 담아야 한다.
- 이상적으로는 스스로를 완벽히 설명하는 문자열이어야 한다.
- toString을 구현할 때면 반환값의 포맷을 문서화할지 정해야 한다. 포맷을 명시하기로 했다면, 명시한 포맷에 맞는 문자열과 객체를 상호 전환할 수 있는 정적 팩터리나 생성자를 함께 제공해주면 좋다. 포맷을 한번 명시하면 (그 클래스가 많이 쓰인다면) 평생 그 포맷에 얽매이게 되는 단점도 있다. => 포맷을 명시하든 아니든 의도는 명확히 밝혀야 한다.
- 포맷 명시 여부와 상관없이 toString이 반환한 값에 포함된 정보를 얻어올 수 있는 API를 제공하자.
- 정적 유틸리티 클래스(아이템 4), 대부분의 열거 타입(아이템 34)도 자바가 이미 완벽한 toString을 제공하니 따로 재정의하지 않아도 된다. 하지만 하위 클래스들이 공유해야 할 문자열 표현이 있는 추상 클래스라면 toString을 재정의해줘야 한다.
[핵심 정리]
모든 구체 클래스에서 Object의 toString을 재정의하자. 상위 클래스에서 이미 알맞게 재정의한 경우는 예외다. toString을 재정의한 클래스는 사용하기도 즐겁고 그 클래스를 사용한 시스템을 디버깅하기 쉽게 해준다. toString은 해당 객체에 관한 명확하고 유용한 정보를 읽기 좋은 형태로 반환해야 한다.
'공부 기록 > Java' 카테고리의 다른 글
[이펙티브 자바 3/E] 아이템13 - clone 재정의는 주의해서 진행하라 (0) | 2023.08.09 |
---|---|
[JPA] 5장 - 연관관계 매핑 기초(1) - 단방향 연관관계 (0) | 2023.08.06 |
[이펙티브 자바 3/E] 아이템11 - equals를 재정의하려거든 hashCode도 재정의하라 (0) | 2023.07.31 |
[JPA] 4장 - 엔티티 매핑(2) - 필드와 컬럼 매핑 (0) | 2023.07.31 |
[JPA] 4장 - 엔티티 매핑(1) (0) | 2023.07.30 |