봄수의 연구실

@ToString 본문

DEV/Java

@ToString

berom 2023. 7. 10. 21:28

@ToString

- 해당 클래스의 정보를 문자열로 자동 생성한다.
- 사용자는 클래스 인스턴스를 바로 출력하면, 인스턴스 정보를 알 수 있다.

@ToString은 Java의 Lombok 라이브러리에 포함된 주석입니다.
Lombok은 편집기와 빌드 도구에 자동으로 연결되는 Java 라이브러리로, 반복적인 코드를 줄여주는 유용한 기능을 제공합니다.

@ToString를 클래스에 적용하면, Lombok은 해당 클래스에 대한 toString() 메서드를 자동으로 생성합니다.
toString() 메서드는 클래스 이름과 각 필드와 그 값들을 포함하는 문자열을 생성합니다.
이는 디버깅에 매우 유용할 수 있습니다. 객체의 상태를 쉽게 출력할 수 있습니다.

예시

Certainly! Here’s an example that demonstrates the use of @ToString in a code snippet with Korean comments:

import lombok.ToString;

@ToString
public class Person {
    private String name;  // 이름
    private int age;      // 나이

    public Person(String name, int age) {
        this.name = name;
        this.age = age;
    }

    public static void main(String[] args) {
        Person person = new Person("홍길동", 30);
        System.out.println(person);
    }
}

위의 코드는 @ToString를 사용하여 Person 클래스에 toString() 메서드를 자동으로 생성하는 예시입니다.

Person 클래스는 이름(name)과 나이(age) 필드를 가지고 있습니다.
Person 객체를 생성하고 System.out.println(person)을 호출하면, Person(name=홍길동, age=30)과 같은 문자열이 출력됩니다.

이는 @ToString 주석으로 인해 자동으로 생성된 toString() 메서드가 객체의 필드와 값을 포함하는 문자열을 반환하기 때문입니다.

@ToString 주석을 사용함으로써 우리는 직접 toString() 메서드를 작성하지 않아도, 객체의 상태를 간편하게 확인할 수 있습니다.

어떤 상황에서 사용되는가?

일반적으로, @ToString 주석은 개발 과정에서 디버깅을 용이하게 만들기 위해 사용됩니다.
객체의 상태를 콘솔에 출력하거나, 로깅을 하거나, 디버깅 중에 특정 객체의 상태를 확인하고 싶을 때 유용합니다.

또한, 테스트 코드 작성 시에도 유용하게 사용될 수 있습니다.

부족한 점이나 잘못 된 점을 알려주시면 시정하겠습니다 :>

'DEV > Java' 카테고리의 다른 글

JPA  (0) 2023.07.11
DataJpaTest  (0) 2023.07.11
@Component  (0) 2023.07.10
SQL 조인에 대한 이해 - Outer Join과 Inner Join  (0) 2023.07.07
Meta 어노테이션  (0) 2023.07.07