Java Record로 DTO를 만들어봅시다

😼 DTO(: Data Transfer Object)

public class AccountResponseDto {
    private final Long id;
    private final String username;
    private final String nickname;
}

DTO는 계층간에 데이터를 전달하기 위해 사용되는 클래스이다. 따라서 DTO의 데이터는 변하면 안된다는 특징을 갖고 있다.

따라서 보통의 DTO 클래스 필드는 final 속성을 갖거나 setter를 선언하지 않는다. 또한 DTO 클래스는 별도의 메서드를 포함하고 있지 않고 단순히 데이터만을 포함하고 있다.

 

😼 레코드(record)란?

public record AccountResponseDto(
    Long id,
    String username,
    String nickname
) { }

Record는 데이터만을 포함하는 불변(immutable)한 객체를 간단하게 정의할 수 있게 도와주는 Java 14부터 도입된 데이터 클래스이다.

기존 Java에서 DTO를 정의하기 위해서는 생성자, getter, equals(), hashcode(), toString() 등 다양한 보일러 플레이트(자동 생성 코드)가 필요했으나, Record는 이런 불편함을 해소하고 간결한 문법으로 데이터를 표현할 수 있도록 도와준다.

 

🫧 레코드 특징

1. 불변성

Record는 모든 필드를 final로 선언해 한번 생성되면 그 값을 변경할 수 없다.

아래와 같이 필드에 따로 final을 선언하지 않아도 필드 값 변경시 컴파일 오류가 나는 것을 확인할 수 있다.

 

2. getter 기본 제공

기본적으로 getter를 제공하며, getX()가 아닌 x()로 네이밍 처리된다.

// 레코드
public record SignupRequestDto(String username, String password, String nickname) { }

// 메인함수
public class Main {
	public static void main(String[] args) {
    	SignupRequestDto request = new SignupRequestDto("username@gmail.com", "password1!", "nickname");
        String username = request.username();
    }
}

 

2. 표준 메서드 자동 제공

equals, hashcode, toString 메서드가 자동으로 제공되며, 서로 다른 record가 필드 값이 같으면 같은 객체로 인식한다.

단, == 기호는 적용되지 않는다.

public void test() {
    SignupRequestDto requestDto1 = new SignupRequestDto("username@gmail.com", "password1!", "nickname");
    SignupRequestDto requestDto2 = new SignupRequestDto("username@gmail.com", "password1!", "nickname");

    System.out.println(requestDto1 == requestDto2); // false
    System.out.println(requestDto1.equals(requestDto2)); // true
    System.out.println(requestDto1.hashCode() == requestDto2.hashCode()); // true
}

 

3. annotation 사용 가능

Record도 Bean Validation을 적용시킬 수 있다.

public record SignupRequestDto(
    @NotNull @Email String username,
    @NotNull @Pattern(regexp = PASSWORD_REGEXP) String password,
    @NotNull @Pattern(regexp = NICKNAME_REGEXP) String nickname
) { }

 

4. Compact Construct

생성자에 조건식을 쉽게 작성할 수 있는 문법을 제공한다.

public record SignupRequestDto(String username, String password, String nickname) {
	public SignupRequestDto {
    	Objects.requireNonNull(username);
        Objects.requireNonNull(password);
        Objects.requireNonNull(nickname);
    }
}

 

3. 상속 불가능

Record는 다른 클래스를 상속받을 수 없으며, 상속되도록 할 수 없다.

 

4. Lombok 사용 가능

Record에 Lombok 적용이 가능하다.

하지만 @Builder를 제외한 나머지 어노테이션은 대부분 Record에서 기본적으로 제공되기 때문에 사용될 일이 잘 없다.

(@Setter같이 필드에 영향을 끼치는 어노테이션 사용은 지양)

// 레코드
@Builder
public record LoginRequestDto(String username, String password) {}

// 테스트 코드
public class Test {
    public void test() {
        LoginRequestDto dto = LoginRequestDto.builder()
            .username("username@gmail.com")
            .password("password1!")
            .build();
    }
}

 

🫧 DTO를 레코드 타입으로 사용한 이유

1. 간결성

DTO 같은 데이터 전용 클래스를 정의할 때 필요한 보일러 플레이트 코드를 줄일 수 있다.

 

2.  명확한 의도

Record를 사용함으로써 해당 클래스가 데이터 전용임을 명확히 나타낼 수 있다.

 

3. 불변성

