[번역] Data Transfer Object (DTO) in Spring Boot

💡 원본글 : https://towardsdev.com/data-transfer-object-dto-in-spring-boot-c00678cc5946

Data Transfer Object (DTO) in Spring Boot

이 글에서는 Spring Boot에서 데이터 전송 객체(DTO)의 이점을 탐구하며, 수동 DTO 생성, ModelMapper, Lombok을 포함한 예제들을 살펴볼 것입니다.

Photo by Joshua Sortino on Unsplash

1. 데이터 전송 객체(DTO)란 무엇인가?

데이터 전송 객체(DTO)는 애플리케이션의 다른 계층 간 데이터를 캡슐화하고 전송하기 위해 사용되는 디자인 패턴입니다. DTO는 일반적으로 필요한 필드만 포함하는 가벼운 객체로, 비지니스 로직은 포함하지 않습니다. 애플리케이션의 다른 부분들, 예를 들어 프론트엔드와 백엔드 사이나 분산 시스템 내의 다양한 마이크로서비스 간의 데이터를 운반하는 구조로 사용됩니다.

특히 Spring Boot 애플리케이션에서 DTO는 컨트롤러 계층, 서비스 계층, 그리고 영속성 계층 간 데이터를 전송해야 할 때 유용합니다. DTO를 사용함으로써 내부 데이터 모델과 외부 표현(presentation)을 분리할 수 있으며, 이는 데이터 전송에 대한 더 나은 통제를 가능하게 합니다.

2. Spring Boot 내에서 DTO를 사용의 이점

Spring Boot 애플리케이션에서 DTO를 사용하면 여러 가지 이점이 있습니다.

1. 데이터 격리: DTO를 사용하면 외부 세계에 노출되는 데이터를 내부 도메인 모델로부터 분리할 수 있습니다. 민감하거나 불필요한 데이터의 노출을 방지하고, 데이터 교환을 위한 명확한 규칙을 제공합니다.
2. 오버헤드 감소: DTO는 특정한 유스 케이스에 필요한 필드만 포함할 수 있어, 네트워크를 통해 전송되는 데이터 양을 줄일 수 있습니다. 이는 큰 객체를 전송 할때 발생하는 부담을 최소화 합니다.
3. 버전 관리 및 호환성: DTO는 버전 관리를 용이하게 하고, 역호환성을 보장 하는데 도움을 줍니다. 도메인 모델과 별개로 DTO를 발전시킬수 있어 API 변경을 더 쉽게 처리할 수 있습니다.
4. 보안 향상: DTO를 통해 노출되는 데이터를 제어함으로써 데이터 오츌을 방지하고 민감한 정보에 대한 접근을 제한하여 보안을 강화할 수 있습니다.
5. 테스트 향상: DTO는 단위 테스트를 단순화 합니다. 복잡한 도메인 객체에 의존하지 않고 테스트 시나리오에서 쉽게 생성하고 조작할 수 있습니다.

3. Spring Boot에서 DTO사용하는 다양한 방법

3.1. 수동으로 DTO를 생성

이 접근 방식에서는 도메인 엔티티의 구조를 반영해 DTO 클래스를 수동으로 생성합니다. 그런 다음 도메인 객체와 DTO 사이에 데이터를 매핑하기 위한 코드를 작성합니다.

public class UserDTO {
    private Long id;
    private String username;
    private String email;

// Constructors, getters, and setters

}

수동으로 매핑하는 과정이 있는 controller 메서드를 만들어 주면 됩니다.

@RestController
@RequestMapping("/api/users")
public class UserController {
    @Autowired
    private UserService userService;

    @GetMapping("/{id}")
    public ResponseEntity getUserById(@PathVariable Long id) {
        User user = userService.getUserById(id);

        UserDTO userDTO = new UserDTO();
        userDTO.setId(user.getId());
        userDTO.setUsername(user.getUsername());
        userDTO.setEmail(user.getEmail());

        return ResponseEntity.ok(userDTO);
    }
}

결과**:** GET 요청으로 /api/users/1을 요청하면 응답으로 유저 데이터를 포함한 ****JSON을 받을수 있습니다.

{
    "id": 1,
    "username": "john_doe",
    "email": "john.doe@example.com"
}

3.2. ModelMapper 사용

