[이펙티브 자바] 아이템12

hyng·2022년 12월 11일
0

이펙티브 자바

목록 보기
12/13

toString을 항상 재정의하라

Object.toString() 메서드는 클래스명@16진수로_표현한_해시 코드 형태로 반환한다.
toString() 은 개발자가 직접 호출하지 않더라도 다른 어딘가에서 쓰이게 된다. 예를 들어 객체를 println, printf 할 때, 객체를 참조하는 컴포넌트가 오류 메시지를 로깅할 때 자동으로 호출할 수 있다.
그렇기 때문에 객체가 가진 핵심적인 정보를 나타내도록 잘 정의된 toString 메서드는 디버깅을 할 때 문제를 진단하기에 충분한 메시지를 남길 수 있을 것이다.

System.out.println(phoneNumber + "에 연결할 수 없습니다.");

포맷을 명시하든 아니든 의도를 명확히 밝혀야 한다

포맷을 명시하는 경우

/**
* 이 전화번호의 문자열 표현을 반환한다. 
* 이 문자열은 "XXX-YYY-ZZZZ" 형태의 12글자로 구성된다.
* 각각의 대문자는 10진수 숫자 하나를 나타낸다.
*
* 전화번호의 각 부분의 값이 너무 작아서 자릿수를 채울 수 없다면,
* 앞에서부터 0으로 채워나간다. 예컨대 가입자 번호가 123이라면
* 전화번호의 마지막 네 문자는 "0123"이 된다.
*/
@Override public String toString() {
    return String.format("%03d-%03d-%04d", areaCode, prefix, lineNum);
}

포맷을 명시하지 않는 경우

/**
* 이 약물에 관한 대략적인 설명을 반환한다.
* 다음은 이 설명의 일반적인 형태이나,
* 상세 형식은 정해지지 않았으며 향후 변경될 수 있다.
*
* "[약물 #9: 유형=사랑, 냄새=테레빈유, 겉모습=먹물]"
*/

toString이 반환한 값에 포함된 정보를 얻어올 수 있는 API를 제공하자

PhoneNumber 클래스라면 지역 번호, 프리픽스, 가입자 번호용 getter를 제공해야 한다.
그렇지 않으면 이 정보가 필요한 클라이언트는 toString() 반환값을 파싱 할 수밖에 없다.
포맷을 명시하지 않았다고 하더라도 정보를 얻어올 수 있는 API를 제공하지 않으면 그 포맷이 사실상 준-표준 API나 다름없어진다.

profile
공부하고 알게 된 내용을 기록하는 블로그

0개의 댓글