[JAVA] toString을 재정의하라

toString ?

toString을 들어보신 적이 있으신가요?

자바나 스프링을 사용하다보면 toString을 자연스럽게 볼 수 있을 것입니다.

 

그렇다면, 한 번쯤은 toString 을 객체의 값을 출력하기 위해 사용한 적이 있나요?

위 코드는 제가 레벨 1 자동차 경주 미션 첫 리뷰때 제출했던 코드입니다.

 

toString 이름을 들었을 때는 객체의 값을 출력하기 위해 사용할 수 있을 것 같은 느낌이 듭니다.

 

과연 그럴까요..?

 

결론부터 말하면 toString 은 객체의 값을 출력하기 위한 용도가 아닌, 디버깅을 위한 용도로 사용됩니다.

toString 의 일반 규약은 '간결하면서 사람이 읽기 쉬운 형태의 유익한 정보'를 반환하는 것입니다.

 

현재 toString 메서드는 뷰에 의존하고 있는 형태입니다.

만약, 뷰에 관련된 요구사항이 바뀌게 된다면 도메인까지 변경해야 하는 OCP 원칙을 위배하는 상황이 발생합니다.

---

toString을 왜 재정의할까?

toString 을 잘 구현한 클래스는 사용하기 편하고, 디버깅하기 쉽습니다.

또한 toString 메서드는 객체를 println, printf, 문자열 연결, assert 구문에 넘길 때, 디버거가 객체를 호출할 때 자동으로 호출됩니다.

 

직접 코드를 실행시킨 결과를 보겠습니다.

 

toString을 재정의하지 않은 경우

- System.out.println(car)를 실행한 결과

- assert에서 디버거가 객체를 호출할 때

 

toString을 재정의한 경우

- Car 객체의 toString 재정의

- System.out.println(car)를 할 때

- assert에서 디버거가 객체를 호출할 때

 

즉, toString을 제대로 작성하지 않는다면 쓸모없는 메세지만 로그에 남는다는 것을 볼 수 있습니다.

서버 개발자로서 로그를 남기는 것은 개발하는 것 만큼이나 매우 중요하다고 생각합니다.

---

그렇다면 toString을 어떻게 사용하는 것이 좋을까?

> toString은 해당 객체가 가진 주요 정보를 모두 반환하는 것이 좋습니다.

 

아래는 Lombok 라이브러리에서 제공하는 toString document 입니다.

 

https://projectlombok.org/features/ToString

public class ToStringExample {
  private static final int STATIC_VAR = 10;
  private String name;
  private Shape shape = new Square(5, 10);
  private String[] tags;
  private int id;
  
  public String getName() {
    return this.name;
  }
  
  public static class Square extends Shape {
    private final int width, height;
    
    public Square(int width, int height) {
      this.width = width;
      this.height = height;
    }
    
    @Override public String toString() {
      return "Square(super=" + super.toString() + ", width=" + this.width + ", height=" + this.height + ")";
    }
  }
  
  @Override public String toString() {
    return "ToStringExample(" + this.getName() + ", " + this.shape + ", " + Arrays.deepToString(this.tags) + ")";
  }
}

Shape 객체를 상속받는 Square 객체의 toString 메서드를 보면 객체의 타입과 객체가 가지고 있는 모든 값을 출력하는 것을 알 수 있습니다.

즉, 해당 객체가 가진 주요 정보를 모두 반환한다는 것입니다.

 

여기서 가질 수 있는 궁금한 점

 

Q) 그럼 어떤 방식으로 toString을 재정의하면 되나요?

 

A) 개발자가 원하는 format 형태로 제공하면 됩니다. 다만 모든 객체에 일괄적인 형태의 format으로 적용하는 것이 중요합니다.

 

---

그러나 모든 클래스가 toString을 재정의할 필요가 있는 것은 아닙니다.

 

정적 유틸리티 클래스의 경우 클래스의 멤버가 존재할 필요가 없기 때문에 toString을 제공할 필요가 없습니다.

또한 enum 타입도 toString을 제공할 필요가 없습니다.

---

정리

모든 구체(구현) 클래스에서 Object의 toString을 재정의하자.
toString을 재정의한 클래스는 사용하기 편하고 디버깅하기도 쉽다