ModelMapper를 Spring Boot 프로젝트에서 도메인 객체와 DTO 간의 매핑을 자동화 하기 위해 사용하려면, pom.xml에서 해당 의존성을 추가합니다. 이렇게 하면 ModeMapping를 사용하여 도메인 객체와 DTO 간의 매핑을 쉽고 효율적으로 처리할 수 있습니다.

<dependency>
    <groupId>org.modelmapper</groupId>
    <artifactId>modelmapper</artifactId>
    <version>2.4.3</version>
</dependency>

Spring Boot 애플리케이션에서 ModelMapper를 Spring Bean으로 사용하기 위해, Configuration 클래스 또는 Main Application 클래스에 Bean을 등록할수 있습니다. 이를 통해 애플리케이션 전체에서 ModelMapper의 구성(Configuration)을 할수 있습니다.

Spring Boot 애플리케이션에서 ModelMapper Bean을 생성하는 방법은 다음과 같습니다.

import org.modelmapper.ModelMapper;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class MyApplicationConfig {

    @Bean
    public ModelMapper modelMapper() {
        return new ModelMapper();
    }
}

여기서 도메인 객체를 DTO로 변환하기 위해 ModelMapper를 아래와 같이 사용하면 됩니다.

@RestController
@RequestMapping("/api/users")
public class UserController {
    @Autowired
    private UserService userService;

    @Autowired
    private ModelMapper modelMapper; // Autowire the ModelMapper bean

    @GetMapping("/{id}")
    public ResponseEntity getUserById(@PathVariable Long id) {
        User user = userService.getUserById(id);

        UserDTO userDTO = modelMapper.map(user, UserDTO.class); // Use ModelMapper for mapping

        return ResponseEntity.ok(userDTO);
    }
}

결과: 수동 DTO 생성 예제와 동일한 결과가 나옵니다.

3.3. Lombok 사용

Lombok 의존성을 pom.xml 파일에 추가하세요.

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.22</version>
    <scope>provided</scope>
</dependency>

User 엔티티에 DTO를 생성하기 위해 아래와 같이 작성하세요.

import lombok.Data;

@Data
public class UserDTO {
    private Long id;
    private String username;
    private String email;
}

이제 도메인 객체를 DTO로 변환허기 위해 아래와 같이 Lombok을 사용하면 됩니다.

@RestController
@RequestMapping("/api/users")
public class UserController {
    @Autowired
    private UserService userService;

    @GetMapping("/{id}")
    public ResponseEntity getUserById(@PathVariable Long id) {
        User user = userService.getUserById(id);

        UserDTO userDTO = UserDTO.builder()
                .id(user.getId())
                .username(user.getUsername())
                .email(user.getEmail())
                .build();

        return ResponseEntity.ok(userDTO);
    }
}

결과: 수동 DTO 생성 예제와 동일한 결과가 나옵니다.

4. DTO에서 다양한 유형의 값 포맷팅 하기

DTO에서 다양한 유형의 값을 포맷팅하는 것은 데이터가 직렬화되거나 표시될 때 특정 형식으로 제공되도록 하는 데 필요한 일반적인 요구사항입니다. 포맷팅하려는 값의 유형에 따라, 어노테이션, 사용자 정의 메서드 또는 외부 라이브러리를 포함한 여러 접근 방식을 사용할 수 있습니다. 아래에서는 DTO에서 다양한 유형의 값을 포맷팅하는 방법에 대해 설명하겠습니다.

4.1. Date와 Time 포맷

4.1.1. @JsonFormat 어노테이션 사용(Jackson)

DTO에서 날짜와 시간 값을 포맷팅 하기 위해, JSON 직렬화에 흔히 사용되는 Jackson 라이브러리에서 제공하는 @JsonFormat 어노테이션을 사용할 수 있습니다.

import com.fasterxml.jackson.annotation.JsonFormat;

public class UserDTO {
    private Long id;

    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "UTC")
    private Date registrationDate;

    // Other fields, getters, and setters
}

이 예제에선 registrationDate 필드를 @JsonFormat을 사용해서 날짜와 시간에 대해서 특별하게 변환하였습니다.

4.1.2. SimpleDateFormat 사용(Custom Method)

DTO 클래스 내에 사용자 정의 gatter 메서드를 제공함으로써 날짜와 시간을 포맷팅할 수도 있습니다. 이 메소드는 포맷된 날짜를 문자열로 반환합니다.

import java.text.SimpleDateFormat;

public class UserDTO {
    private Long id;
    private Date registrationDate;

