[Spring] DTO ↔ Entity 변환하기

16번째 과제

[Spring] Entity, DTO, VO 의 개념과 특징

이전에 Entity와 DTO, VO의 개념과 특징을 알아보았다.

배달 API 구현 프로젝트를 진행하면서 우선적으로 Food Entity 를 구현하였고 이를 DTO로 변환하려고 한다.

그리고 Entity 와 DTO 는 분리하여 사용하는 것이 좋다고 한다. 왜 인지는 아래에서 확인해보자!

 

0. Entity를 DTO로 변환하는 이유

우선 Entity는 위 글에서 확인할 수 있듯이 데이터베이스 테이블과 매핑되는 객체이기 때문에 사용자에게 노출하면 원하지 않은 상황에서 자원의 속성이 변경될 가능성이 있고 보안상의 문제 또한 발생할 수 있다. 또한 엔티티에서 수정을 하면 전달받는 뷰에서도 수정을 해야하므로 결합도가 높아 유지보수에 용이하지 않다.

 

DTO는 계층간의 데이터 교환을 위해 사용하는 객체이다. DTO를 사용하면 필요한 데이터를 선택적으로 보낼 수 있다. 따라서 DTO에서 Entity의 필요한 데이터만 선택적으로 담아 사용하면 Entity 클래스를 보호할 수 있다. 이렇게 하면 앞서 Entity에서 발생했던 문제점을 해결할 수 있다.

 

결론적으로 DTO로 변환하는 이유는 Entity 보호와 코드 재사용성, 유지보수 용이 등의 장점 때문이라고 할 수 있다.

 

이제 다음으로 어떤 계층에서 변환할지 생각해보자.

Controller, Service, Repository 중에서 DTO <-> Entity 변환을 어디서 할 것인가?

 

1. Controller에서 받은 DTO를 전달하여 Service에서 Entity로 변환하기

구글링을 통해 알아본 결과, 상황에 따라 개인에 따라 다양한 방법으로 각 계층에서 구현하는 것을 알게 되었다. 더욱 헷갈리게 (?) 되었다. ㅋㅋㅋㅋ 따라서 나도 지금 진행하는 프로젝트에 맞는 방법을 선택해서 사용해보고 추후에 규모가 커지거나 문제점이나 불편함이 생기면 다른 방법으로 사용해보는 것도 좋을 것 같아서 일단 Controller에서 Service로 DTO를 전달하고 Service에서 Entity로 변환하는 방법을 선택하였다.

이 방법을 사용하면 Controller에서는 Entity를 알지 못하고 DTO만 알 수 있다. Controller에서 Service로 DTO를 전달하므로 두 계층의 결합도가 높아지는 단점이 생긴다.

2. DTO ↔ Entity 변환 방법

1) Model Mapper

- Mapper 클래스를 따로 생성하여 분리해주는 방법이다. Mapper에서는 DTO와 Entity를 변환해주는 작업을 해준다. 변환 작업을 Mapper에 위임하면서 Controller에서 벗어나 역할 분리가 된다.

 

2) Map Struct 

- 도메인 기능이 늘어나면 Mapper 도 많아지므로 성능이 저하된다는 단점이 있다. Map Struct는 이러한 단점을 보완하여 Mapper 구현 클래스를 자동 생성해주어 효율성을 높여준다.

 

3) 수동으로 직접 변환

- 3계층 중 한 계층에서 직접 코드를 작성하여 수동으로 변환하는 방법이다. 이번 프로젝트에서는 Controller와 Service를 통해 직접 변환하는 방법을 사용할 것이다.

3. @Builder 사용

@Builder를 사용하는 이유는

1. 필요한 데이터만 설정 가능하다
2. 유연성을 확보할 수 있다
3. 가독성을 높인다
4. 불변성을 확보할 수 있다

이러한 이유들이 있다. 또한 @Builder를 사용하고 @Setter를 사용하지 않는 이유가 존재한다.

@Setter를 사용하면 수정, 생성의 구별이 힘들어 코드의 가독성 문제가 생긴다. 그리고 수정에 개방적이므로 객체지향원리인 확장에 열려있고 수정에 닫혀있어야한다는 OCP(Open Closed Principle) 원리를 위반한다. 이 때문에 @Builder를 사용하여 개발해보았다.

 

 

1) Food Entity 와 FoodDTO 에 @Builder를 선언하고 FoodDTO에 builder를 사용하여 toDto, toEntity 메서드를 작성하였다.

package com.example.project.food;

import lombok.*;

@Getter
public class FoodDto {
    private int id;
    private String name;
    private int price;
    private String content;
    private String type;

    public FoodDto(){
    }

    @Builder
    public FoodDto(int id, String name, int price, String content, String type) {
        this.id = id;
        this.name = name;
        this.price = price;
        this.content = content;
        this.type = type;
    }

    public Food toEntity() {
        return Food.builder()
                .id(id)
                .name(name)
                .price(price)
                .content(content)
                .type(type)
                .build();
    }

    public FoodDto toDto(Food food) {
        return FoodDto.builder()
                .id(food.getId())
                .name(food.getName())
                .price(food.getPrice())
                .content(food.getContent())
                .type(food.getType())
                .build();
    }
}

 

2) Controller에서는 원래 Food로 전달했던 것을 FoodDto를 받아와 Service로 전달한다. DTO만 사용하므로 Controller에서는 Entity를 확인할 수 없다.

//음식 등록
@PostMapping("/foods")
public void insertFood(@Validated @RequestBody FoodDto foodDto) {
    foodService.insertFood(foodDto);
}

3) Service에서는 Controller에서 전달받은 DTO를 toEntity 메서드를 통해 Entity로 변환하였다. 

public void insertFood(FoodDto foodDto) {
        foodMapRepository.insertFood(foodDto.toEntity());
}

---

lombok 추가하기

lombok 추가함 : build.gradle에 dependencies에 코드 추가

compileOnly 'org.projectlombok:lombok'
annotationProcessor 'org.projectlombok:lombok'

참고

[Java] DAO, DTO, VO, Entity 란?

 

[JPA] entity < -- > DTO 변환 시 실무에는 어떻게 처리할까?

 

 

DTO는 대체 어디서 변환하는 것이 좋을까?

 

요청과 응답으로 엔티티(Entity) 대신 DTO를 사용하자

[Spirng/JPA] Dto와 Entity를 분리해서 사용하는 이유