HOWTO · Java

Java에서 toString 메서드 재정의

이 기사에서는 Java에서 toString() 메서드를 재정의하는 방법을 설명합니다.

이 페이지의 내용

Java에서 객체를 출력하면 해당 객체의 toString() 메서드를 호출해 문자열을 가져옵니다. 상속된 기본 구현은 보통 객체의 클래스와 해시 기반 값을 나타내므로 인스턴스를 구분하는 데는 도움이 될 수 있지만, 객체의 내용을 설명하는 경우는 드뭅니다. 로그, 디버깅, 일반적인 출력에 유용하도록 간결한 표현을 제공하려면 toString()를 재정의하세요.

기본 toString() 출력의 의미

상위 클래스나 해당 클래스가 직접 재정의하지 않는 한, 모든 Java 클래스는 Object에서 toString()를 상속합니다. System.out.println(book) 같은 호출은 객체의 문자열 표현을 사용합니다. 이 호출은 암묵적으로 이루어지므로 book.toString()를 직접 작성할 필요가 없습니다.

기본 표현은 안정적인 식별자가 아니며 객체 필드에 대한 보장도 아닙니다. 해시 기반 부분은 실행할 때마다 달라질 수 있고 객체의 상태를 읽기 쉽게 보여 주지도 않습니다. 예시의 기본값을 애플리케이션 로직이나 테스트에 복사해 사용하지 마세요. 클래스에 더 유익한 텍스트 표현이 필요하다면 메서드를 재정의할 수 있습니다.

@Override를 사용해 toString() 재정의하기

정확한 시그니처가 public String toString()인 public 메서드를 선언하고 String을 반환하세요. @Override 어노테이션은 이 메서드가 상속된 메서드를 재정의하려는 것임을 컴파일러에 알립니다. 이름을 잘못 입력했거나 매개변수 목록이 올바르지 않을 때도 오류를 찾는 데 도움이 됩니다. 다음의 완전한 예제는 책의 제목과 저자를 저장하고, 두 필드로 문자열 표현을 만듭니다.

다음 예제를 실행해 보세요.

이 섹션의 코드와 표시되는 레이블 또는 출력은 영어로 유지됩니다.

public class BookExample {
    public static void main(String[] args) {
        Book book = new Book("Dune", "Frank Herbert");
        System.out.println(book);
    }
}

class Book {
    private final String title;
    private final String author;

    Book(String title, String author) {
        this.title = title;
        this.author = author;
    }

    @Override
    public String toString() {
        return "Book{title='" + title + "', author='" + author + "'}";
    }
}

예제를 컴파일하고 실행하기

public 클래스의 이름이 BookExample이므로 소스 파일을 BookExample.java라는 이름으로 저장하세요. 해당 디렉터리에서 javac BookExample.java 명령으로 컴파일한 다음 java BookExample 명령으로 실행합니다. 실행이 성공하면 Book.toString()가 반환한 표현인 Book{title='Dune', author='Frank Herbert'}가 출력됩니다.

핵심은 toString()가 문자열을 반환하며 그 자체로는 아무것도 출력하지 않는다는 점입니다. System.out.println(book)은 표현을 요청해 콘솔에 씁니다. 반환된 문자열을 로거 또는 다른 메시지에서 사용할 수도 있습니다. 표시나 로깅 방식은 메서드 바깥에서 결정하세요.

유용한 toString() 출력 선택하기

독자가 객체를 알아보고 현재 상태를 이해하는 데 도움이 되는 필드를 포함하세요. 형식은 간결하게 유지하고, 명확성을 높일 수 있다면 값을 항목별로 표시하며, 비밀번호나 액세스 토큰 같은 비밀 정보는 제외하세요. 객체의 표현은 사람이 읽기 위한 것이므로 상속된 해시 기반 문자열에 기대지 말고 안정적이고 이해하기 쉬운 값을 선택하세요.

이 메서드는 무관한 작업을 수행하지 말고 상태를 나타내야 합니다. 문자열을 만드는 동안 필드를 변경하거나 메시지를 출력하거나 비용이 큰 작업을 하지 마세요. 필드가 많은 클래스라면 다루기 어려운 전체 덤프를 반환하는 대신 진단에 가장 유용한 항목을 선택하세요. 공개 파일이나 네트워크 프로토콜에서 정확한 형식이 중요하다면 해당 형식을 별도로 정의하고 테스트하세요. 호출자가 디버깅용 표현을 데이터 계약으로 파싱하게 해서는 안 됩니다.