    public String getFormattedRegistrationDate() {
        SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
        return sdf.format(registrationDate);
    }

    // Other fields, getters, and setters
}

4.2. 숫자 포맷팅

4.2.1. @NumberFormat 어노테이션 사용 (Spring)

숫자나 통화와 같은 숫자 값을 포맷팅하기 위해 Spring에서 제공하는 @NumberFormat 어노테이션을 사용할 수 있습니다. 이 어노테이션을 사용하면 숫자 포맷팅 패턴을 지정할 수 있습니다.

import org.springframework.format.annotation.NumberFormat;

public class ProductDTO {
    private Long id;

    @NumberFormat(pattern = "#,###.00")
    private BigDecimal price;

    // Other fields, getters, and setters
}

이 예제에서는 price 필드에 @NumberFormat 어노테이션을 사용해서 숫자를 포맷팅하는 패턴을 지정하였습니다.

4.2.2. DecimalFormat 사용 (Custom Method)

DTO 클래스 내에 사용자 정의 getter 메소드를 제공하여 숫자를 포맷팅할수도 있습니다. 이 메소드는 DecimalFormat을 사용하여 포맷된 숫자를 문자열로 반환합니다.

import java.text.DecimalFormat;

public class ProductDTO {
    private Long id;
    private BigDecimal price;

    public String getFormattedPrice() {
        DecimalFormat df = new DecimalFormat("#,###.00");
        return df.format(price);
    }

    // Other fields, getters, and setters
}

4.3. String 포맷팅

4.3.1. Custom Methods 사용

문자열 값을 포맷팅하기 위해, 필요에 따라 문자열을 조작하는 사용자 정의 getter 메서드를 DTO 클래스 내에 생성할 수 있습니다. 예를 들어, 공백을 자르거나, 단어를 대문자로 만들거나, 기타 다른 문자열 조작 로직을 적용할 수 있습니다.

public class ArticleDTO {
    private Long id;
    private String title;

    public String getFormattedTitle() {
        // Custom formatting logic here
        return title.trim(); // Example: Trim whitespace
    }

    // Other fields, getters, and setters
}

4.4. Enum 포맷팅

4.4.1. Custom Method 사용

DTO에서 열거형(enum)을 다룰 때, 열거형 값의 포맷된 표현을 반환하는 사용자 정의 getter 메서드를 생성할 수 있습니다. 예를 들어, 열거형 값을 대문자로 변환하거나 다른 표현을 사용할 수 있습니다.

public class OrderDTO {
    private Long id;
    private OrderStatus status;

    public String getFormattedStatus() {
        return status.toString().toUpperCase(); // Example: Convert to uppercase
    }

    // Other fields, getters, and setters
}

4.5. Boolean 포맷팅

4.5.1. Custom Methods 사용

Boolean 값에 대해서는 “true” 또는 “false대신에 “Yes”, “No”와 같은 포맷된 표현을 사용자 정의 getter 메소드로 생성할 수 있습니다.

public class UserDTO {
    private Long id;
    private boolean isActive;

    public String getFormattedIsActive() {
        return isActive ? "Yes" : "No"; // Example: Convert to "Yes" or "No"
    }

    // Other fields, getters, and setters
}

이러한 접근 방법들을 사용함으로써, 특정 요구사항에 따라 DTO 내에서 다양한 유형의 값을 포맷팅할 수 있으며, DTO가 직렬화되거나 표시될 때 데이터가 원하는 형식으로 제공되도록 할 수 있습니다.

5. 추가적으로 고려해야 할 점과 Best Practice

5.1. DTO에서의 유효성 검사

DTO를 다룰 때 데이터 검증을 고려하는 것이 필수적입니다. DTO에 들어오는 데이터가 필요한 제약 조건과 비즈니스 규칙을 충족하는지 확인하기 위해 데이터를 검증해야 합니다. Spring의 @NotNull, @Size 또는 사용자 정의 검증 어노테이션을 사용하여 DTO 필드를 검증할 수 있습니다.

Spring의 @NotBlank 어노테이션을 사용한 DTO 검증의 예는 다음과 같습니다:

public class UserDTO {
    @NotNull
    private Long id;

    @NotBlank
    @Size(min = 5, max = 50)
    private String username;

    @Email
    private String email;

    // Constructors, getters, and setters
}

5.2. 복잡한 중첩 객체 DTO