Record는 데이터의 불변성을 보장해 버그 발생을 최소화하고 코드의 안정성을 향상시킨다.

 

🆚 Class vs Record 코드  비교

기존: class로 Reponse DTO 생성

record와 명확한 비교를 위해 어노테이션 사용 X

public class AccountResponseDto {
    private final Long id;
    private final String username;
    private final String nickname;

    @Builder
    public AccountResponseDto(Long id, String username, String nickname) {
        this.id = id;
        this.username = username;
        this.nickname = nickname;
    }
    
    public static AccountResponseDto from(Account account) {
        return AccountResponseDto.builder()
            .id(account.getId())
            .username(account.getUsername())
            .nickname(account.getNickname())
            .build();
    }
    
    public Long getId() {
        return id;
    }
    
    public String getUsername() {
        return username;
    }
    
    public String getNickname() {
		return nickname;
    }
    
    @Override
    public boolean equals(Object o) {
        // ...
    }

    @Override
    public int hashCode() {
        // ...
    }

    @Override
    public String toString() {
        // ...
    }
}

 

 

수정: record로 Reponse DTO 생성

어노테이션 없이 getter, equals(), hashCode(), toString() 메서드가 자동 생성된다.

public record AccountResponseDto(
    Long id,
    String username,
    String nickname
) {

    public static AccountResponseDto from(Account account) {
        return new AccountResponseDto(account.getId(), account.getUsername(),
            account.getNickname());
    }
}

---

기존: class로 Request DTO 생성

public class SignupRequestDto {

    @NotNull(message = "이메일은 필수 입력 항목입니다.")
    @Email(message = "유효하지 않은 이메일 형식입니다.")
    private String username;

    @NotNull(message = "비밀번호는 필수 입력 항목입니다.")
    @Pattern(regexp = PASSWORD_REGEXP, message = "비밀번호는 영문, 숫자, 특수문자 포함 10자 이상 25자 이하여야 합니다.")
    private String password;

    @NotNull(message = "닉네임은 필수 입력 항목입니다.")
    @Pattern(regexp = NICKNAME_REGEXP, message = "닉네임은 2자 이상 10자 이하여야 합니다.")
    private String nickname;
    
    public SignupRequestDto() {}

    @Builder
    public SignupRequestDto(String username, String password, String nickname) {
        this.username = username;
        this.password = password;
        this.nickname = nickname;
    }

    public Account toEntity(PasswordEncoder passwordEncoder) {
        return Account.builder()
            .username(username)
            .password(passwordEncoder.encode(password))
            .nickname(nickname)
            .build();
    }
    
    public String getUsername() {
        return username;
    }
    
    public String getPassword() {
		return password;
    }
    
    public String getNickname() {
		return nickname;
    }
    
    @Override
    public boolean equals(Object o) {
        // ...
    }

    @Override
    public int hashCode() {
        // ...
    }

    @Override
    public String toString() {
        // ...
    }
}

 

수정: record로 Request DTO 생성

public record SignupRequestDto(
    @NotNull @Email String username,
    @NotNull @Pattern(regexp = PASSWORD_REGEXP) String password,
    @NotNull @Pattern(regexp = NICKNAME_REGEXP) String nickname
) {

    public Account toEntity(PasswordEncoder passwordEncoder) {
        return Account.builder()
            .username(username)
            .password(passwordEncoder.encode(password))
            .nickname(nickname)
            .build();
    }
}

 

😼 정리

DTO는 서로 다른 계층간의 데이터 교환을 위해 사용되며, 단순히 전달할 데이터값만을 포함하는 것이 좋다. DTO에는 특정한 로직이 포함된 메서드를 갖지 않는 것이 좋으며, 데이터가 도중에 변하지 않도록 설정해줄 필요가 있다.

 

Recod는 일반 클래스처럼 사용할 수 있지만, 필드에 final을 자동으로 추가해주고 getter와 equals, hashCode, toString 메서드를 기본적으로 지원해주기 때문에 개발자에게 편리한 개발 환경을 제공해준다.

따라서 온전히 데이터 불변성을 지키는 DTO를 Record로 구현하게 되면, DTO가 가져야 할 특징들을 간편하게 구현할 수 있다.

 

 

 

JEP 395: Records

[TIL] DTO class를 record로 사용해야 하는 이유

'Record'로 DTO만들기

왜 Response DTO를 Java의 Record 타입으로 사용했는가? | Street Drop

자바의 Record로 DTO를 만들어보자 - 2