toString을 항상 재정의하라 - [3장. 모든 객체의 공통 메서드(아이템12)]

1. toString을 재정의 해야 하는 이유 🧃

1. Object의 toString 메서드의 기본 형식

  Object의 기본 toString 메서드는 '클래스이름@16진수로 표시한 해쉬코드'를 반환해 준다. test.Test@15db9742이 하나의 예시이다. 이는 우리가 작성한 클래스에서 toString으로 반환받을 적절한 값의 형태가 아니다.

  또한, Object.class에 정의된 toString을 살펴보면 아래의 내용을 확인할 수 있다.

• The result should be a concise but informative representation that is easy for a person to read.
  간결하면서 사람이 읽기 쉬운 형태의 유익한 정보를 반환해라
• It is recommended that all subclasses override this method.
  모든 하위 클래스에서 이 메서드를 재정의하라

즉, 아주 당연하게도 우리는 toString을 재정의 해줘야 한다.

2. 디버깅하기 쉽다.

  toString메서드는 디버거가 객체를 출력할 때 자동으로 불리게 된다. 만약 toString을 제대로 재정의하지 않는다면 쓸모없는 메시지만 로그에 남을 것이다. toString을 적절하게 재정의 한다면 우리는 디버깅을 쉽게 할 수 있다.

 

2. 어떻게 toString을 재정의 해야 하는가? 🍹

1. 간결하면서 사람이 읽기 쉬운 형태의 유익한 정보를 반환

2. 객체가 가진 모든 정보를 보여주는 것이 좋다

  물론 외부에 공개할 수 있는 데이터에 한해서 적용되는 말일 것이다.

3. 값 클래스라면 포맷을 문서에 명시하는 것이 좋다.

  포맷을 명시하면 그 객체는 표준적이고, 명확하고, 사람이 읽을 수 있는 데이터 객체로 저장할 수 있기 때문이다.

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

 

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

  만약 해당 API가 없다면 해당 정보가 필요한 프로그래머는 toString으로 값을 받아온 후 원하는 값을 얻기 위해 다시 파싱을 할 수밖에 없다. 그리고 만약 toString의 표현이 바뀌면 파싱이 제대로 이루어지지 않아 시스템이 망가질 거라는 것을 너무나도 쉽게 예상할 수 있다.
  그러므로 toString의 반환 값에 포함된 정보를 얻어올 수 있도록 API를 제공하도록 하자.

 

4. toStirng을 자동생성하는 것이 아닌 직접 생성하는 것이 때로는 적절할 수 있다. 🥤

  AutoValue, Lombok 그리고 대부분의 IDE에서 toString의 생성을 도와준다. 필드의 내용을 적절하게 나타낼 수는 있지만, 클래스의 '의미'까지는 파악하지 못한다. 그러므로 자동 생성된 toString보다 더 적절한 toString을 만들 수 있다면 직접 toString을 재정의하자.

  예를 들어, 전화번호의 문자열을 toString으로 표현한다고 하자. 아래의 코드를 통해 '자동 생성을 이용한 toString'과 '직접 생성한 toString'을 비교해 보면서 어느 것이 더 적절한지 이해할 수 있을 것이다.

// 자동 생성을 이용한 toString (클래스의 의미를 적절하게 표시X)
@Override
public String toString() {
    return "PhoneNumber [areaCode=" + areaCode + ", prefix=" + prefix + ", lineNum=" + lineNum + "]";
}

// 직접 생성한 toString (클래스의 의미를 적절하게 표현)
@Override public String toString() {
    return String.format("%03d-%03d-%04d",
            areaCode, prefix, lineNum);
}

 

해당 글은 백기선 님의 '이펙티브 자바 완벽 공략'을 수강하고 작성한 것입니다.