HomeAboutMeBlogGuest
© 2025 Sejin Cha. All rights reserved.
Built with Next.js, deployed on Vercel
📖
공부한 책
/
📒
Effective Java
/
아이템 12: toString을 항상 재정의하라

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

 

toString을 잘 정의했을 때 장점

  • 그 클래스를 사용한 시스템은 디버깅하기 쉬움
    • println, printf, 문자열 연결 연산자(+), assert 구문에 넘길 때, 혹은 디버거가 객체를 출력할 때 자동으로 불림 (직접 호출하지 않아도 다른 어딘가에서는 쓰인다)
  • System.out.printn(phoneNumber + “에 연결할 수 없습니다.”);
    • 위와 같은 코드블럭에서 toString이 재정의 되지 않았으면 쓸모 없는 메시지가 출력됨
  • toString은 (컬렉션처럼) 이 인스턴스를 포함하는 객체에서 유용하게 쓰임
    • map 객체 출력시 {Jenny=PhoneNumber@adbbd} 🆚. {Jenny=707-867-3434}
 

지켜야 할 점

  • 실전에서 toString은 그 객체가 가진 주요 정보 모두를 반환하는 것이 좋음
  • toString을 구현할 때면 반환값의 포맷을 문서화 할지 정해야 함
    • 포맷을 명시 시, 그 객체는 표준적이고, 명확하고, 사람이 읽을 수 있게 됨
    • 명시한 포맷에 맞는 문자열과 객체를 상호 전환할 수 있는 정적 팩터리나 생성자를 함께 제공해주면 좋음
    • 단점
      • (그 클래스가 많이 쓰인다면) 평생 그 포맷에 얽매이게 됨
      • 포맷에 맞춰 파싱하고, 새로운 객체를 만들고 영속 데이터로 저장하는 코드를 작성 → 포맷 바꾸면 다 엉망이 됨
  • 포맷 명시 여부와 상관없이 toString이 반환한 값에 포함된 정보를 얻어올 수 있는 API를 제공하자
    • 예로, PhoneNumber 클래스는 지역코드, 프리픽스, 가입자 번호용 접근자를 제공해야 함

포맷 명시 예제

/** * 이 전화번호의 문자열 표현을 반환한다. * 이 문자열은 "XXX-YYY-ZZZZ" 형태의 12글자로 구성된다. * XXX는 지역 코드, YYY는 프리픽스, ZZZZ는 가입자 번호다. * 각각의 대문자는 10진수 숫자 하나를 나타낸다. * * 전화번호의 각 부분의 값이 너무 작아서 자릿수를 채울 수 없다면, * 앞에서부터 0으로 채워나간다. 예컨대 가입자 번호가 123이라면 * 전화번호의 마지막 네 문자는 "0123"이 된다. */ // @Override public String toString() { // return String.format("%03d-%03d-%04d", // areaCode, prefix, lineNum); // }
포맷 명시의 예제. 포맷을 명시하려면 정확히 명시해라
/** * 이 약물에 관한 대략적인 설명을 반환한다. * 다음은 이 설명의 일반적인 형태이나, * 상세 형식은 정해지지 않았으며 향후 변경될 수 있다. * * "[약물 #9: 유형=사랑, 냄새=테레반유, 겉모습=먹물]" */ @Override public String toString(){ ...}
포맷을 명시하지 않기로 했다면 이와같이 작성

toString제공 안해도 되는 케이스

  • 정적 유틸리티 클래스
  • 대부분의 열거 타입
    • 이미 자바가 toString을 제공하니 따로 재정의하지 않아도 됨
    • 하지만 하위 클래스들이 공유해야 할 문자열 표현이 있는 추상 클래스라면 toString을 재정의해주어야 함
      • 예로 대다수의 컬렉션 구현체는 추상 컬렉션 클래스들의 toString 메서드를 상속해 사용함