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

toString() 메서드 재정의

Object의 기본 toString 메서드는 PhoneNumber@adbbd처럼 단순히 클래스이름@16진수로 표시한 해시코드를 반환한다. 해당 인스턴스의 유익한 정보를 반환하기 위해서 toString 메서드는 재정의해야한다. 

실전에서 toString은 그 객체가 가진 주요 정보 모두를 반환하는게 좋다. 따라서 toString이 반환한 값에 포함된 정보를 얻어올 수 있는 API를 제공해야한다.

 

PhoneNumber.java

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;
    }

    @Override public boolean equals(Object o) {
        if (o == this)
            return true;
        if (!(o instanceof PhoneNumber))
            return false;
        PhoneNumber pn = (PhoneNumber)o;
        return pn.lineNum == lineNum && pn.prefix == prefix
                && pn.areaCode == areaCode;
    }

    @Override public int hashCode() {
        int result = Short.hashCode(areaCode);
        result = 31 * result + Short.hashCode(prefix);
        result = 31 * result + Short.hashCode(lineNum);
        return result;
    }

    public short getAreaCode() {
        return areaCode;
    }

    public short getPrefix() {
        return prefix;
    }

    public short getLineNum() {
        return lineNum;
    }

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

        PhoneNumber phoneNumber = PhoneNumber.of("707-867-5309");
        System.out.println(phoneNumber);
        System.out.println(jenny.equals(phoneNumber));
        System.out.println(jenny.hashCode() == phoneNumber.hashCode());
    }
}

 

toString() 메서드를 재정의해보자.

/**
 * 이 전화번호의 문자열 표현을 반환한다.
 * 이 문자열은 "XXX-YYY-ZZZZ" 형태의 12글자로 구성된다.
 * XXX는 지역 코드, YYY는 프리픽스, ZZZZ는 가입자 번호다.
 * 각각의 대문자는 10진수 숫자 하나를 나타낸다.
 *
 * 전화번호의 각 부분의 값이 너무 작아서 자릿수를 채울 수 없다면,
 * 앞에서부터 0으로 채워나간다. 예컨대 가입자 번호가 123이라면
 * 전화번호의 마지막 네 문자는 "0123"이 된다.
 *
 * 경우에 따라(이렇게 포맷이 필요한 경우 등) AutoValue, 롬복, IDE를 사용하지 않는게 적절할 수도 있다.
 */
@Override public String toString() {
    // 외부에 노출되는 공개 정보 (toString 에는 외부에 공개할 수 있는 정보만 존재해야한다.)
    return String.format("%03d-%03d-%04d",
            areaCode, prefix, lineNum);
}

 

정적팩토리 메서드를 사용해보자.

/**
 * 정적 팩토리 메서드
 * @param phoneNumberString
 * @return
 */
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;
}

 

정적 유틸리티 클래스

toString을 제공할 이유가 없다.

 

열거 타입(Enum)

자바가 이미 완벽한 toString() 메서드를 제공하므로 따로 재정의하지 않아도 된다.