Item 12. toString을 항상 재정의하라. #12
Description
Chapter : 3. 모든 객체의 공통 메서드
Item : 12. toString을 항상 재정의하라.
Assignee : eunpyeong114
🍑 서론
Object의 기본 toString 메서드는 우리가 작성한 클래스에 적합한 문자열을 반환하는 경우가 거의 없다. 단순히 클래스_이름@16진수로_표시한_해시코드를 반환한다.
🍑 본론
toString 메서드는 객체를 println, printf, 문자열 연결 연산자(+), assert 구문에 넘길 때, 혹은 디버거가 객체를 출력할 때 자동으로 불린다. 다시 말해, 직접 호출하지 않더라도 다른 어딘가에서 쓰일 거라는 이야기다.
예를 들어, 객체를 참조하는 컴포넌트가 오류 메세지를 로깅할 때 자동으로 호출되는데, toString을 제대로 재정의하지 않는다면 쓸모없는 메세지만 로그에 남을 것이다.
toString의 일반 규약
- '간결하면서 사람이 읽기 쉬운 형태의 유익한 정보를 반환해야 한다'
- '모든 하위 클래스에서 이 메서드를 재정의하라'
좋은 toString은 그 객체가 가진 주요 정보를 모두 반환하는 게 좋다.
toString 구현 시 반환값의 포맷을 문서화할지 정해야 한다.
포맷을 명시할 때
- 장점
: 표준적이고, 명확하고, 사람이 읽을 수 있게 된다. - 단점
: 한번 명시하면, 평생 그 포맷에 얽매이게 된다.
: 포맷 개선할 수 있는 유연성이 떨어짐
(예를 들면, 향후 릴리스에서 포맷을 바꾼다면, 이를 사용하던 코드들과 데이터들은 엉망이 될 것이다.)
따라서 포맷을 명시하든 아니든 의도는 명확히 밝히는 것을 권장한다.
- 포맷을 명시하려면 아주 정확하게 해야 한다.
/**
* 이 전화번호의 문자열 표현을 반환한다.
* 이 문자열은 "XXX-YYY-ZZZZ" 형태의 12글자로 구성된다.
* XXX는 지역 코드, YYY는 프리픽스, ZZZ는 가입자 번호다.
* 각각의 대문자는 10진수 숫자 하나를 나타낸다.
*
* 전화번호의 각 부분의 값이 너무 작아서 자릿수를 채울 수 없다면,
* 앞에서부터 0으로 채워나간다. 예컨대 가입자 번호가 123이라면
* 전화번호의 마지막 네 문자는 "0123"이 된다.
*/
@Override public String toString(){
return String.format("%03d-%03d-%04d", areaCode, prefix, lineNum);
}- 포맷을 명시하지 않기로 한 경우
/**
* 이 약물에 관한 대략적인 설명을 반환한다.
* 다음은 이 설명의 일반적인 형태이나,
* 상세 형식은 정해지지 않았으며 향후 변경될 수 있다.
* "[약물 #9: 유형=사랑, 냄새=테레빈유, 겉모습=먹물]"
*/
@Override public String toString(){...}포맷 명시 여부와 상관없이 toString이 반환값 값에 포함된 정보를 얻어올 수 있는 API를 제공하자!
이는 쉽게 말해 접근자를 제공해야한다는 의미이다.
🍑 결론
모든 구체 클래스에서 Object의 toString을 재정의하자.