Item12 - toString을 항상 재정의하라

 

들어가기전 요약

 - toString은 간결하면서 사람이 읽기 쉬운 형태의 정보를 반환해야 한다.

 - Object의 toString(재정의 전) 클래스이름@16진수로 표시한 해시 코드

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

 - ValueObject가 가진 모든 정보를 보여주는 것이 좋다.

 - toString이 반환한 값에 포함된 정보를 얻어올 수 있는 API를 제공하는 것이 좋다.

 - 경우에 따라 AutoValue, 롬복 또는 IDE를 사용하지 않는게 적절할 수 있다.

 

 

// PhoneNumber에 toString 메서드 추가 (75쪽)
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, "가입자 번호");
    }

	.
    .
    . 코드 생략

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


    public static void main(String[] args) {
        PhoneNumber jenny = new PhoneNumber(707, 867, 5309);
        System.out.println("전화번호: " + jenny);
    }
}

=> 전화번호: effective.study.chapter02.item12.PhoneNumber@adbbd

 

Object의 기본  toString 메서드는  단순히 클래스이름@16진수로 표시한 해시 코드를 반환한다. toString의 일반 규약에 따르면 아래처럼 간결하면서 사람이 읽기 쉬운 형태의 유익한 정보를 반환해야 한다.

 

    @Override public String toString() {
        return String.format("%03d-%03d-%04d",
                areaCode, prefix, lineNum);
    }
    
    => 전화번호: 707-867-5309

 

보기 편하고 디버깅에도 좋다.