[Effective Java] 아이템 12. toString을 항상 재정의하라.

[tonykang22]

아이템 11. toString을 항상 재정의하라.

핵심 정리

• toString은 간결하면서 사람이 읽히 쉬운 형태의 유익한 정보를 반환해야 한다.
  • 외부에 노출되는 것이기 때문에, 외부에 노출할 데이터만 포함해야한다.
• Object의 toString은 클래스이름@16진수로 표시한 해시 코드
• 객체가 가진 모든 정보를 보여주는 것이 좋다.
• 값 클래스라면 포맷을 문서에 명시하는 것이 좋으며, 해당 포맷으로 객체를 생성할 수 있는 정적 팩터리나 생성자를 제공하는 것이 좋다.
• toString이 반환한 값에 포함된 정보를 얻어올 수 있는 API를 제공하는 것이 좋다.
  • 이미 toString으로 반환된 값은 노출되어도 되는 값이기도 하고, 그 정보를 단편적으로 사용할 필요도 있다는 의미이기 때문이다.
  • 경우에 따라 AutoValue, 롬복 또는 IDE를 사용하지 않는게 적절할 수 있다.
    • 원하는 포멧이 있는 경우에 적절하지 않을 수 있다.
      • 아래 예시 코드에 나오는 PhoneNumber가 이에 해당한다.

예시 코드

유의미한 정보를 반환하도록 해야한다.

아래의 코드에서 재정의 하지 않았다면 클래스이름@16진수로 표시한 해시 코드가 반환될 것이다.

public final class PhoneNumber {
    private final short areaCode, prefix, lineNum;

    public PhoneNumber(int areaCode, int prefix, int lineNum) {
        this.areaCode = rangeCheck(areaCode, 999, "지역코드");
        this.prefix   = rangeCheck(prefix,   999, "프리픽스");
        this.lineNum  = rangeCheck(lineNum, 9999, "가입자 번호");
    }

    private static short rangeCheck(int val, int max, String arg) {
        if (val < 0 || val > max)
            throw new IllegalArgumentException(arg + ": " + val);
        return (short) val;
    }

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

값 클래스라면 포맷을 문서에 명시하는 것이 좋으며, 해당 포맷으로 객체를 생성할 수 있는 정적 팩터리나 생성자를 제공하는 것이 좋다.

아래는 naive한 방법으로, 엄격하게 하기 위해서는 입력 값을 검증하는 것도 필요하다.

public static PhoneNumber of(String phoneNumberString) {
        String[] split = phoneNumberString.split("-");
        PhoneNumber phoneNumber = new PhoneNumber(
                Short.parseShort(split[0]),
                Short.parseShort(split[1]),
                Short.parseShort(split[2]));
        return phoneNumber;
    }