도메인 모델(Entity) & API 모델

일반적으로 JPA 엔티티를 Controller에 직접 노출하는 것은 권장되지 않습니다. 그 이유는 다음과 같습니다.

1. 계층 간의 명확한 분리
   • 도메인 모델(Entity): 비즈니스 로직과 데이터베이스 매핑에 집중합니다.
   • API 모델(DTO): 클라이언트와의 데이터 교환에 최적화된 모델입니다.
     이를 분리하면 내부 데이터 구조(엔티티)가 변경되어도 API 계약에는 영향을 주지 않아 유지보수가 쉬워집니다.
2. 보안 및 데이터 노출 관리
   • 엔티티에는 내부 구현에 필요한 정보나 민감한 데이터가 포함될 수 있습니다.
   • DTO를 사용하면 클라이언트에 노출할 데이터를 명확하게 제한할 수 있습니다.
3. 직렬화 및 성능 이슈
   • 엔티티에 지연 로딩(lazy-loading) 관계가 있을 경우, JSON 직렬화 시 예상치 못한 데이터 로딩이나 순환 참조 문제 등이 발생할 수 있습니다.
   • DTO를 사용하면 필요한 데이터만 직렬화하여 성능 및 안정성을 개선할 수 있습니다.
4. API 스펙 관리
   • 엔티티 구조가 변경되면, 이를 직접 노출하고 있을 경우 API 스펙도 함께 변경될 위험이 있습니다.
   • DTO를 사용하면 내부 모델의 변경을 외부에 감추고 API 스펙을 안정적으로 관리할 수 있습니다.

결론

단순한 예제나 프로토타입에서는 엔티티를 직접 Controller에서 반환하는 것이 빠를 수 있으나,
실무 환경이나 장기적인 유지보수를 고려한다면 DTO를 활용하여 API와 도메인 모델을 분리하는 것이 바람직합니다.

---

예시: 엔티티 → DTO 변환 코드

아래는 간단한 예시 코드로, ToDo 엔티티를 클라이언트에 노출하기 전에 DTO로 변환하는 과정을 보여줍니다.

// 3. ToDoService에서 엔티티를 DTO로 변환하는 예시
package com.example.demo.service;

import com.example.demo.dto.ToDoResponse;
import com.example.demo.entity.ToDo;
import com.example.demo.repository.ToDoRepository;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;

@Service
public class ToDoService {

    private final ToDoRepository toDoRepository;

    public ToDoService(ToDoRepository toDoRepository) {
        this.toDoRepository = toDoRepository;
    }

    @Transactional(readOnly = true)
    public ToDoResponse getToDoById(Long id) {
        ToDo todo = toDoRepository.findById(id)
            .orElseThrow(() -> new IllegalArgumentException("해당 id를 가진 할 일이 존재하지 않습니다. id: " + id));
        
        // 엔티티를 DTO로 변환
        return new ToDoResponse(todo.getId(), todo.getTitle(), todo.getCompleted());
    }
}

// 4. ToDoController에서 DTO를 반환하는 예시
package com.example.demo.controller;

import com.example.demo.dto.ToDoResponse;
import com.example.demo.service.ToDoService;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;

@RestController
@RequestMapping("/api/todos")
public class ToDoController {

    private final ToDoService toDoService;

    public ToDoController(ToDoService toDoService) {
        this.toDoService = toDoService;
    }

    @GetMapping("/{id}")
    public ResponseEntity<ToDoResponse> getToDo(@PathVariable Long id) {
        ToDoResponse response = toDoService.getToDoById(id);
        return ResponseEntity.ok(response);
    }
}

이 예시에서는 ToDo 엔티티를 직접 노출하지 않고, ToDoResponse DTO로 변환하여 Controller에서 반환함으로써 위에서 언급한 여러 문제(보안, 유지보수, 직렬화 이슈 등)를 예방할 수 있습니다.