[이펙티브 자바] Item12. toString을 항상 재정의하라.

 

item12. toString을 항상 재정의하라. 

Object의 기본 toString 메서드는 보통 '클래스이름@16진수로 표시한 해시코드' 로 반환한다. 

이 기본 메서드는 우리가 사용하면서 그닥 중요한 정보를 넘겨주는것이 아니기 때문에 재정의를 하여 유익한 정보를 넘겨주는 것이 좋다. 

 

 

toString 일반 규약에 따르면 '간결하면서 사람이 읽기 쉬운 형태의 유익한 정보'를 반환해야 한다'고 한다. 

그리고 또 '모든 하위 클래스에서 이 메서드를 재정의하라고 한다' 

 

toString을 잘 구현한 클래스는 사용하기에도 훨씬 편하고 이 클래스를 사용한 시스템은 디버깅하기 쉬워진다. 

toString 메서드는 객체를 println이나 printf, 문자열 연결 연산자(+), assert 구문에 넘길 때 , 혹은 디버거가 객체를 출력할 때 자동으로 불린다. (또는 사용자가 직접 호출하지 않더라도 다른 곳에서 쓰일 수 있다.)

 

package chapter02.item12;

/**
 * item12. toString을 항상 재정의하라.
 */
public class PhoneNumber
{
   private final short areaCode, prefix, lineNum;
   
   public PhoneNumber(int areaCode, int prefix, int lineNum)
   {
      this.areaCode = rangeCheck(areaCode, 999, "area code");
      this.prefix = rangeCheck(prefix, 999, "prefix");
      this.lineNum = rangeCheck(lineNum, 9999, "line num");
   }
   
   // toString이 반환된 값에 포함된 정보를 얻을 수 있는 API를 제공하는 것이 좋다.
   public short getAreaCode()
   {
      return areaCode;
   }
   
   public short getPrefix()
   {
      return prefix;
   }
   
   public short getLineNum()
   {
      return lineNum;
   }
   
   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 (this == o)
         return true;
      if (!(o instanceof PhoneNumber)) {
         return false;
      }
      
      PhoneNumber that = (PhoneNumber) o;
      return areaCode == that.areaCode && prefix == that.prefix && lineNum == that.lineNum;
   }
   
   @Override
   public int hashCode()
   {
      int result = Short.hashCode(areaCode);
      result = result + 31 * Short.hashCode(prefix);
      result =result +  31 * Short.hashCode(lineNum);
      
      return result;
   }
   
   /**
    * 이 전화번호의 문자열 표현을 반환한다.
    * 이 문자열은 "XXX-YYY-ZZZZ" 형태의 12글자로 구성된다.
    * XXX는 지역코드, YYY는 프리픽스, ZZZZ는 가입자 번호다.
    * 각각의 대문자는 10진수 숫자 하나를 나타낸다.
    *
    * 전화번호의 각 부분의 값이 너무 작아서 자릿수를 채울 수 없담ㄴ,
    * 앞에서부터 0으로 채워나간다.
    * 예로 가입자 번호가 123이라면 전화번호의 마지막 네 문자는 "0123"이다.
    */
   @Override
   public String 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(Integer.parseInt(split[0]), Integer.parseInt(split[1]), Integer.parseInt(split[2]));
      return phoneNumber;
   }
   
}

 

 

1️⃣ 실전에서 toString은 그 객체가 가진 주요 정보 모두를 반환하는게 좋다. 

-> 하지만 이펙티브 자바 강의를 들을 때 강사님은 실전에서 객체가 가진 주요 정보 모두를 반환하는건 상황에 따라 맞지 않을 수도 있다고 하셨다. 

생각해보면 고객 정보와 같이 어딘가에 노출되어서는 안되는 정보가 있는데 이를 toString으로 보여주는건 공개를 하는 것이기 때문에 이런 경우에는 모든 주요 정보를 반환하는것은 맞지 않다고 생각한다. 

 

 

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

/**
 * 이 전화번호의 문자열 표현을 반환한다.
 * 이 문자열은 "XXX-YYY-ZZZZ" 형태의 12글자로 구성된다.
 * XXX는 지역코드, YYY는 프리픽스, ZZZZ는 가입자 번호다.
 * 각각의 대문자는 10진수 숫자 하나를 나타낸다.
 *
 * 전화번호의 각 부분의 값이 너무 작아서 자릿수를 채울 수 없담ㄴ,
 * 앞에서부터 0으로 채워나간다.
 * 예로 가입자 번호가 123이라면 전화번호의 마지막 네 문자는 "0123"이다.
 */
@Override
public String 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(Integer.parseInt(split[0]), Integer.parseInt(split[1]), Integer.parseInt(split[2]));
   return phoneNumber;
}

-> 포맷을 명시하기로 했으면 명시한 포맷에 맞는 문자열과 객체를 상호 전환할 수 있는 정적 팩터리나 생성자를 함께 제공해주면 좋다. 

 

 

 

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

public short getAreaCode()
{
   return areaCode;
}

public short getPrefix()
{
   return prefix;
}

public short getLineNum()
{
   return lineNum;
}

PhoneNumber 클래스에서는 지금 지역코드, 프리픽스, 가이자 번호용 접근자를 제공해야 한다. 

접근자를 제공하지 않으면 사용자가 toString의 반환값을 파싱해서 사용해야 하고, 그러면 성능도 나빠지고 굳이 필요없는 작업을 하는 것이기 때문이다. 

 

 

 

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

이렇게 toStirng 생성을 도와주는 자동생성 기능들이 클래스의 의미까지 파악하지는 못하기 때문에 PhoneNumber처럼 직접 정의해주는 것이 더 나을 수도 있다. 

 

 

 

 

💡 모든 구체 클래스에서 Object의 toString을 해당 객체에 관한 명확하고 유용한 정보를 제공하는 형태로 재정의하자!