이펙티브 자바, 쉽게 정리하기 - item 12. toString을 항상 재정의하라

toString을 항상 재정의하라

toString() 메서드를 재정의해야 하는 이유

디버깅이 쉬워진다.

• 재정의하지 않으면 PhoneNumber@dbadd와 같이 클래스_이름@16진수_해시코드만 나온다.
• 재정의하면, 010-0000-0000과 같이 의미있는 정보를 볼 수 있다.
• 재정의 했다면, System.out.println(phoneNumber)와 같이 작성하면 내부 내용을 볼 수 있으므로 디버깅하기 쉽다.
• Map과 같은 경우, 내부에 많은 값을 가지고 있는데 toString()을 재정의하면 갖고 있는 모든 값을 알아내기에 매우 좋다.

println(), printf(), + 연산자 등 toString() 메서드는 알게 모르게 많이 불려진다.

코딩이 쉬워진다.

• 만일 사용자에게 값을 보여줘야 할 일이 있을 때도 간단하게 print(phoneNumber)와 같이 넘기기만 하면 toString()은 자동으로 불려질 것이다.
• phoneNumber.xxx + phoneNumber.yyy와 같이 귀찮게 필드 값을 일일이 불러올 필요가 없어지므로 편리하다.

toString() 메서드 재정의 시 주의점

• 객체가 가진 주요 정보는 모두 보여주는 것이 좋다.
• 정보가 너무 많을 때는 간단히 요약된 정보를 보여줄 수도 있다.

API 문서에 포맷을 명시하는 것이 좋다.

static class PhoneNumber {
    public final Short areaCode;
    public final Short prefix;
    public final Short lineNum;

    public PhoneNumber(int areaCode, int prefix, int lineNum) {
        this.areaCode = rangeCheck(areaCode);
        this.prefix = rangeCheck(prefix);
        this.lineNum = rangeCheck(lineNum);
    }

    public short rangeCheck(int integer) {
        if(integer <= Short.MAX_VALUE && integer >= Short.MIN_VALUE) {
            return (short) integer;
        }

        throw new IllegalStateException();
    }

    /**
     * 전화번호의 문자열 표현을 반환한다.
     * xxx-yyy-zzzz 와 같은 형식으로 반환된다.
     * 만일, 각 자리 숫자의 갯수보다 적은 숫자를 넣게 되면 그 공간은 0으로 채워진다.
     */
    @Override
    public String toString() {
        return String.format("%03d-%03d-%04d", areaCode, prefix, lineNum);
    }
}

@Test
public void toStringTest() {
    PhoneNumber myPhoneNumber = new PhoneNumber(10, 1111, 1111);
    System.out.println("myPhoneNumber: " + myPhoneNumber); // 출력: 010-1111-1111
}

• 포맷을 명시하든 안하든 의도는 명확히 밝혀야만 한다.
• 만일 포맷이 변경될 수 있는 경우 변경될 수 있음을 항상 명시해두자.

정적 유틸리티 클래스는 toString()을 제공할 필요가 없고, enum은 대부분 자바가 이미 완벽한 toString()을 제공한다.

핵심 정리

• Object의 toString()은 모든 구체 클래스에서 재정의하면 좋다.
• 객체의 정보를 읽기 쉽고 명확하게 작성하자.
• 디버깅과 코딩이 편리해진다.