실제 애플리케이션에서는 중첩된 객체나 관계를 다룰 때 DTO가 더 복잡해질 수 있습니다. 이러한 구조를 정확하게 나타내기 위해 중첩된 DTO를 생성할 필요가 있습니다.

예를 들어, User가 여러 Address 객체와 연관되어 있다면, 중첩된 AddressDTO를 포함하는 UserDTO를 생성할 수 있습니다:

public class UserDTO {
    private Long id;
    private String username;
    private String email;
    private List addresses;

    // Constructors, getters, and setters
}

5.3. DTO 버전 관리

애플리케이션이 발전함에 따라 DTO에 변경을 해야 할 수도 있습니다. 역호환성을 유지하기 위해 DTO의 버전 관리를 고려해보세요. 이는 DTO 클래스에 버전 식별자를 추가하거나 필요할 때 새로운 DTO 버전을 생성함으로써 달성할 수 있습니다.

5.4. RESTful API에서의 DTO

DTO는 클라이언트와 서버 간에 교환되는 데이터를 나타내기 위해 RESTful API에서 일반적으로 사용됩니다. RESTful 엔드포인트를 설계할 때, 특정 사용 사례와 클라이언트 요구사항에 맞게 DTO를 신중하게 선택하고 구조화해야 합니다. 이는 효율적인 데이터 전송과 명확한 API 계약을 보장합니다.

6. Spring Validation과 DTO 사용

Spring은 컨트롤러 메소드에서 @Valid 어노테이션을 사용하여 DTO를 검증하는 강력한 메커니즘을 제공합니다. DTO 파라미터에 **@Valid**를 어노테이션으로 달면, Spring은 DTO 클래스에 정의된 검증 제약 조건을 기반으로 자동으로 검증을 트리거합니다.

컨트롤러 메소드에서 DTO 검증을 사용하는 예시는 다음과 같습니다:

@RestController
@RequestMapping("/api/users")
public class UserController {
    @Autowired
    private UserService userService;

    @PostMapping("/create")
    public ResponseEntity createUser(@Valid @RequestBody UserDTO userDTO) {
        // Your validation logic is automatically triggered

        // Map UserDTO to User entity and save it
        User user = modelMapper.map(userDTO, User.class);
        User savedUser = userService.saveUser(user);

        // Return the saved UserDTO
        UserDTO savedUserDTO = modelMapper.map(savedUser, UserDTO.class);
        return ResponseEntity.status(HttpStatus.CREATED).body(savedUserDTO);
    }
}

이 예제에서는 @Valid 어노테이션을 사용하여 UserDTO 클래스에서 정의한 제약 조건을 기반으로 검증을 트리거합니다. 검증이 실패하면 Spring은 자동으로 검증에 대한 오류를 처리하고 적절한 오류 메시지를 포함한 응답을 반환합니다.

7. 마이크로서비스 아키텍처에서의 DTO

마이크로서비스 아키텍처에서는 DTO가 마이크로서비스 간의 경계를 정의하는 중요한 역할을 합니다. 각 마이크로서비스는 자체적으로 특정 요구 사항에 맞는 DTO 세트를 가질 수 있습니다. 이 분리는 마이크로서비스 간의 느슨한 결합을 보장하고 독립적으로 진화할 수 있도록 합니다.

DTO는 또한 마이크로서비스 간에 전송되는 데이터 양을 줄이는 데 도움이 되며, 이는 마이크로서비스 기반 시스템의 성능과 확장성을 유지하는 데 중요합니다.

8. 결론

데이터 전송 객체 (DTO)는 Spring Boot 애플리케이션에서 필수적이며, 애플리케이션의 다른 레이어와 외부 시스템 사이의 다리 역할을 합니다. DTO를 신중하게 설계하고 사용함으로써 데이터 격리를 개선하고 오버헤드를 줄이며 보안을 강화하고 테스트를 단순화할 수 있습니다. DTO를 수동으로 작성하거나 ModelMapper와 같은 라이브러리를 사용하거나 코드 간소화를 위해 Lombok을 활용하든, 핵심은 프로젝트의 요구 사항과 유지 보수성에 가장 적합한 접근 방식을 선택하는 것입니다. DTO가 아키텍처의 중요한 부분으로 존재하면, 견고하고 효율적인 Spring Boot 애플리케이션을 구축하는 데 더 잘 갖추어집니다.

 

추가적으로 읽어볼만한 글:

Rest API in Spring Boot

Multiple application properties in spring boot