아이템 12. toString을 항상 재정의하라

[okhee]

Item 12. toString을 항상 재정의 하라

toString은 모든 정보를 반환하는 것이 좋다.

Object.toString : 해당 오브젝트를 잘 나타내는 문자열 표현을 반환

Object.toString 의 기본 구현: 클래스명에 16진수로 표시한 해시코드만 알려줌.

public String toString() {
    return getClass().getName() + "@" + Integer.toHexString(hashCode());
}

ex) PhoneNumber@adbbd → 이런 형태보단.. 실제로 이 인스턴스가 가지고 있는 값을 보여주는게 더 유익하지 않을까? → 이런 경우는 전화번호를 바로 보여주는 것이 좋아보임.

재정의를 잘 했다면 아래와 같은 간단한 코드만으로 충분한 로그를 남길 수 있음

System.out.println(phoneNumber + "에 연결할 수 없습니다.");

실전에서는 toString은 그 객체가 가진 정보를 모두 반환하는 것이 좋음. 가능하면 객체의 값을 모두 나타내는 것이 좋겠지만, 상태가 너무 많다면 요약해서 보여주는 것도 좋음.

• 서울_거주지_전화번호부[1487536개]
• Thread[main,5,main]

toString 반환값의 포맷?

반환값의 포맷을 문서화 할지는 개발자의 선택.

• 객체의 toString 포맷을 문서화 하면, 값을 그대로 입출력에 쓰거나 csv 등의 데이터 객체로 다룰 수 있음.
• 만약 포맷을 명시하기로 했다면, 포맷에 맞는 문자열과 객체를 상호 전환할 수 있는 정적 팩터리나 생성자를 제공해주면 좋음.
  • 대부분의 자바 플랫폼의 값 객체가 이런 케이스임.
  • BigDecimal의 toString, BigDecimal의 생성자

포맷을 명시하든 아니든, 의도는 분명하게 밝혀야 한다!

• 포맷을 정확하게 명시하지 않기로 했다면, 아래처럼 바뀔 수 있음을 분명히 하자.

  /**
   * 이 약물에 관한 대략적인 설명을 반환한다.
   * 다음은 이 설명의 일반적인 형태이나,
   * 상세 형식은 정해지지 않았으며 향후 변경될 수 있다.
   * 
   * "[약물 #9: 유형=사랑, 냄새=테레빈유, 겉모습=먹물]"
   */
  @Override public String toString() { ... }

포맷에 명시하든 아니든, toString에 포함된 정보를 얻을 수 있는 API를 제공하자

• 제공하지 않으면 정보가 필요한 사람은 toString을 파싱할 수밖에 없음.
  • 사실상 toString의 포맷이 표준 API나 다름없어짐

ToStringBuilder

• 책에서는 value-object를 알아서 만들어주는 google의 AutoValue같은 툴을 소개하고 있음. 설명링크 (지금도 쓸까..?)
  • toString, equals, hashCode 를 만들어줌.
  • 관련 링크에서 비슷한 것으로 Lombok도 소개해주고 있음.
  • IDE가 toString을 코드로 작성해주는 기능도 있지만.. 만약 리팩토링으로 수정해야하면 toString, hashCode를 바꾸는 것은 결국 사람이 해야함 → AutoValue, Lombok 같은거를 써야 편함.
• apache common lang3의 라이브러리에서 리플렉션을 통해서 사용할 수도 있음.
  • ToStringBuilder.reflectionToString
  • https://vnthf.github.io/blog/Java-ToStringBuild에-관하여/