이펙티브 자바 아이템 12 - toString 을 항상 재정의하라 - 핵심 정리

아이템 12 - toString 을 항상 재정의하라 - 핵심 정리

이 글은 백기선 님의 이펙티브 자바 강의와 이펙티브 자바 3 / E 편을 참고하여 작성하였습니다.

---

오브젝트에서 기본적으로 제공하는 toString 은 클래스이름@16진수로 표시한 해시 코드 의 형태이다.

이런 기본적인 형식은 딱히 유용하지가 않다.

인스턴스에 문자열을 연산하면 인스턴스에 있는 toString 이 자동으로 호출된다.

toString 은 우리가 원하는 형태로 표현을 해주면 좋다.

특히 값 클래스의 경우에는 어떤 형태로 toString 의 형식이 되는 문서화 를 하면 좋다.

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

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

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

위 클래스처럼 정적팩토리 메서드를 통해 toString 을 통해 받았던 문자열을 기반으로 인스턴스를 생성할 수 있도록 하는게 좋다.

toString 을 통해 얻을 수 있는 정보는 공개된 정보 라고 보면 된다.

외부에 공개할 수 있는 데이터 만 toString 을 통해 보여줘야한다.

toString 을 통해 노출할 수 있는 데이터라면 각각의 데이터를 전달받을 방법이 따로 있어야한다.

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

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

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

getter 를 생성해 toString 으로 제공한 데이터를 받을 수 있도록 했다.

toString 을 구성하는 각각의 데이터를 제공하지 않으면 toString 으로 값을 받아 클라이언트가 데이터를 가공해 사용할 수도 있다.

차라리 toString 으로 제공한 각각의 데이터를 받을 수 있는 방법을 제공하는 편이 낫다.

경우에 따라서는 Lombok, IDE 등에서 만들어주는 toString 이 적절하지 않을 수 있다.