toString() 을 항상 재정의하자

우리가 클래스를 작성할 때, Object 의 기본 toString() 메서드가 우리가 작성한 클래스의 유의미한 정보를 제공해주는 경우는 거의 없다. 이 메소드는 PhoneNumber@adbbd 처럼 단순히 클래스_이름 @ 16진수로 표현한 해시코드 를 반환할 뿐이다. 

 

잘 정의된 toString 은 디버깅을 손쉽게 만들어준다

---

Java에서 toString 의 규약은 모든 하위 클래스에서 이 메서드를 재정의하라고 한다. toString 을 잘 구현한 클래스는 사용하기에 훨씬 즐겁고, 그 클래스를 사용한 시스템은 디버깅하기 쉽다. toString 메서드는 객체를 println, printf, 문자열 연결 연산자, assert 구문에 넘길 때, 혹은 디버거가 객체를 출력할 때 자동으로 불린다. 예컨대 우리가 작성한 객체를 참조하는 컴포넌트가 오류 메시지를 로깅할 때 자동으로 호출할 수 있다.

 

PhoneNumber 용 toString 을 제대로 재정의했다면 다음 코드만으로 문제를 진단하기에 충분한 메시지를 남길 수 있다. 

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

 

toString을 재정의하든 아니든 프로그래머 대부분은 진단 메시지를 이렇게 만들 것이다. 재정의를 하지 않았다면 그다지 쓸모가 없는 메시지가 출력된다.  좋은 toString 은 이 인스턴스를 포함하는 객체에서 유용하게 쓰인다. map 객체를 출력했을 때 Jenny = PhoneNumber@adbbd 보단 Jenny = 010-876-5309 같은 메시지가 나오는게 훨씬 좋을 것이다. 

 

 

toString 을 재정의할 때, 반환값의 포맷을 문서화할지 정해야 한다

---

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

 

하지만 여기엔 단점도 있는데, 포맷을 한 번 명시하면 평생 그 포맷에 얽매이게 된다. 이를 사용하는 프로그래머들이 그 포맷에 맞춰 파싱하고, 새로운 객체를 만들고, 영속 데이터로 저장하는 코드를 작성할 것이다. 향후 릴리스에서 포맷을 변경하면, 이를 사용하던 코드들은 모두 사용 불가능한 상태가 될 것이다.

 

포맷을 명시하든 아니든 우리의 의도는 명확히 밝혀야 한다. PhoneNumber 클래스용 toString 메소드를 보자.

 

 

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

 

포맷 명시 여부와 상관없이 toString 이 반환한 값에 포함된 정보를 얻어올 수 있는 API 를 제공하자

예를 들어 PhoneNumber 클래스는 지역 코드, 프리픽스, 가입자 번호용 접근자를 제공해야 한다. 그렇지 않으면 이 정보가 필요한 프로그래머는 toString 의 반환값을 파싱할 수 밖에 없다. 성능이 나빠지고, 필요하지도 않은 작업이다. 

 

정적 유틸리티 클래스나 열거 타입은 toString 을 제공할 이유가 없다. 

대부분의 열거 타입은 자바가 이미 완벽한 toString 을 제공하니 따로 재정의하지 않아도 된다. 하지만 하위 클래스들이 공유해야 할 문자열 표현이 있는 추상 클래스라면 toString 을 재정의해줘야 한다.