Spring 기본 - DTO (Data Transfer Object) 패턴

https://wooncloud.tistory.com/161

Spring 기본 시작 - 세팅부터 CRUD API 까지

https://wooncloud.tistory.com/162

Spring 기본 - Service 계층

DTO (Data Transfer Object) 패턴

 

왜 DTO가 필요할까?

• 보안: Entity의 모든 필드를 노출하지 않음
• 성능: 필요한 데이터만 전송
• 유연성: API 응답 형식을 자유롭게 조정
• 분리: Entity 변경이 API에 영향주지 않음

1. DTO 패키지와 클래스 생성

src/main/java/com/example/demo_api에 dto 패키지를 생성

 

2-1. UserDto.java 클래스 생성

package com.example.demo_api.dto;

public class UserDto {
    private Long id;
    private String name;
    private String email;
    
    // 기본 생성자
    public UserDto() {}
    
    // 모든 필드 생성자
    public UserDto(Long id, String name, String email) {
        this.id = id;
        this.name = name;
        this.email = email;
    }
    
    // getter, setter
    public Long getId() { return id; }
    public void setId(Long id) { this.id = id; }
    
    public String getName() { return name; }
    public void setName(String name) { this.name = name; }
    
    public String getEmail() { return email; }
    public void setEmail(String email) { this.email = email; }
}

 

2-2. 요청용 DTO도 생성 - CreateUserRequest.java

package com.example.demo_api.dto;

public class CreateUserRequest {
    private String name;
    private String email;
    
    // 생성자, getter, setter 동일하게 작성
}

3. DTO 변환 유틸리티 메소드 추가

UserService에 변환 메소드들을 추가.

// UserService.java에 추가
// Entity -> DTO 변환
private UserDto convertToDto(User user) {
    return new UserDto(user.getId(), user.getName(), user.getEmail());
}

// DTO -> Entity 변환  
private User convertToEntity(UserCreateDto userCreateDto) {
    return new User(userCreateDto.getName(), userCreateDto.getEmail());
}

// List<Entity> -> List<DTO> 변환
private List<UserDto> convertToDtoList(List<User> users) {
    return users.stream()
            .map(this::convertToDto)
            .collect(Collectors.toList());
}

그런데 이렇게 Entity를 DTO로 바꾸는게 너무 귀찮다.

이런 귀찮음을 모든 개발자들이 알고 있고, 그래서 이 귀찮음을 해결하기 위한 방법들이 있다.

• ModelMapper
• MapStruct

3-1. ModelMapper 사용

// build.gradle에 추가
implementation 'org.modelmapper:modelmapper:3.1.1'

@Service
public class UserService {
    
    @Autowired
    private ModelMapper modelMapper;
    
    // 변환이 이렇게 간단해짐!
    public UserDto createUser(UserCreateDto userCreateDto) {
        User user = modelMapper.map(userCreateDto, User.class);
        User savedUser = userRepository.save(user);
        return modelMapper.map(savedUser, UserDto.class);
    }
    
    public List<UserDto> getAllUsers() {
        return userRepository.findAll().stream()
                .map(user -> modelMapper.map(user, UserDto.class))
                .collect(Collectors.toList());
    }
}

 

3-2. MapStruct

(컴파일 시점에 생성, 성능 좋음)

@Mapper(componentModel = "spring")
public interface UserMapper {
    UserDto toDto(User user);
    User toEntity(UserCreateDto dto);
    List<UserDto> toDtoList(List<User> users);
}

 

3-3. 생성자 기반 변환

(간단하지만, Entity와 DTO에 들어있는 데이터가 많아지면 많아지고 복잡해짐.)

// DTO에 생성자 추가
public UserDto(User user) {
    this.id = user.getId();
    this.name = user.getName();
    this.email = user.getEmail();
}

 

저는 ModelMapper 라이브러리를 사용했습니다.

 

4. Controller를 DTO 사용으로 수정

UserController를 다음과 같이 수정한다.

@RestController
@RequestMapping("/api/users")
public class UserController {
    
    @Autowired
    private UserService userService;
    
    @GetMapping
    public List<UserDto> getAllUsers() {  // UserDto 반환
        return userService.getAllUsers();
    }
    
    @PostMapping
    public UserDto createUser(@RequestBody UserCreateDto userCreateDto) {  // DTO 사용
        return userService.createUser(userCreateDto);
    }
    
    @GetMapping("/{id}")
    public UserDto getUserById(@PathVariable Long id) {  // UserDto 반환
        return userService.getUserById(id);
    }
    
    @PutMapping("/{id}")
    public UserDto updateUser(@PathVariable Long id, @RequestBody UserCreateDto userCreateDto) {
        return userService.updateUser(id, userCreateDto);
    }
    
    @DeleteMapping("/{id}")
    public String deleteUser(@PathVariable Long id) {
        // 삭제는 그대로
        boolean deleted = userService.deleteUser(id);
        return deleted ? "사용자가 삭제되었습니다." : "사용자를 찾을 수 없습니다.";
    }
}